[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 12/15: man pages: Update apropos (man -k) summaries.
From: |
G. Branden Robinson |
Subject: |
[groff] 12/15: man pages: Update apropos (man -k) summaries. |
Date: |
Tue, 20 Oct 2020 14:00:33 -0400 (EDT) |
gbranden pushed a commit to branch master
in repository groff.
commit 4dd0dea194f49a42e6e88a5e29dff884bf9a1afe
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Mon Oct 19 21:39:32 2020 +1100
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).
---
contrib/chem/chem.1.man | 2 +-
contrib/eqn2graph/eqn2graph.1.man | 2 +-
contrib/glilypond/glilypond.1.man | 2 +-
contrib/gperl/gperl.1.man | 2 +-
contrib/groff_filenames/groff_filenames.5.man | 2 +-
contrib/mom/groff_mom.7.man | 3 +--
man/ditroff.7.man | 2 +-
man/groff.7.man | 2 +-
man/groff_font.5.man | 2 +-
man/groff_out.5.man | 2 +-
man/groff_tmac.5.man | 2 +-
src/devices/grodvi/grodvi.1.man | 2 +-
src/devices/grohtml/grohtml.1.man | 2 +-
src/devices/grolbp/grolbp.1.man | 3 +--
src/devices/grolj4/grolj4.1.man | 2 +-
src/devices/gropdf/gropdf.1.man | 2 +-
src/devices/grops/grops.1.man | 2 +-
src/devices/grotty/grotty.1.man | 2 +-
src/devices/xditview/gxditview.1.man | 2 +-
src/preproc/eqn/eqn.1.man | 2 +-
src/preproc/eqn/neqn.1.man | 2 +-
src/preproc/pic/pic.1.man | 2 +-
src/preproc/soelim/soelim.1.man | 2 +-
src/preproc/tbl/tbl.1.man | 2 +-
src/roff/grog/grog.1.man | 2 +-
src/roff/nroff/nroff.1.man | 2 +-
src/roff/troff/troff.1.man | 2 +-
src/utils/afmtodit/afmtodit.1.man | 2 +-
src/utils/tfmtodit/tfmtodit.1.man | 2 +-
src/utils/xtotroff/xtotroff.1.man | 2 +-
tmac/groff_man.7.man.in | 2 +-
tmac/groff_mdoc.7.man | 2 +-
tmac/groff_trace.7.man | 2 +-
tmac/groff_www.7.man | 2 +-
34 files changed, 34 insertions(+), 36 deletions(-)
diff --git a/contrib/chem/chem.1.man b/contrib/chem/chem.1.man
index 467a789..c3bfee4 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 9047b6b..0959b3e 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 8436ec9..8548d93 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 671f59d..d9a67ca 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 cd8d0f4..25a798d 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 2abf273..5a9739d 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 b2da13f..dedb08c 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 7dd586f..a368a26 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 a860bfc..8f80f95 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 8739fa5..4936536 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 e3769a0..a96232d 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 387e78b..e5d0d0d 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 65c6b97..e4f736a 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 2be442d..06ac664 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 d0fff1b..cb78dbc 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 7a52a46..e10e92b 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 a0a812e..f697d70 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 7f82d08..c2cd6d3 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 4698f45..83b080b 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 bd5153c..cff27fa 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 6dfd820..0c29cf8 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 20999fa..0df78f1 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 8715cb4..c72696e 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 4bde576..41b9e60 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 2765adb..a8101b7 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 73e003a..42e385e 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 05fc1f6..36dd3ae 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 64b5f63..d6780c1 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 93aeb5c..0ab2b19 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 9414b84..7bd9d82 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 61f4002..b5d3232 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 f7a9088..efeb3bc 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 f17b5fd..7eb6019 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 3530dbe..0b3ffd2 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
.
.
.\" ====================================================================
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 12/15: man pages: Update apropos (man -k) summaries.,
G. Branden Robinson <=