summaryrefslogtreecommitdiff
path: root/contrib/chem
diff options
context:
space:
mode:
authorG. Branden Robinson <g.branden.robinson@gmail.com>2018-06-28 13:04:35 -0400
committerG. Branden Robinson <g.branden.robinson@gmail.com>2018-06-28 19:28:39 -0400
commit4ab68de177fbcf705e60938afd519a9374ffa05a (patch)
treeeea13da69a735252c8badfbc91a25becc54559a9 /contrib/chem
parentd8746c8c518edfa3f2746fbb067d93b60a407ab4 (diff)
downloadgroff-git-4ab68de177fbcf705e60938afd519a9374ffa05a.tar.gz
**/*.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).
Diffstat (limited to 'contrib/chem')
-rw-r--r--contrib/chem/chem.1.man8
1 files changed, 4 insertions, 4 deletions
diff --git a/contrib/chem/chem.1.man b/contrib/chem/chem.1.man
index 28e429067..9b383f990 100644
--- a/contrib/chem/chem.1.man
+++ b/contrib/chem/chem.1.man
@@ -84,20 +84,20 @@
.\" ====================================================================
.
.SY @g@chem
-.OP \fI\%option \*(EL\fP
.OP \-\-
-.OP \fI\%filespec \*(EL\fP
+.RI [ filespec
+\*(EL]
.YS
.
.SY @g@chem
.B \-h
-|
+.SY @g@chem
.B \-\-help
.YS
.
.SY @g@chem
.B \-v
-|
+.SY @g@chem
.B \-\-version
.YS
.