gbranden pushed a commit to branch master
in repository groff.
commit 565580352be61dba4f0e682b4c2a72e07f5acce6
Author: G. Branden Robinson <[email protected]>
AuthorDate: Thu Jul 24 21:29:50 2025 -0500
gropdf(1): Revise new "Exit status" section.
Fix content, style, and markup nits.
Content:
* Document that usage errors produce exit status 1.
Style:
* Spell section heading in sentence case.
* Break input lines at sentence endings, enabling reliable
end-of-sentence detection.
* Recast.
Markup:
* Drop poor man's keep prior to section heading. I use these only to
make nice page breaks (widow/orphan management) in
"groff-man-pages.pdf".
* Quote multi-word argument to the `SH` request. (Admittedly, that's a
bit of a micro-optimiziation.)
* Use two empty requests where vertical space is expected.
---
src/devices/gropdf/gropdf.1.man | 21 ++++++++++++++-------
1 file changed, 14 insertions(+), 7 deletions(-)
diff --git a/src/devices/gropdf/gropdf.1.man b/src/devices/gropdf/gropdf.1.man
index 7c4ad947b..a5087e20a 100644
--- a/src/devices/gropdf/gropdf.1.man
+++ b/src/devices/gropdf/gropdf.1.man
@@ -1875,19 +1875,26 @@ see hello.pdf
.RE
.
.
-.br
-.ne 5v
.\" ====================================================================
-.SH Exit Status
+.SH "Exit status"
.\" ====================================================================
.
-The exit code reflects the result of the run.
.IP 0
-Success. The operation completed successfully.
+.I gropdf
+successfully produced a PDF document.
.IP 1
-Critical error. PDF produced will be unusable.
+.I gropdf
+experienced a critical error,
+or could not interpret its arguments.
+No PDF was produced,
+or the document produced will be unusable.
.IP 2
-Warnings were issued. PDF produced may be usable, but it will have issues.
+.I gropdf
+emitted warnings.
+The document produced may be usable,
+but may fail to render as desired.
+.
+.
.br
.ne 5v
.\" ====================================================================
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
