gbranden pushed a commit to branch master
in repository groff.
commit 02c9d6929fa8a2644ba25ee7abcb94ab13d4287b
Author: G. Branden Robinson <[email protected]>
AuthorDate: Mon Sep 25 08:18:41 2023 -0500
[eqn]: Make synopsis, usage message more helpful.
* src/preproc/eqn/eqn.1.man (Synopsis): Use descriptive phrases as
metasyntactic variables.
* src/preproc/eqn/main.cpp (usage): Sync with the foregoing.
Also (in man page), coalesce a single-sentence paragraph in its
predecessor to preserve good pagination in PDF on U.S. letter paper.
---
ChangeLog | 8 ++++++++
src/preproc/eqn/eqn.1.man | 30 ++++++++++++++----------------
src/preproc/eqn/main.cpp | 6 ++++--
3 files changed, 26 insertions(+), 18 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 822d1c184..e1dffac62 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2023-09-25 G. Branden Robinson <[email protected]>
+
+ [eqn]: Make synopsis, usage message more helpful.
+
+ * src/preproc/eqn/eqn.1.man (Synopsis): Use descriptive phrases
+ as metasyntactic variables.
+ * src/preproc/eqn/main.cpp (usage): Sync with the foregoing.
+
2023-09-25 G. Branden Robinson <[email protected]>
* src/preproc/pic/troff.cpp (strsame): Add utility function for
diff --git a/src/preproc/eqn/eqn.1.man b/src/preproc/eqn/eqn.1.man
index f6f0fbb2a..68e127420 100644
--- a/src/preproc/eqn/eqn.1.man
+++ b/src/preproc/eqn/eqn.1.man
@@ -60,20 +60,20 @@ or MathML
.
.SY @g@eqn
.RB [ \-CNrR ]
-.RB [ \- d
+.RB [ \- d\~\c
.IR xy ]
-.RB [ \-f
-.IR F ]
-.RB [ \-m
-.IR n ]
-.RB [ \-M
-.IR dir ]
-.RB [ \-p
-.IR n ]
-.RB [ \-s
-.IR n ]
-.RB [ \-T
-.IR dev ]
+.RB [ \-f\~\c
+.IR global-italic-font ]
+.RB [ \-m\~\c
+.IR minimum-type-size ]
+.RB [ \-M\~\c
+.IR eqnrc-directory ]
+.RB [ \-p\~\c
+.IR super/subscript-size-reduction ]
+.RB [ \-s\~\c
+.IR global-type-size ]
+.RB [ \-T\~\c
+.IR device ]
.RI [ file\~ .\|.\|.]
.YS
.
@@ -192,9 +192,7 @@ There are some references to the differences between \*[tx]
and GNU
below;
these may safely be ignored if you do not know \*[tx].
.
-.
-.P
-Four points are worth special note.
+Four points are worth note.
.
.
.IP \[bu] 3n
diff --git a/src/preproc/eqn/main.cpp b/src/preproc/eqn/main.cpp
index b625dd609..a14ac3632 100644
--- a/src/preproc/eqn/main.cpp
+++ b/src/preproc/eqn/main.cpp
@@ -309,8 +309,10 @@ static char *delim_search(char *ptr, int delim)
void usage(FILE *stream)
{
fprintf(stream,
- "usage: %s [-CNrR] [-d xy] [-f font] [-m n] [-M dir] [-p n] [-s n]"
- " [-T name] [file ...]\n"
+ "usage: %s [-CNrR] [-d xy] [-f global-italic-font]"
+ " [-m minimum-type-size] [-M eqnrc-directory]"
+ " [-p super/subscript-size-reduction] [-s global-type-size]"
+ " [-T device] [file ...]\n"
"usage: %s {-v | --version}\n"
"usage: %s --help\n",
program_name, program_name, program_name);
_______________________________________________
Groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
