diff options
author | G. Branden Robinson <g.branden.robinson@gmail.com> | 2020-10-19 21:39:32 +1100 |
---|---|---|
committer | G. Branden Robinson <g.branden.robinson@gmail.com> | 2020-10-20 19:48:31 +1100 |
commit | 4dd0dea194f49a42e6e88a5e29dff884bf9a1afe (patch) | |
tree | b03be529769292258049af2672edc633601e173c | |
parent | e3e0966ccae066780ab4635fbd62cdb8208b0802 (diff) | |
download | groff-git-4dd0dea194f49a42e6e88a5e29dff884bf9a1afe.tar.gz |
man pages: Update apropos (man -k) summaries.
Try to improve the apropos lines to be more descriptive and match
relevant keyword searches better.
* Where "groff" is not part of the page name, mention groff in the
summary. Conversely, where it _is_, don't repeat it in the summary.
* Don't describe preprocessors as such in the summary; at this level
users are interested in what a tool _does_ rather than its place in
the roff ecosystem.
* When a tool or macro package relies on groff extensions, say "groff"
or "GNU roff", instead of implying greater generality with unqualified
"roff" or "troff".
* Use parallel wording for output drivers and font conversion tools.
* Expand abbreviations instead of repeating them when they appear in the
command name itself (e.g., gropdf, grops).
34 files changed, 34 insertions, 36 deletions
diff --git a/contrib/chem/chem.1.man b/contrib/chem/chem.1.man index 467a78960..c3bfee4ab 100644 --- a/contrib/chem/chem.1.man +++ b/contrib/chem/chem.1.man @@ -1,6 +1,6 @@ .TH @g@chem @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -@g@chem \- groff preprocessor for producing chemical structure diagrams +@g@chem \- embed chemical structure diagrams in groff documents . . .\" ==================================================================== diff --git a/contrib/eqn2graph/eqn2graph.1.man b/contrib/eqn2graph/eqn2graph.1.man index 9047b6bb8..0959b3e00 100644 --- a/contrib/eqn2graph/eqn2graph.1.man +++ b/contrib/eqn2graph/eqn2graph.1.man @@ -1,6 +1,6 @@ .TH eqn2graph @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -eqn2graph \- convert an EQN equation into a cropped image +eqn2graph \- convert an eqn equation into a cropped image . . .\" ==================================================================== diff --git a/contrib/glilypond/glilypond.1.man b/contrib/glilypond/glilypond.1.man index 8436ec93a..8548d93e0 100644 --- a/contrib/glilypond/glilypond.1.man +++ b/contrib/glilypond/glilypond.1.man @@ -1,6 +1,6 @@ .TH glilypond @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -glilypond \- integrate lilypond parts into groff +glilypond \- embed LilyPond musical notation in groff documents . . .\" TODO: This page needs a thorough edit by a fluent English speaker. diff --git a/contrib/gperl/gperl.1.man b/contrib/gperl/gperl.1.man index 671f59ded..d9a67cade 100644 --- a/contrib/gperl/gperl.1.man +++ b/contrib/gperl/gperl.1.man @@ -1,6 +1,6 @@ .TH gperl @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -gperl \- groff preprocessor for Perl parts in roff files +gperl \- execute Perl commands in groff documents . . .\" ==================================================================== diff --git a/contrib/groff_filenames/groff_filenames.5.man b/contrib/groff_filenames/groff_filenames.5.man index cd8d0f4a1..25a798d64 100644 --- a/contrib/groff_filenames/groff_filenames.5.man +++ b/contrib/groff_filenames/groff_filenames.5.man @@ -1,6 +1,6 @@ .TH groff_filenames @MAN5EXT@ "@MDATE@" "groff @VERSION@" .SH Name -groff_filenames \- filename extensions for roff and groff +groff_filenames \- filename conventions used in roff systems . . .\" ==================================================================== diff --git a/contrib/mom/groff_mom.7.man b/contrib/mom/groff_mom.7.man index 2abf27349..5a9739df9 100644 --- a/contrib/mom/groff_mom.7.man +++ b/contrib/mom/groff_mom.7.man @@ -1,7 +1,6 @@ .TH groff_mom @MAN7EXT@ "@MDATE@" "groff @VERSION@" .SH Name -groff_mom \- groff \(lqmom\(rq macros; \(lqmom\(rq is a \(lqroff\(rq \ -language, part of \(lqgroff\(rq +groff_mom \- modern macros for document composition with GNU roff . . .\" ==================================================================== diff --git a/man/ditroff.7.man b/man/ditroff.7.man index b2da13f97..dedb08c00 100644 --- a/man/ditroff.7.man +++ b/man/ditroff.7.man @@ -1,6 +1,6 @@ .TH ditroff @MAN7EXT@ "@MDATE@" "groff @VERSION@" .SH Name -ditroff \- classical device-independent roff +ditroff \- device-independent typesetter roff . . .\" ==================================================================== diff --git a/man/groff.7.man b/man/groff.7.man index 7dd586f55..a368a26f0 100644 --- a/man/groff.7.man +++ b/man/groff.7.man @@ -1,7 +1,7 @@ '\" t .TH groff @MAN7EXT@ "@MDATE@" "groff @VERSION@" .SH Name -groff \- a short reference for the GNU roff language +groff \- GNU roff language reference . . .\" ==================================================================== diff --git a/man/groff_font.5.man b/man/groff_font.5.man index a860bfcdb..8f80f956b 100644 --- a/man/groff_font.5.man +++ b/man/groff_font.5.man @@ -1,6 +1,6 @@ .TH groff_font @MAN5EXT@ "@MDATE@" "groff @VERSION@" .SH Name -groff_font \- format of groff device and font description files +groff_font \- GNU roff device and font description files . . .\" ==================================================================== diff --git a/man/groff_out.5.man b/man/groff_out.5.man index 8739fa5a6..493653631 100644 --- a/man/groff_out.5.man +++ b/man/groff_out.5.man @@ -1,7 +1,7 @@ '\" e .TH groff_out @MAN5EXT@ "@MDATE@" "groff @VERSION@" .SH Name -groff_out \- groff intermediate output format +groff_out \- GNU roff intermediate output format . . .\" ==================================================================== diff --git a/man/groff_tmac.5.man b/man/groff_tmac.5.man index e3769a0a3..a96232ddc 100644 --- a/man/groff_tmac.5.man +++ b/man/groff_tmac.5.man @@ -1,6 +1,6 @@ .TH groff_tmac @MAN5EXT@ "@MDATE@" "groff @VERSION@" .SH Name -groff_tmac \- macro files in the roff typesetting system +groff_tmac \- macro files in the GNU roff typesetting system . . .\" ==================================================================== diff --git a/src/devices/grodvi/grodvi.1.man b/src/devices/grodvi/grodvi.1.man index 387e78b2e..e5d0d0d86 100644 --- a/src/devices/grodvi/grodvi.1.man +++ b/src/devices/grodvi/grodvi.1.man @@ -1,6 +1,6 @@ .TH grodvi @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -grodvi \- convert groff output to TeX DVI format +grodvi \- groff output driver for TeX DVI format . . .\" ==================================================================== diff --git a/src/devices/grohtml/grohtml.1.man b/src/devices/grohtml/grohtml.1.man index 65c6b9713..e4f736a65 100644 --- a/src/devices/grohtml/grohtml.1.man +++ b/src/devices/grohtml/grohtml.1.man @@ -1,6 +1,6 @@ .TH grohtml @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -grohtml \- HTML driver for groff +grohtml \- groff output driver for HTML . . .\" ==================================================================== diff --git a/src/devices/grolbp/grolbp.1.man b/src/devices/grolbp/grolbp.1.man index 2be442d0a..06ac664c0 100644 --- a/src/devices/grolbp/grolbp.1.man +++ b/src/devices/grolbp/grolbp.1.man @@ -1,8 +1,7 @@ '\" t .TH grolbp @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -grolbp \- groff driver for Canon CAPSL printers (LBP-4 and LBP-8 \ -series laser printers) +grolbp \- groff output driver for Canon CAPSL printers . . .\" Modified by Francisco Andrés Verdú <pandres@dragonet.es> for the diff --git a/src/devices/grolj4/grolj4.1.man b/src/devices/grolj4/grolj4.1.man index d0fff1bc9..cb78dbc36 100644 --- a/src/devices/grolj4/grolj4.1.man +++ b/src/devices/grolj4/grolj4.1.man @@ -1,6 +1,6 @@ .TH grolj4 @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -grolj4 \- groff driver for HP LaserJet 4 family +grolj4 \- groff output driver for HP LaserJet 4 family printers . . .\" ==================================================================== diff --git a/src/devices/gropdf/gropdf.1.man b/src/devices/gropdf/gropdf.1.man index 7a52a4692..e10e92b4f 100644 --- a/src/devices/gropdf/gropdf.1.man +++ b/src/devices/gropdf/gropdf.1.man @@ -1,6 +1,6 @@ .TH gropdf @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -gropdf \- PDF driver for groff +gropdf \- groff output driver for Portable Document Format . . .\" ==================================================================== diff --git a/src/devices/grops/grops.1.man b/src/devices/grops/grops.1.man index a0a812efe..f697d708c 100644 --- a/src/devices/grops/grops.1.man +++ b/src/devices/grops/grops.1.man @@ -1,6 +1,6 @@ .TH grops @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -grops \- PostScript driver for groff +grops \- groff output driver for PostScript . . .\" ==================================================================== diff --git a/src/devices/grotty/grotty.1.man b/src/devices/grotty/grotty.1.man index 7f82d081f..c2cd6d3c5 100644 --- a/src/devices/grotty/grotty.1.man +++ b/src/devices/grotty/grotty.1.man @@ -1,6 +1,6 @@ .TH grotty @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -grotty \- groff driver for typewriter-like (terminal) devices +grotty \- groff output driver for typewriter-like (terminal) devices . . .\" ==================================================================== diff --git a/src/devices/xditview/gxditview.1.man b/src/devices/xditview/gxditview.1.man index 4698f458f..83b080b60 100644 --- a/src/devices/xditview/gxditview.1.man +++ b/src/devices/xditview/gxditview.1.man @@ -1,6 +1,6 @@ .TH gxditview @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -gxditview \- display groff intermediate output files +gxditview \- display groff intermediate output files in X11 . . .\" ==================================================================== diff --git a/src/preproc/eqn/eqn.1.man b/src/preproc/eqn/eqn.1.man index bd5153c8f..cff27fa9a 100644 --- a/src/preproc/eqn/eqn.1.man +++ b/src/preproc/eqn/eqn.1.man @@ -1,7 +1,7 @@ '\" t .TH @g@eqn @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -@g@eqn \- format equations for GNU troff or MathML +@g@eqn \- format equations for groff or MathML . . .\" ==================================================================== diff --git a/src/preproc/eqn/neqn.1.man b/src/preproc/eqn/neqn.1.man index 6dfd820f8..0c29cf87f 100644 --- a/src/preproc/eqn/neqn.1.man +++ b/src/preproc/eqn/neqn.1.man @@ -1,6 +1,6 @@ .TH @g@neqn @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -@g@neqn \- format equations for ASCII output +@g@neqn \- format equations for character-cell terminal output . . .\" ==================================================================== diff --git a/src/preproc/pic/pic.1.man b/src/preproc/pic/pic.1.man index 20999fa60..0df78f18d 100644 --- a/src/preproc/pic/pic.1.man +++ b/src/preproc/pic/pic.1.man @@ -1,6 +1,6 @@ .TH @g@pic @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -@g@pic \- compile pictures for troff or TeX +@g@pic \- compile pictures for groff or TeX . . .\" ==================================================================== diff --git a/src/preproc/soelim/soelim.1.man b/src/preproc/soelim/soelim.1.man index 8715cb431..c72696e62 100644 --- a/src/preproc/soelim/soelim.1.man +++ b/src/preproc/soelim/soelim.1.man @@ -1,7 +1,7 @@ '\" p .TH @g@soelim @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -@g@soelim \- interpret source (.so) requests in troff input +@g@soelim \- recursively interpolate source requests in roff files . . .\" ==================================================================== diff --git a/src/preproc/tbl/tbl.1.man b/src/preproc/tbl/tbl.1.man index 4bde576d6..41b9e606c 100644 --- a/src/preproc/tbl/tbl.1.man +++ b/src/preproc/tbl/tbl.1.man @@ -1,7 +1,7 @@ '\" t .TH @g@tbl @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -@g@tbl \- format tables for troff +@g@tbl \- table formatting preprocessor for groff . . .\" Bernd Warken <groff-bernd.warken-72@web.de> added simple examples. diff --git a/src/roff/grog/grog.1.man b/src/roff/grog/grog.1.man index 2765adb1e..a8101b706 100644 --- a/src/roff/grog/grog.1.man +++ b/src/roff/grog/grog.1.man @@ -1,6 +1,6 @@ .TH grog @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -grog \- guess options for a following groff command +grog \- \(lqgroff guess\(rq\(eminfer a document's groff command . . .\" TODO: This page needs a thorough edit by a fluent English speaker. diff --git a/src/roff/nroff/nroff.1.man b/src/roff/nroff/nroff.1.man index 73e003af0..42e385e25 100644 --- a/src/roff/nroff/nroff.1.man +++ b/src/roff/nroff/nroff.1.man @@ -1,6 +1,6 @@ .TH @g@nroff @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -@g@nroff \- use groff to format documents for TTY (terminal) devices +@g@nroff \- format documents with groff for TTY (terminal) devices . . .\" ==================================================================== diff --git a/src/roff/troff/troff.1.man b/src/roff/troff/troff.1.man index 05fc1f619..36dd3ae02 100644 --- a/src/roff/troff/troff.1.man +++ b/src/roff/troff/troff.1.man @@ -1,7 +1,7 @@ '\" t .TH @g@troff @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -@g@troff \- the troff processor of the groff text formatting system +@g@troff \- GNU troff document formatter . . .\" ==================================================================== diff --git a/src/utils/afmtodit/afmtodit.1.man b/src/utils/afmtodit/afmtodit.1.man index 64b5f63df..d6780c1aa 100644 --- a/src/utils/afmtodit/afmtodit.1.man +++ b/src/utils/afmtodit/afmtodit.1.man @@ -1,6 +1,6 @@ .TH afmtodit @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -afmtodit \- create font files for use with groff \-Tps and \-Tpdf +afmtodit \- adapt Adobe Font Metrics files for groff \-Tps and \-Tpdf . . .\" ==================================================================== diff --git a/src/utils/tfmtodit/tfmtodit.1.man b/src/utils/tfmtodit/tfmtodit.1.man index 93aeb5c93..0ab2b19f6 100644 --- a/src/utils/tfmtodit/tfmtodit.1.man +++ b/src/utils/tfmtodit/tfmtodit.1.man @@ -1,6 +1,6 @@ .TH tfmtodit @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -tfmtodit \- create font files for use with groff \-Tdvi +tfmtodit \- adapt TeX Font Metrics files for groff \-Tdvi . . .\" ==================================================================== diff --git a/src/utils/xtotroff/xtotroff.1.man b/src/utils/xtotroff/xtotroff.1.man index 9414b844a..7bd9d82b0 100644 --- a/src/utils/xtotroff/xtotroff.1.man +++ b/src/utils/xtotroff/xtotroff.1.man @@ -1,6 +1,6 @@ .TH xtotroff @MAN1EXT@ "@MDATE@" "groff @VERSION@" .SH Name -xtotroff \- convert X font metrics into GNU troff font metrics +xtotroff \- convert X font metrics into groff font metrics . . .\" ==================================================================== diff --git a/tmac/groff_man.7.man.in b/tmac/groff_man.7.man.in index 61f40027d..b5d323273 100644 --- a/tmac/groff_man.7.man.in +++ b/tmac/groff_man.7.man.in @@ -47,7 +47,7 @@ _ifstyle()dnl _endif()dnl .SH Name _ifnotstyle()dnl -groff_man \- GNU roff macro package for formatting man pages +groff_man \- compose manual pages with GNU roff _endif()dnl _ifstyle()dnl groff_man_style \- GNU roff man page tutorial and style guide diff --git a/tmac/groff_mdoc.7.man b/tmac/groff_mdoc.7.man index f7a90889b..efeb3bc58 100644 --- a/tmac/groff_mdoc.7.man +++ b/tmac/groff_mdoc.7.man @@ -55,7 +55,7 @@ .Sh Name . .Nm groff_mdoc -.Nd reference for groff's mdoc implementation +.Nd compose BSD-style manual (man) pages with GNU roff . . .Sh Synopsis diff --git a/tmac/groff_trace.7.man b/tmac/groff_trace.7.man index f17b5fda3..7eb601901 100644 --- a/tmac/groff_trace.7.man +++ b/tmac/groff_trace.7.man @@ -1,6 +1,6 @@ .TH groff_trace @MAN7EXT@ "@MDATE@" "groff @VERSION@" .SH Name -groff_trace \- groff macro package trace.tmac +groff_trace \- GNU roff macros for debugging groff documents . . .\" ==================================================================== diff --git a/tmac/groff_www.7.man b/tmac/groff_www.7.man index 3530dbebf..0b3ffd20f 100644 --- a/tmac/groff_www.7.man +++ b/tmac/groff_www.7.man @@ -1,6 +1,6 @@ .TH groff_www @MAN7EXT@ "@MDATE@" "groff @VERSION@" .SH Name -groff_www \- groff macros for authoring web pages +groff_www \- GNU roff macros for authoring web pages . . .\" ==================================================================== |