gbranden pushed a commit to branch master
in repository groff.
commit df539e7c79d2c2c27fdcc95f205987b9b86de1f9
Author: G. Branden Robinson <[email protected]>
AuthorDate: Sat Nov 12 06:57:50 2022 -0600
[grops]: Tweak usage message and man page.
* src/devices/grops/ps.cpp (usage): Employ more informative
metasyntactic variable names in usage message. Also summarize
program's function and direct reader to man page if help explicitly
requested (inferred from identity of output stream).
Also align man page synopsis with usage message. Use shorter
metasyntactic variables where convenient in "Options" section since
much more context is there.
---
ChangeLog | 7 +++++++
src/devices/grops/grops.1.man | 18 +++++++++---------
src/devices/grops/ps.cpp | 11 +++++++++--
3 files changed, 25 insertions(+), 11 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index e65453993..a68b3176a 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2022-11-12 G. Branden Robinson <[email protected]>
+
+ * src/devices/grops/ps.cpp (usage): Employ more informative
+ metasyntactic variable names in usage message. Also summarize
+ program's function and direct reader to man page if help
+ explicitly requested (inferred from identity of output stream).
+
2022-11-11 G. Branden Robinson <[email protected]>
* tmac/an.tmac: Trivially refactor for congruence with
diff --git a/src/devices/grops/grops.1.man b/src/devices/grops/grops.1.man
index d0ce632cb..8e8e53acd 100644
--- a/src/devices/grops/grops.1.man
+++ b/src/devices/grops/grops.1.man
@@ -48,19 +48,19 @@ output driver for PostScript
.SY grops
.RB [ \-glm ]
.RB [ \-b\~\c
-.IR n ]
+.IR brokenness-flags ]
.RB [ \-c\~\c
-.IR n ]
+.IR num-copies ]
.RB [ \-F\~\c
-.IR dir ]
+.IR font-directory ]
.RB [ \-I\~\c
-.IR dir ]
+.IR inclusion-directory ]
.RB [ \-p\~\c
.IR paper-format ]
.RB [ \-P\~\c
.IR prologue-file ]
.RB [ \-w\~\c
-.IR n ]
+.IR rule-thickness ]
.RI [ file\~ .\|.\|.]
.YS
.
@@ -314,7 +314,7 @@ Turn on manual feed for the document.
.
.
.TP
-.BI \-p\~ paper-format
+.BI \-p\~ fmt
Set physical dimensions of output medium,
overriding the
.BR \%papersize ,
@@ -325,7 +325,7 @@ directives in the
.I DESC
file.
.
-.I paper-format
+.I fmt
can be any argument accepted by the
.B \%papersize
directive;
@@ -334,9 +334,9 @@ see
.
.
.TP
-.BI \-P\~ prologue-file
+.BI \-P\~ prologue
Use the file
-.IR prologue-file ,
+.IR prologue ,
sought in the
.I groff
font search path,
diff --git a/src/devices/grops/ps.cpp b/src/devices/grops/ps.cpp
index fbb7b50cd..807945f97 100644
--- a/src/devices/grops/ps.cpp
+++ b/src/devices/grops/ps.cpp
@@ -1873,11 +1873,18 @@ int main(int argc, char **argv)
static void usage(FILE *stream)
{
fprintf(stream,
-"usage: %s [-glm] [-b n] [-c n] [-F dir] [-I dir] [-p paper-format]"
-" [-P prologue-file] [-w n] [file ...]\n"
+"usage: %s [-glm] [-b brokenness-flags] [-c num-copies]"
+" [-F font-directory] [-I inclusion-directory] [-p paper-format]"
+" [-P prologue-file] [-w rule-thickness] [file ...]\n"
"usage: %s {-v | --version}\n"
"usage: %s --help\n",
program_name, program_name, program_name);
+ if (stdout == stream)
+ fputs(
+"\n"
+"Translate the output of troff(1) into PostScript. See the grops(1)\n"
+"manual page.\n",
+ stream);
}
// Local Variables:
_______________________________________________
Groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
