[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 01/01: **/*.man: Rationalize synopses.
|
From: |
G. Branden Robinson |
|
Subject: |
[groff] 01/01: **/*.man: Rationalize synopses. |
|
Date: |
Thu, 28 Jun 2018 20:02:52 -0400 (EDT) |
gbranden pushed a commit to branch master
in repository groff.
commit 4ab68de177fbcf705e60938afd519a9374ffa05a
Author: G. Branden Robinson <address@hidden>
Date: Thu Jun 28 13:04:35 2018 -0400
**/*.man: Rationalize synopses.
Make command synopses consistent with each other, with existing man
pages in the tree, and with the parameters each command actually
accepts.
contrib/mm/groff_mm.7.man:
contrib/mm/groff_mmse.7.man:
contrib/mm/mmroff.1.man:
src/devices/grodvi/grodvi.1.man:
src/devices/grotty/grotty.1.man:
src/devices/xditview/gxditview.1.man:
src/preproc/grn/grn.1.man:
src/preproc/pic/pic.1.man:
src/utils/addftinfo/addftinfo.1.man:
src/utils/lkbib/lkbib.1.man:
src/utils/lookbib/lookbib.1.man:
src/utils/pfbtops/pfbtops.1.man:
src/utils/xtotroff/xtotroff.1.man:
* Use .SY/.YS macro pairs to structure synopses.
contrib/chem/chem.1.man:
contrib/eqn2graph/eqn2graph.1.man:
contrib/gperl/gperl.1.man:
contrib/grap2graph/grap2graph.1.man:
contrib/groffer/groffer.1.man:
contrib/groffer/roff2.1.man:
contrib/pdfmark/pdfroff.1.man:
contrib/pic2graph/pic2graph.1.man:
src/preproc/preconv/preconv.1.man:
src/roff/groff/groff.1.man:
src/roff/grog/grog.1.man:
src/roff/nroff/nroff.1.man:
* Use multiple adjacent synopsis lines (analogous to .TP and .TQ)
instead of a roman alternation symbol ("|") for synonymous options in
alternative-operation mode scenarios like printing usage or version
information.
contrib/eqn2graph/eqn2graph.1.man:
contrib/gdiffmk/gdiffmk.1.man:
contrib/gperl/gperl.1.man:
contrib/grap2graph/grap2graph.1.man:
contrib/pdfmark/pdfroff.1.man:
contrib/pic2graph/pic2graph.1.man:
src/preproc/pic/pic.1.man:
src/preproc/refer/refer.1.man:
src/roff/groff/groff.1.man:
src/roff/grog/grog.1.man:
src/roff/nroff/nroff.1.man:
src/utils/addftinfo/addftinfo.1.man:
src/utils/afmtodit/afmtodit.1.man:
src/utils/hpftodit/hpftodit.1.man:
src/utils/indxbib/indxbib.1.man:
src/utils/lkbib/lkbib.1.man:
src/utils/lookbib/lookbib.1.man:
src/utils/pfbtops/pfbtops.1.man:
src/utils/tfmtodit/tfmtodit.1.man:
src/utils/xtotroff/xtotroff.1.man:
* Use multiple .SY/.YS blocks where necessary to distinguish alternative
modes of operation. (E.g., --help and --version don't do the same
thing, let alone whatever the tool itself does.)
contrib/chem/chem.1.man:
contrib/gdiffmk/gdiffmk.1.man:
contrib/gperl/gperl.1.man:
contrib/groffer/groffer.1.man:
contrib/groffer/roff2.1.man:
contrib/pdfmark/pdfroff.1.man:
src/roff/grog/grog.1.man:
src/roff/nroff/nroff.1.man:
* Use font macros instead of .OP for optional operands (as opposed to
flags with only 0, or only 1, argument). This also prevents ellipses
from being set in italics, which is incorrect.
src/preproc/refer/refer.1.man:
* Use font macros instead of .OP for option arguments that have
character-literal sequences in them.
contrib/chem/chem.1.man:
contrib/eqn2graph/eqn2graph.1.man:
contrib/gdiffmk/gdiffmk.1.man:
contrib/glilypond/glilypond.1.man:
contrib/gperl/gperl.1.man:
contrib/grap2graph/grap2graph.1.man:
contrib/groffer/groffer.1.man:
contrib/groffer/roff2.1.man:
contrib/pic2graph/pic2graph.1.man:
src/devices/grohtml/grohtml.1.man:
src/devices/xditview/gxditview.1.man:
src/preproc/refer/refer.1.man:
src/roff/grog/grog.1.man:
src/utils/xtotroff/xtotroff.1.man:
* Remove use of \% to suppress hyphenation inside a .SY/.YS block, since
.SY already takes care of that for us.
contrib/gdiffmk/gdiffmk.1.man:
* Tweak markup of contextual options (-B and -M are only meaningful if
-D is given) to get the roman option bracket delimiters to "hug" their
contents.
contrib/glilypond/glilypond.1.man:
* Offer synopsis that doesn't just hand-wave away all the work with
"[options]". Bernd did not make this easy. groffer is an even more
daunting example, and has such an efflorescent option interface that I
despaired of documenting it. Preferable in my opinion would be just
to put the command's interface itself on a severe diet and document
the result.
src/devices/xditview/gxditview.1.man:
* Offer synopsis that doesn't just hand-wave away all the work with
"[-toolkitoptin ...]" and "[-option ...]".
src/utils/addftinfo/addftinfo.1.man:
* Offer synopsis that doesn't just hand-wave away all the work with
"[param-option value]".
contrib/mom/groff_mom.7.man:
* Use the Ellipsis string since the page already has one defined.
contrib/mm/groff_mm.7.man:
contrib/mom/groff_mom.7.man:
src/devices/grohtml/grohtml.1.man:
src/devices/gropdf/gropdf.1.man:
src/devices/grops/grops.1.man:
src/devices/grotty/grotty.1.man:
src/preproc/eqn/eqn.1.man:
src/preproc/preconv/preconv.1.man:
src/preproc/soelim/soelim.1.man:
src/preproc/tbl/tbl.1.man:
* Use the singular, not the plural, for a parameter followed by an
ellipsis.
contrib/pdfmark/pdfroff.1.man:
* Mark pdfroff's file ... operands as optional, not mandatory, since
pdfroff attempts to read from standard input even if not given -i.
This may be a bug?
contrib/pic2graph/pic2graph.1.man:
* Fix spelling of "delimiters"; the relevant root is "limit", not
"meter". A "delimeter" might be something that tells me how far I'd
have to walk for a hoagie.
src/devices/grodvi/grodvi.1.man:
src/devices/grohtml/grohtml.1.man:
src/preproc/refer/refer.1.man:
src/utils/addftinfo/addftinfo.1.man:
src/utils/hpftodit/hpftodit.1.man:
src/utils/indxbib/indxbib.1.man:
src/utils/lkbib/lkbib.1.man:
src/utils/lookbib/lookbib.1.man:
src/utils/pfbtops/pfbtops.1.man:
src/utils/tfmtodit/tfmtodit.1.man:
src/utils/xtotroff/xtotroff.1.man:
* Document --help and --version options.
src/devices/gropdf/gropdf.1.man:
* Document --version option.
src/devices/grohtml/grohtml.1.man:
* Document -V ("validator button") option in synopsis.
src/utils/addftinfo/addftinfo.1.man:
* Document -v option.
src/devices/gropdf/gropdf.1.man:
* Respell "papersize" option argument as "paper-size" to agree with
Options section.
src/preproc/pic/pic.1.man:
src/preproc/refer/refer.1.man:
* Respell "filename" operand as simply "file". This is consistent with
the bulk of other groff man pages and requires no changes to the rest
of the page (which is why I did not make similar alignments elsewhere
for this commit).
src/roff/groff/groff.1.man:
src/roff/troff/troff.1.man:
* Use a line break instead of an adjustable, breakable space escape
("\~"). We accept breaks between ellipses and their predecessors
everywhere else.
src/roff/grog/grog.1.man:
* Simplify reference to groff options in synopsis. groff(1) uses GNU
getopt so it is not necessary to group all options that don't take
arguments before those that do, which is what the synopsis was
implying.
src/roff/nroff/nroff.1.man:
* Note that -w ("enable warning") and -W ("inhibit warning") take an
argument.
src/utils/indxbib/indxbib.1.man:
* Make optional operand brackets hug their contents, and set ellipsis in
roman, not italics.
src/utils/lkbib/lkbib.1.man:
src/utils/lookbib/lookbib.1.man:
* Put space between and ellipsis and its predecessor.
src/utils/hpftodit/hpftodit.1.man:
* Put an empty request between the section header for the synopsis and
its content (for consistency with every other page).
---
contrib/chem/chem.1.man | 8 +++---
contrib/eqn2graph/eqn2graph.1.man | 8 ++++--
contrib/gdiffmk/gdiffmk.1.man | 34 ++++++++++++------------
contrib/glilypond/glilypond.1.man | 50 ++++++++++++++++++++++++++++++++++--
contrib/gperl/gperl.1.man | 19 +++++++++-----
contrib/grap2graph/grap2graph.1.man | 8 ++++--
contrib/groffer/groffer.1.man | 26 +++++++++++--------
contrib/groffer/roff2.1.man | 14 +++++++---
contrib/mm/groff_mm.7.man | 19 ++++++++------
contrib/mm/groff_mmse.7.man | 19 ++++++++------
contrib/mm/mmroff.1.man | 7 +++--
contrib/mom/groff_mom.7.man | 26 ++++++++++++-------
contrib/pdfmark/pdfroff.1.man | 23 ++++++++++++-----
contrib/pic2graph/pic2graph.1.man | 10 +++++---
src/devices/grodvi/grodvi.1.man | 32 ++++++++++++++---------
src/devices/grohtml/grohtml.1.man | 28 +++++++++++++-------
src/devices/gropdf/gropdf.1.man | 16 ++++++++----
src/devices/grops/grops.1.man | 4 +--
src/devices/grotty/grotty.1.man | 16 ++++++------
src/devices/xditview/gxditview.1.man | 19 +++++++++++---
src/preproc/eqn/eqn.1.man | 3 ++-
src/preproc/grn/grn.1.man | 24 ++++++-----------
src/preproc/pic/pic.1.man | 28 ++++++++------------
src/preproc/preconv/preconv.1.man | 9 ++++---
src/preproc/refer/refer.1.man | 19 +++++++++++---
src/preproc/soelim/soelim.1.man | 4 +--
src/preproc/tbl/tbl.1.man | 3 ++-
src/roff/groff/groff.1.man | 14 +++++++---
src/roff/grog/grog.1.man | 21 ++++++++++-----
src/roff/nroff/nroff.1.man | 11 +++++---
src/roff/troff/troff.1.man | 3 ++-
src/utils/addftinfo/addftinfo.1.man | 27 ++++++++++++++-----
src/utils/afmtodit/afmtodit.1.man | 6 ++++-
src/utils/hpftodit/hpftodit.1.man | 13 +++++++++-
src/utils/indxbib/indxbib.1.man | 14 ++++++++--
src/utils/lkbib/lkbib.1.man | 30 ++++++++++++----------
src/utils/lookbib/lookbib.1.man | 25 ++++++++++--------
src/utils/pfbtops/pfbtops.1.man | 19 +++++++++-----
src/utils/tfmtodit/tfmtodit.1.man | 12 ++++++++-
src/utils/xtotroff/xtotroff.1.man | 24 +++++++++--------
40 files changed, 458 insertions(+), 237 deletions(-)
diff --git a/contrib/chem/chem.1.man b/contrib/chem/chem.1.man
index 28e4290..9b383f9 100644
--- a/contrib/chem/chem.1.man
+++ b/contrib/chem/chem.1.man
@@ -84,20 +84,20 @@
.\" ====================================================================
.
.SY @address@hidden
-.OP \fI\%option \*(EL\fP
.OP \-\-
-.OP \fI\%filespec \*(EL\fP
+.RI [ filespec
+\*(EL]
.YS
.
.SY @address@hidden
.B \-h
-|
+.SY @address@hidden
.B \-\-help
.YS
.
.SY @address@hidden
.B \-v
-|
+.SY @address@hidden
.B \-\-version
.YS
.
diff --git a/contrib/eqn2graph/eqn2graph.1.man
b/contrib/eqn2graph/eqn2graph.1.man
index f9bd344..1318467 100644
--- a/contrib/eqn2graph/eqn2graph.1.man
+++ b/contrib/eqn2graph/eqn2graph.1.man
@@ -16,13 +16,17 @@ eqn2graph \- convert an EQN equation into a cropped image
.
.SY eqn2graph
.OP \-format output-format
-.RI [ \%convert-arguments ]
+.RI [ convert-arguments ]
.YS
.
.SY eqn2graph
.B \-\-help
+.YS
+.
.SY eqn2graph
-.RB { \-v | \-\-version }
+.B \-v
+.SY eqn2graph
+.B \-\-version
.YS
.
.
diff --git a/contrib/gdiffmk/gdiffmk.1.man b/contrib/gdiffmk/gdiffmk.1.man
index 8fa83d6..028e909 100644
--- a/contrib/gdiffmk/gdiffmk.1.man
+++ b/contrib/gdiffmk/gdiffmk.1.man
@@ -32,25 +32,27 @@ gdiffmk \- mark differences between groff/nroff/troff files
.\" ====================================================================
.
.SY gdiffmk
-.OP \-a \%addmark
-.OP \-c \%changemark
-.OP \-d \%deletemark
-[\ \c
-.B \-D
-.OP \-B
-.OP \-M "mark1 mark2"
-]
-.OP \-x \%diffcmd
+.OP \-a addmark
+.OP \-c changemark
+.OP \-d deletemark
+.RB [ \-D
+.RB [ \-B ]
+.RB [ \-M
+.IR "mark1 mark2" ]]
+.OP \-x diffcmd
.OP \-\-
-.OP \-\-help
-.OP \%\-\-version
-.I \%file1
-.I \%file2
-[\ \c
-.IR \%output \ \c
-]
+.I file1
+.I file2
+.RI [ output ]
+.YS
+.
+.SY gdiffmk
+.B \-\-help
.YS
.
+.SY gdiffmk
+.B \-\-version
+.YS
.
.\" ====================================================================
.SH DESCRIPTION
diff --git a/contrib/glilypond/glilypond.1.man
b/contrib/glilypond/glilypond.1.man
index d9f1455..c98af76 100644
--- a/contrib/glilypond/glilypond.1.man
+++ b/contrib/glilypond/glilypond.1.man
@@ -44,12 +44,58 @@ glilypond \- integrate lilypond parts into groff
.\" ====================================================================
.
.SY glilypond
-.OP options
+.RB [{ \-\-ly2eps | \-\-pdf2eps }]
+.RB [ \-e
+.IR directory ]
+.OP \-k
+.RB [ \-o
+.IR output-file ]
+.RB [ \-p
+.IR filename-prefix ]
+.RB [ \-t
+.IR tdir ]
+.RB [{ \-v | \-V }]
.OP \-
.OP \-\-
-.OP "\%filespec \*(EL"
+.RI [ filespec
+\*(EL]
+.SY glilypond
+.RB [{ \-\-ly2eps | \-\-pdf2eps }]
+.RB [ \-\-eps_dir
+.IR directory ]
+.OP \-\-keep_all
+.RB [ \-\-output
+.IR output-file ]
+.RB [ \-\-prefix
+.IR filename-prefix ]
+.RB [ \-\-temp_dir
+.IR tdir ]
+.OP \-\-verbose
+.OP \-
+.OP \-\-
+.RI [ filespec
+\*(EL]
.YS
.
+.SY glilypond
+.B \-?
+.SY glilypond
+.B \-h
+.SY glilypond
+.B \-\-help
+.SY glilypond
+.B \-\-usage
+.YS
+.
+.SY glilypond
+.B \-l
+.SY glilypond
+.B \-\-license
+.YS
+.
+.SY glilypond
+.B \-\-version
+.YS
.
.\" ====================================================================
.SH DESCRIPTION
diff --git a/contrib/gperl/gperl.1.man b/contrib/gperl/gperl.1.man
index c98ad2d..57e46cc 100644
--- a/contrib/gperl/gperl.1.man
+++ b/contrib/gperl/gperl.1.man
@@ -40,14 +40,21 @@ gperl \- groff preprocessor for Perl parts in roff files
.\" ====================================================================
.
.SY gperl
-.OP \-
-.OP \-\-
-.OP \& "\%filespec \*(EL"
+.RI [ filespec
+\*(EL]
.YS
.
-.BR "gperl \-h" | \-\-help
-.br
-.BR "gperl \-v" | \-\-version
+.SY gperl
+.B \-h
+.SY gperl
+.B \-\-help
+.YS
+.
+.SY gperl
+.B \-v
+.SY gperl
+.B \-\-version
+.YS
.
.
.\" ====================================================================
diff --git a/contrib/grap2graph/grap2graph.1.man
b/contrib/grap2graph/grap2graph.1.man
index 36475f6..5740360 100644
--- a/contrib/grap2graph/grap2graph.1.man
+++ b/contrib/grap2graph/grap2graph.1.man
@@ -17,13 +17,17 @@ grap2graph \- convert a GRAP diagram into a cropped image
.SY grap2graph
.OP \-unsafe
.OP \-format output-format
-.RI [ \%convert-arguments ]
+.RI [ convert-arguments ]
.YS
.
.SY grap2graph
.B \-\-help
+.YS
+.
.SY grap2graph
-.RB { \-v | \-\-version }
+.B \-v
+.SY grap2graph
+.B \-\-version
.YS
.
.
diff --git a/contrib/groffer/groffer.1.man b/contrib/groffer/groffer.1.man
index 5723606..edd66d8 100644
--- a/contrib/groffer/groffer.1.man
+++ b/contrib/groffer/groffer.1.man
@@ -54,25 +54,29 @@ groffer \- display groff files and man\~pages on X and tty
.\" ====================================================================
.
.SY groffer
+.RI [ mode-option
+\*(EL]
+.RI [ groff-option
+\*(EL]
+.RI [ man-option
+\*(EL]
+.RI [ X-option
+\*(EL]
.OP \-\-
-.OP \%filespec \*(EL
+.RI [ filespec
+\*(EL]
.YS
.
.SY groffer
-.OP mode-option \*(EL
-.OP groff-options \*(EL
-.OP man-options \*(EL
-.OP X-options \*(EL
-.OP \-\-
-.OP \%filespec \*(EL
-.YS
-.
+.B \-h
.SY groffer
-.BR \-h " | " \-\-help
+.B \-\-help
.YS
.
.SY groffer
-.BR \-v " | " \-\-version
+.B \-v
+.SY groffer
+.B \-\-version
.YS
.
.
diff --git a/contrib/groffer/roff2.1.man b/contrib/groffer/roff2.1.man
index fd48715..6eb2ebb 100644
--- a/contrib/groffer/roff2.1.man
+++ b/contrib/groffer/roff2.1.man
@@ -40,17 +40,23 @@ address@hidden@ \- transform roff code into @ROFF2MODE@ mode
.\" ====================================================================
.
.SY address@hidden@
-.OP \& "\%groffer_option \*(EL"
+.RI [ groffer-option
+\*(EL]
.OP \-\-
-.OP \& "\%filespec \*(EL"
+.RI [ filespec
+\*(EL]
.YS
.
.SY address@hidden@
-.BR \-h | \-\-help
+.B \-h
+.SY address@hidden@
+.B \-\-help
.YS
.
.SY address@hidden@
-.BR \-v | \-\-version
+.B \-v
+.SY address@hidden@
+.B \-\-version
.YS
.
.P
diff --git a/contrib/mm/groff_mm.7.man b/contrib/mm/groff_mm.7.man
index 61da970..015ee9c 100644
--- a/contrib/mm/groff_mm.7.man
+++ b/contrib/mm/groff_mm.7.man
@@ -31,14 +31,17 @@ groff_mm \- memorandum macros for GNU roff
.SH SYNOPSIS
.\" ====================================================================
.
-.B groff
-.B address@hidden@m
-[
-.IR options .\|.\|.\&
-]
-[
-.IR files .\|.\|.\&
-]
+.SY "groff address@hidden@m"
+.RI [ option
+\&.\|.\|.\&]
+.RI [ file
+\&.\|.\|.\&]
+.SY "groff \-m address@hidden@m"
+.RI [ option
+\&.\|.\|.\&]
+.RI [ file
+\&.\|.\|.\&]
+.YS
.
.
.\" ====================================================================
diff --git a/contrib/mm/groff_mmse.7.man b/contrib/mm/groff_mmse.7.man
index 3824a2b..d50a9cc 100644
--- a/contrib/mm/groff_mmse.7.man
+++ b/contrib/mm/groff_mmse.7.man
@@ -39,14 +39,17 @@ the original English.
.SH SYNTAX
.\" ====================================================================
.
-.B groff
-.B address@hidden@mse
-[
-.IR flaggor .\|.\|.\&
-]
-[
-.IR filer .\|.\|.\&
-]
+.SY "groff address@hidden@mse"
+.RI [ flaggor
+\&.\|.\|.\&]
+.RI [ filer
+\&.\|.\|.\&]
+.SY "groff \-m address@hidden@mse"
+.RI [ flaggor
+\&.\|.\|.\&]
+.RI [ filer
+\&.\|.\|.\&]
+.YS
.
.
.\" ====================================================================
diff --git a/contrib/mm/mmroff.1.man b/contrib/mm/mmroff.1.man
index db2c94e..be9c515 100644
--- a/contrib/mm/mmroff.1.man
+++ b/contrib/mm/mmroff.1.man
@@ -29,11 +29,10 @@ mmroff \- cross-reference preprocessor for GNU roff mm
macro package
.SH SYNOPSIS
.\" ====================================================================
.
-.B mmroff
-[
-.B \-x
-]
+.SY mmroff
+.OP \-x
.I groff-arguments
+.YS
.
.
.\" ====================================================================
diff --git a/contrib/mom/groff_mom.7.man b/contrib/mom/groff_mom.7.man
index 96d8a5c..7e7464c 100644
--- a/contrib/mom/groff_mom.7.man
+++ b/contrib/mom/groff_mom.7.man
@@ -68,19 +68,27 @@ groff_mom \- groff \[lq]mom\[rq] macros; \[lq]mom\[rq] is a
\[lq]roff\[rq] langu
.\" ====================================================================
.
.SY pdfmom
-.OP \-Tps "\fR[pdfroff options]"
-[groff options]
-.I files \*[Ellipsis]
+.RB [ \-Tps
+.RI [ pdfroff-option
+\*[Ellipsis]]]
+.RI [ groff-option
+\*[Ellipsis]]
+.I file
+\*[Ellipsis]
.YS
.
.SY groff
-.OP \-mom
-.I files \*[Ellipsis]
-.YS
-.
+.B \-mom
+.RI [ option
+\*[Ellipsis]]
+.I file
+\*[Ellipsis]
.SY groff
-.OP "\-m mom"
-.I files .\|.\|.
+.B "\-m mom"
+.RI [ option
+\*[Ellipsis]]
+.I file
+\*[Ellipsis]
.YS
.
.
diff --git a/contrib/pdfmark/pdfroff.1.man b/contrib/pdfmark/pdfroff.1.man
index 0a0a7c2..88a5a0c 100644
--- a/contrib/pdfmark/pdfroff.1.man
+++ b/contrib/pdfmark/pdfroff.1.man
@@ -70,25 +70,34 @@ pdfroff \- create PDF documents using groff
.OP \-\-emit\-ps
.OP \-\-no\-toc\-relocation
.OP \-\-no-kill\-null\-pages
-.OP \-\-stylesheet=\fIname\fP
+.RB [ \-\-stylesheet=\c
+.IR name ]
.OP \-\-no\-pdf\-output
-.OP \-\-pdf\-output=\fIname\fP
+.RB [ \-\-pdf\-output=\c
+.IR name ]
.OP \-\-no\-reference\-dictionary
-.OP \-\-reference\-dictionary=\fIname\fP
+.RB [ \-\-reference\-dictionary=\c
+.IR name ]
.OP \-\-report\-progress
.OP \-\-keep\-temporary\-files
-.I file .\|.\|.
+.RI [ file
+\&.\|.\|.\&]
+.YS
.
.SY pdfroff
.B \-h
-|
+.SY pdfroff
.B \-\-help
+.YS
.
.SY pdfroff
.B \-v
-|
+.RI [ groff-option
+\&.\|.\|.\&]
+.SY pdfroff
.B \-\-version
-.RI [ option\ .\|.\|. ]
+.RI [ groff-option
+\&.\|.\|.\&]
.YS
.
.
diff --git a/contrib/pic2graph/pic2graph.1.man
b/contrib/pic2graph/pic2graph.1.man
index 00e5dee..a810e20 100644
--- a/contrib/pic2graph/pic2graph.1.man
+++ b/contrib/pic2graph/pic2graph.1.man
@@ -17,14 +17,18 @@ pic2graph \- convert a PIC diagram into a cropped image
.SY pic2graph
.OP \-unsafe
.OP \-format output-format
-.OP \-eqn delimeters
-.RI [ \%convert-arguments ]
+.OP \-eqn delimiters
+.RI [ convert-arguments ]
.YS
.
.SY pic2graph
.B \-\-help
+.YS
+.
.SY pic2graph
-.RB { \-v | \-\-version }
+.B \-v
+.SY pic2graph
+.B \-\-version
.YS
.
.
diff --git a/src/devices/grodvi/grodvi.1.man b/src/devices/grodvi/grodvi.1.man
index b0aed5e..720aec2 100644
--- a/src/devices/grodvi/grodvi.1.man
+++ b/src/devices/grodvi/grodvi.1.man
@@ -38,18 +38,26 @@ grodvi \- convert groff output to TeX DVI format
.SH SYNOPSIS
.\" ====================================================================
.
-.B grodvi
-[
-.B \-dlv
-] [
-.BI \-F dir
-] [
-.BI \-p papersize
-] [
-.BI \-w n
-] [
-.IR files \|.\|.\|.\&
-]
+.SY grodvi
+.OP \-dl
+.OP \-F dir
+.OP \-p papersize
+.OP \-w n
+.RI [ file
+\&.\|.\|.\&]
+.YS
+.
+.SY grodvi
+.B \-\-help
+.SY
+.
+.SY grodvi
+.B \-v
+.SY grodvi
+.B \-\-version
+.YS
+.
+.
.PP
It is possible to have whitespace between a command-line option and its
parameter.
diff --git a/src/devices/grohtml/grohtml.1.man
b/src/devices/grohtml/grohtml.1.man
index 93a97dc..6f9e386 100644
--- a/src/devices/grohtml/grohtml.1.man
+++ b/src/devices/grohtml/grohtml.1.man
@@ -28,21 +28,31 @@ grohtml \- HTML driver for groff
.\" ====================================================================
.
.SY grohtml
-.OP \-bhlnprv
-.OP \-a \%aa-text-bits
+.OP \-bhlnprVy
+.OP \-a aa-text-bits
.OP \-D dir
.OP \-F dir
-.OP \-g \%aa-graphic-bits
-.OP \-i \%resolution
-.OP \-I \%image-stem
-.OP \-j \%filename
-.OP \-o \%image-vertical-offset
+.OP \-g aa-graphic-bits
+.OP \-i resolution
+.OP \-I image-stem
+.OP \-j filename
+.OP \-o image-vertical-offset
.OP \-s size
.OP \-S level
-.OP \-x \%html-dialect
-.RI "[\ " files\|.\|.\|. "\ ]"
+.OP \-x html-dialect
+.RI [ file
+\&.\|.\|.\&]
.YS
.
+.SY grohtml
+.B \-\-help
+.YS
+.
+.SY grohtml
+.B \-v
+.SY grohtml
+.B \-\-version
+.YS
.
.\" ====================================================================
.SH DESCRIPTION
diff --git a/src/devices/gropdf/gropdf.1.man b/src/devices/gropdf/gropdf.1.man
index 3852cdf..73a7446 100644
--- a/src/devices/gropdf/gropdf.1.man
+++ b/src/devices/gropdf/gropdf.1.man
@@ -38,17 +38,23 @@ gropdf \- PDF driver for groff
.\" ====================================================================
.
.SY gropdf
-.OP \-delvs
+.OP \-dels
.OP \-F dir
.OP \-I dir
-.OP \-p papersize
+.OP \-p paper-size
\#.OP \-w n
+.RB [ \-u
+.RI [ cmapfile ]]
.OP \-y foundry
-.OP \-u [cmapfile]
-.RI [ files
-.IR .\|.\|. ]
+.RI [ file
+\&.\|.\|.\&]
.YS
.
+.SY gropdf
+.B \-v
+.SY gropdf
+.B \-\-version
+.YS
.
.\" ====================================================================
.SH DESCRIPTION
diff --git a/src/devices/grops/grops.1.man b/src/devices/grops/grops.1.man
index 47ae546..22a5d97 100644
--- a/src/devices/grops/grops.1.man
+++ b/src/devices/grops/grops.1.man
@@ -46,8 +46,8 @@ grops \- PostScript driver for groff
.OP \-p papersize
.OP \-P prologue
.OP \-w n
-.RI [ files
-.IR .\|.\|. ]
+.RI [ file
+\&.\|.\|.\&]
.YS
.
.
diff --git a/src/devices/grotty/grotty.1.man b/src/devices/grotty/grotty.1.man
index bba6140..902a0a6 100644
--- a/src/devices/grotty/grotty.1.man
+++ b/src/devices/grotty/grotty.1.man
@@ -32,14 +32,14 @@ grotty \- groff driver for typewriter-like devices
.SH SYNOPSIS
.\" ====================================================================
.
-.B grotty
-[
-.B \-bBcdfhioruUv
-] [
-.BI \-F dir
-] [
-.IR files \|.\|.\|.\&
-]
+.SY grotty
+.OP \-bBcdfhioruUv
+.OP \-F dir
+.RI [ file
+\&.\|.\|.\&]
+.YS
+.
+.
.PP
It is possible to have whitespace between the
.B \-F
diff --git a/src/devices/xditview/gxditview.1.man
b/src/devices/xditview/gxditview.1.man
index a9e6bde..2f02c2c 100644
--- a/src/devices/xditview/gxditview.1.man
+++ b/src/devices/xditview/gxditview.1.man
@@ -33,10 +33,21 @@ gxditview \- display groff intermediate output files
.SH SYNOPSIS
.\" ====================================================================
.
-.B \%gxditview
-.RI [\fB\- toolkitoption\ .\|.\|.\|]
-.RI [\fB\- option\ .\|.\|.\|]
-.RI [ filename ]
+.SY gxditview
+.RI [ X-toolkit-option \&.\|.\|.\&]
+.OP \-backingStore backing-store-type
+.OP \-filename string
+.OP \-page n
+.OP \-printCommand string
+.OP \-resolution res
+.RI [ file ]
+.YS
+.
+.SY gxditview
+.B \-help
+.SY gxditview
+.B \-\-help
+.YS
.
.
.\" ====================================================================
diff --git a/src/preproc/eqn/eqn.1.man b/src/preproc/eqn/eqn.1.man
index 707999b..ef428cf 100644
--- a/src/preproc/eqn/eqn.1.man
+++ b/src/preproc/eqn/eqn.1.man
@@ -48,7 +48,8 @@
.OP \-s n
.OP \-p n
.OP \-m n
-.RI [ files\|.\|.\|. ]
+.RI [ file
+\&.\|.\|.\&]
.YS
.
.
diff --git a/src/preproc/grn/grn.1.man b/src/preproc/grn/grn.1.man
index cfca060..dfa5293 100644
--- a/src/preproc/grn/grn.1.man
+++ b/src/preproc/grn/grn.1.man
@@ -37,22 +37,14 @@
.SH SYNOPSIS
.\" ====================================================================
.
-.BR @address@hidden
-[
-.B \-Cv
-]
-[
-.BI \-T dev
-]
-[
-.BI \-M dir
-]
-[
-.BI \-F dir
-]
-[
-.IR file\.\.\.\&
-]
+.SY @address@hidden
+.OP \-Cv
+.OP \-T dev
+.OP \-M dir
+.OP \-F dir
+.RI [ file
+\&.\|.\|.\&]
+.YS
.
.
.\" ====================================================================
diff --git a/src/preproc/pic/pic.1.man b/src/preproc/pic/pic.1.man
index 7c6c225..86ad8a4 100644
--- a/src/preproc/pic/pic.1.man
+++ b/src/preproc/pic/pic.1.man
@@ -55,24 +55,18 @@
.SH SYNOPSIS
.\" ====================================================================
.
-.B @address@hidden
-[
-.B \-nvCSU
-]
-[
-.I filename
-\&.\|.\|.\&
-]
-.br
-.B @address@hidden
+.SY @address@hidden
+.OP \-nvCSU
+.RI [ file
+\&.\|.\|.\&]
+.YS
+.
+.SY @address@hidden
.B \-t
-[
-.B \-cvzCSU
-]
-[
-.I filename
-\&.\|.\|.\&
-]
+.OP \-cvzCSU
+.RI [ file
+\&.\|.\|.\&]
+.YS
.
.
.\" ====================================================================
diff --git a/src/preproc/preconv/preconv.1.man
b/src/preproc/preconv/preconv.1.man
index 44273d8..411867d 100644
--- a/src/preproc/preconv/preconv.1.man
+++ b/src/preproc/preconv/preconv.1.man
@@ -35,17 +35,18 @@ preconv \- convert encoding of input files to something GNU
troff understands
.SY preconv
.OP \-dr
.OP \-e encoding
-.RI [ files
-.IR .\|.\|. ]
+.RI [ file
+\&.\|.\|.\&]
.
.SY preconv
.B \-h
-|
+.SY preconv
.B \-\-help
+.YS
.
.SY preconv
.B \-v
-|
+.SY preconv
.B \-\-version
.YS
.
diff --git a/src/preproc/refer/refer.1.man b/src/preproc/refer/refer.1.man
index cd509d0..8dd45d4 100644
--- a/src/preproc/refer/refer.1.man
+++ b/src/preproc/refer/refer.1.man
@@ -30,18 +30,29 @@
.\" ====================================================================
.
.SY @address@hidden
-.OP \-benvCPRS
+.OP \-benCPRS
.OP \-a n
.OP \-c fields
.OP \-f n
.OP \-i fields
.OP \-k field
.OP \-l m,n
-.OP \-p \%filename
+.OP \-p filename
.OP \-s fields
.OP \-t n
-.OP \-B field.macro
-.RI [\ \%filename \|.\|.\|.\ ]
+.BI "\-B " field . macro
+.RI [ file
+\&.\|.\|.\&]
+.YS
+.
+.SY @address@hidden
+.B \-\-help
+.YS
+.
+.SY @address@hidden
+.B \-v
+.SY @address@hidden
+.B \-\-version
.YS
.
.
diff --git a/src/preproc/soelim/soelim.1.man b/src/preproc/soelim/soelim.1.man
index e3a69d3..c17e258 100644
--- a/src/preproc/soelim/soelim.1.man
+++ b/src/preproc/soelim/soelim.1.man
@@ -37,8 +37,8 @@
.SY @address@hidden
.OP \-Crtv
.OP \-I dir
-.RI [ files
-.IR \|.\|.\|. ]
+.RI [ file
+\&.\|.\|.\&]
.YS
.
.
diff --git a/src/preproc/tbl/tbl.1.man b/src/preproc/tbl/tbl.1.man
index ace8fd5..48b9e9d 100644
--- a/src/preproc/tbl/tbl.1.man
+++ b/src/preproc/tbl/tbl.1.man
@@ -36,7 +36,8 @@
.
.SY @address@hidden
.OP \-Cv
-.RI [ file\~ .\|.\|.]
+.RI [ file
+\&.\|.\|.\&]
.YS
.
.
diff --git a/src/roff/groff/groff.1.man b/src/roff/groff/groff.1.man
index 948f956..ae1bcdc 100644
--- a/src/roff/groff/groff.1.man
+++ b/src/roff/groff/groff.1.man
@@ -72,18 +72,24 @@ groff \- front-end for the groff document formatting system
.OP \-T dev
.OP \-w name
.OP \-W name
-.RI [ file\~ .\|.\|.]
+.RI [ file
+\&.\|.\|.\&]
+.YS
.
.SY groff
.B \-h
-|
+.SY groff
.B \-\-help
+.YS
.
.SY groff
.B \-v
-|
+.RI [ option
+\&.\|.\|.\&]
+.SY groff
.B \-\-version
-.RI [ option\~ .\|.\|.]
+.RI [ option
+\&.\|.\|.\&]
.YS
.
.
diff --git a/src/roff/grog/grog.1.man b/src/roff/grog/grog.1.man
index 7b5565b..7e4638a 100644
--- a/src/roff/grog/grog.1.man
+++ b/src/roff/grog/grog.1.man
@@ -49,15 +49,24 @@ grog \- guess options for a following groff command
.OP \-\-run
.OP \-\-warnings
.OP \-\-ligatures
-.OP "\%groff\-option no arg"
-.OP "\%groff\-option with arg \*(EL"
+.RI [ groff-option
+\*(EL]
.OP \-\-
-.OP "\%filespec \*(EL"
+.RI [ filespec
+\*(EL]
.YS
.
-.BR "grog \-h " | " \-\-help"
-.br
-.BR "grog \-v " | " \-\-version"
+.SY grog
+.B \-h
+.SY grog
+.B \-\-help
+.YS
+.
+.SY grog
+.B \-v
+.SY grog
+.B \-\-version
+.YS
.
.
.\" ====================================================================
diff --git a/src/roff/nroff/nroff.1.man b/src/roff/nroff/nroff.1.man
index e070906..1161d2c 100644
--- a/src/roff/nroff/nroff.1.man
+++ b/src/roff/nroff/nroff.1.man
@@ -38,7 +38,7 @@
..
.SY @address@hidden
-.OP \-CchipStUvwW
+.OP \-CchipStUv
.OP \-d cs
.OP \-M dir
.OP \-m name
@@ -46,14 +46,19 @@
.OP \-o list
.OP \-r cn
.OP \-T name
-.RI [ file\~ .\|.\|.]
+.OP \-W warning
+.OP \-w warning
+.RI [ file
+\&.\|.\|.\&]
+.YS
.
.SY @address@hidden
.B \-\-help
+.YS
.
.SY @address@hidden
.B \-v
-|
+.SY @address@hidden
.B \-\-version
.YS
.
diff --git a/src/roff/troff/troff.1.man b/src/roff/troff/troff.1.man
index 120a490..7cf2080 100644
--- a/src/roff/troff/troff.1.man
+++ b/src/roff/troff/troff.1.man
@@ -43,7 +43,8 @@
.OP \-T name
.OP \-w name
.OP \-W name
-.RI [ file\~ .\|.\|.]
+.RI [ file
+\&.\|.\|.\&]
.YS
.
.
diff --git a/src/utils/addftinfo/addftinfo.1.man
b/src/utils/addftinfo/addftinfo.1.man
index 60d7b1c..07c4312 100644
--- a/src/utils/addftinfo/addftinfo.1.man
+++ b/src/utils/addftinfo/addftinfo.1.man
@@ -39,16 +39,29 @@ addftinfo \- add information to troff font files for use
with groff
.SH SYNOPSIS
.\" ====================================================================
.
-.B addftinfo
-[
-.B \-v
-]
-[
-.IR "param-option value" \*(EL
-]
+.SY addftinfo
+.OP \-asc\-height n
+.OP \-body\-depth n
+.OP \-body\-height n
+.OP \-cap\-height n
+.OP \-comma\-depth n
+.OP \-desc\-depth n
+.OP \-fig\-height n
+.OP \-x\-height n
.I res
.I unitwidth
.I font
+.YS
+.
+.SY addftinfo
+.B \-\-help
+.YS
+.
+.SY addftinfo
+.B \-v
+.SY addftinfo
+.B \-\-version
+.YS
.
.
.\" ====================================================================
diff --git a/src/utils/afmtodit/afmtodit.1.man
b/src/utils/afmtodit/afmtodit.1.man
index 7ffce17..f1371cd 100644
--- a/src/utils/afmtodit/afmtodit.1.man
+++ b/src/utils/afmtodit/afmtodit.1.man
@@ -29,7 +29,7 @@ afmtodit \- create font files for use with groff \-Tps and
\-Tpdf
.\" ====================================================================
.
.SY afmtodit
-.OP \-ckmnsvx
+.OP \-ckmnsx
.OP \-a n
.OP \-d desc_file
.OP \-e enc_file
@@ -41,6 +41,10 @@ afmtodit \- create font files for use with groff \-Tps and
\-Tpdf
.I font
.YS
.
+.SY afmtodit
+.B \-v
+.YS
+.
.
.LP
The whitespace between a command-line option and its argument is optional.
diff --git a/src/utils/hpftodit/hpftodit.1.man
b/src/utils/hpftodit/hpftodit.1.man
index 63dfefc..a0a4c53 100644
--- a/src/utils/hpftodit/hpftodit.1.man
+++ b/src/utils/hpftodit/hpftodit.1.man
@@ -33,8 +33,9 @@ hpftodit \- create font description files for use with groff
\-Tlj4
.\" ====================================================================
.SH SYNOPSIS
.\" ====================================================================
+.
.SY hpftodit
-.OP \-aqsv
+.OP \-aqs
.OP \-i n
.I tfm-file
.I map-file
@@ -47,6 +48,16 @@ hpftodit \- create font description files for use with groff
\-Tlj4
.RI [ map-file ]
.YS
.
+.SY hpftodit
+.B \-\-help
+.YS
+.
+.SY hpftodit
+.B \-v
+.SY hpftodit
+.B \-\-version
+.YS
+.
.
.\" ====================================================================
.SH DESCRIPTION
diff --git a/src/utils/indxbib/indxbib.1.man b/src/utils/indxbib/indxbib.1.man
index 1dd1052..8a63fa5 100644
--- a/src/utils/indxbib/indxbib.1.man
+++ b/src/utils/indxbib/indxbib.1.man
@@ -26,7 +26,7 @@
.\" ====================================================================
.
.SY @address@hidden
-.OP \-vw
+.OP \-w
.OP \-c file
.OP \-d dir
.OP \-f file
@@ -37,9 +37,19 @@
.OP \-n n
.OP \-o file
.OP \-t n
-.RI [\ filename \|.\|.\|.\ ]
+.RI [ filename
+\&.\|.\|.\&]
.YS
.
+.SY @address@hidden
+.B \-\-help
+.YS
+.
+.SY @address@hidden
+.B \-v
+.SY @address@hidden
+.B \-\-version
+.YS
.
.\" ====================================================================
.SH DESCRIPTION
diff --git a/src/utils/lkbib/lkbib.1.man b/src/utils/lkbib/lkbib.1.man
index 5e3e831..9426949 100644
--- a/src/utils/lkbib/lkbib.1.man
+++ b/src/utils/lkbib/lkbib.1.man
@@ -29,20 +29,24 @@ lkbib \- search bibliographic databases
.SH SYNOPSIS
.\" ====================================================================
.
-.B lkbib
-[
+.SY lkbib
+.OP \-n
+.OP \-i fields
+.OP \-p filename
+.OP \-t n
+.I key
+\&.\|.\|.\&
+.YS
+.
+.SY lkbib
+.B \-\-help
+.YS
+.
+.SY lkbib
.B \-v
-]
-[
-.BI \-i fields
-]
-[
-.BI \-p filename
-]
-[
-.BI \-t n
-]
-.IR key \|.\|.\|.
+.SY lkbib
+.B \-\-version
+.YS
.
.
.\" ====================================================================
diff --git a/src/utils/lookbib/lookbib.1.man b/src/utils/lookbib/lookbib.1.man
index 7e4b232..3baaa85 100644
--- a/src/utils/lookbib/lookbib.1.man
+++ b/src/utils/lookbib/lookbib.1.man
@@ -29,17 +29,22 @@
.SH SYNOPSIS
.\" ====================================================================
.
-.B @address@hidden
-[
+.SY @address@hidden
+.OP \-i string
+.OP \-t n
+.I filename
+\&.\|.\|.\&
+.YS
+.
+.SY @address@hidden
+.B \-\-help
+.YS
+.
+.SY @address@hidden
.B \-v
-]
-[
-.BI \-i string
-]
-[
-.BI \-t n
-]
-.IR filename \|.\|.\|.
+.SY @address@hidden
+.B \-\-version
+.YS
.
.
.\" ====================================================================
diff --git a/src/utils/pfbtops/pfbtops.1.man b/src/utils/pfbtops/pfbtops.1.man
index 278aada..0da731d 100644
--- a/src/utils/pfbtops/pfbtops.1.man
+++ b/src/utils/pfbtops/pfbtops.1.man
@@ -29,14 +29,19 @@ pfbtops \- translate a PostScript font in .pfb format to
ASCII
.SH SYNOPSIS
.\" ====================================================================
.
-.B pfbtops
-[
-.B \-v
-]
-[
-.I pfb_file
-]
+.SY pfbtops
+.RI [ pfb_file ]
+.YS
.
+.SY pfbtops
+.B \-\-help
+.YS
+.
+.SY pfbtops
+.B \-v
+.SY pfbtops
+.B \-\-version
+.YS
.
.\" ====================================================================
.SH DESCRIPTION
diff --git a/src/utils/tfmtodit/tfmtodit.1.man
b/src/utils/tfmtodit/tfmtodit.1.man
index c6126c0..634545d 100644
--- a/src/utils/tfmtodit/tfmtodit.1.man
+++ b/src/utils/tfmtodit/tfmtodit.1.man
@@ -38,7 +38,7 @@ tfmtodit \- create font files for use with groff \-Tdvi
.\" ====================================================================
.
.SY tfmtodit
-.OP \-sv
+.OP \-s
.OP \-g gf_file
.OP \-k skewchar
.I tfm_file
@@ -46,6 +46,16 @@ tfmtodit \- create font files for use with groff \-Tdvi
.I font
.YS
.
+.SY tfmtodit
+.B \-\-help
+.YS
+.
+.SY tfmtodit
+.B \-v
+.SY tfmtodit
+.B \-\-version
+.YS
+.
.
.\" ====================================================================
.SH DESCRIPTION
diff --git a/src/utils/xtotroff/xtotroff.1.man
b/src/utils/xtotroff/xtotroff.1.man
index d87d9af..42b77e6 100644
--- a/src/utils/xtotroff/xtotroff.1.man
+++ b/src/utils/xtotroff/xtotroff.1.man
@@ -29,17 +29,21 @@ xtotroff \- convert X font metrics into GNU troff font
metrics
.SH SYNOPSIS
.\" ====================================================================
.
-.B xtotroff
-[
-.BI \-r \%resolution
-]
-[
-.BI \-s \%point-size
-]
-[
-.B \-v
-]
+.SY xtotroff
+.OP \-r resolution
+.OP \-s point-size
.I FontMap
+.YS
+.
+.SY xtotroff
+.B \-\-help
+.YS
+.
+.SY xtotroff
+.B \-v
+.SY xtotroff
+.B \-\-version
+.YS
.
.
.\" ====================================================================
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 01/01: **/*.man: Rationalize synopses.,
G. Branden Robinson <=