groff-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[groff] 01/83: [man pages]: Revise some syntax synopses.


From: G. Branden Robinson
Subject: [groff] 01/83: [man pages]: Revise some syntax synopses.
Date: Sat, 6 May 2023 23:24:12 -0400 (EDT)

gbranden pushed a commit to branch branden-2023-05-06
in repository groff.

commit 4cacb755346c2a4159a42e987b26ff8b20dfae7c
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sat May 6 20:07:48 2023 -0500

    [man pages]: Revise some syntax synopses.
    
    Use ellipsis more idiomatically, favoring it over plurals, and including
    it within instead of outside option brackets for clarity.
    
    The construction:
    
    foo bar [baz] ...
    
    is ambiguous.  If I specify no "baz", can "bar"s be repeated?
    
    Also say "argument" when we mean an option OR an operand.
---
 contrib/eqn2graph/eqn2graph.1.man   | 2 +-
 contrib/grap2graph/grap2graph.1.man | 2 +-
 contrib/mm/mmroff.1.man             | 2 +-
 contrib/pic2graph/pic2graph.1.man   | 2 +-
 man/groff_out.5.man                 | 2 +-
 src/preproc/eqn/neqn.1.man          | 2 +-
 6 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/contrib/eqn2graph/eqn2graph.1.man 
b/contrib/eqn2graph/eqn2graph.1.man
index 472a91671..c05919082 100644
--- a/contrib/eqn2graph/eqn2graph.1.man
+++ b/contrib/eqn2graph/eqn2graph.1.man
@@ -39,7 +39,7 @@ equation into a cropped image
 .SY eqn2graph
 .RB [ \-format\~\c
 .IR output-format ]
-.RI [ convert-arguments ]
+.RI [ convert-argument \~.\|.\|.]
 .YS
 .
 .
diff --git a/contrib/grap2graph/grap2graph.1.man 
b/contrib/grap2graph/grap2graph.1.man
index 5914a846c..e7e87f3d7 100644
--- a/contrib/grap2graph/grap2graph.1.man
+++ b/contrib/grap2graph/grap2graph.1.man
@@ -40,7 +40,7 @@ diagram into a cropped image
 .RB [ \-unsafe ]
 .RB [ \-format\~\c
 .IR output-format ]
-.RI [ convert-arguments ]
+.RI [ convert-argument \~.\|.\|.]
 .YS
 .
 .
diff --git a/contrib/mm/mmroff.1.man b/contrib/mm/mmroff.1.man
index 0a34b3a4c..0a7031aa4 100644
--- a/contrib/mm/mmroff.1.man
+++ b/contrib/mm/mmroff.1.man
@@ -53,7 +53,7 @@ macro package
 .
 .SY mmroff
 .RB [ \-x ]
-.I groff-arguments
+.IR groff-argument \~.\|.\|.
 .YS
 .
 .
diff --git a/contrib/pic2graph/pic2graph.1.man 
b/contrib/pic2graph/pic2graph.1.man
index 84a906baf..f3c1c1eb3 100644
--- a/contrib/pic2graph/pic2graph.1.man
+++ b/contrib/pic2graph/pic2graph.1.man
@@ -42,7 +42,7 @@ diagram into a cropped image
 .IR output-format ]
 .RB [ \-eqn\~\c
 .IR delimiters ]
-.RI [ convert-arguments ]
+.RI [ convert-argument \~.\|.\|.]
 .YS
 .
 .
diff --git a/man/groff_out.5.man b/man/groff_out.5.man
index 672f56c7d..bc5662fb9 100644
--- a/man/groff_out.5.man
+++ b/man/groff_out.5.man
@@ -581,7 +581,7 @@ output driver library handles them.
 .
 .
 .TP
-.command m "scheme \f[R][\f[]component\f[R]] .\|.\|."
+.command m "scheme \f[R][\f[]component\f[R] .\|.\|.]"
 Select the stroke color using the
 .IR component s
 in the color space
diff --git a/src/preproc/eqn/neqn.1.man b/src/preproc/eqn/neqn.1.man
index 539afd018..758a150cd 100644
--- a/src/preproc/eqn/neqn.1.man
+++ b/src/preproc/eqn/neqn.1.man
@@ -50,7 +50,7 @@
 .\" ====================================================================
 .
 .SY @g@neqn
-.RI [ @g@eqn-options ]
+.RI [ @g@eqn-argument \~.\|.\|.]
 .YS
 .
 .



reply via email to

[Prev in Thread] Current Thread [Next in Thread]