groff-commit
[Top][All Lists]
Advanced

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

[groff] 08/16: [man pages]: Update summary descriptions.


From: G. Branden Robinson
Subject: [groff] 08/16: [man pages]: Update summary descriptions.
Date: Mon, 31 Oct 2022 21:33:28 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit d72b4b7b945a54093811f498739f09c647be6812
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sun Oct 30 19:44:51 2022 -0500

    [man pages]: Update summary descriptions.
    
    * Set names of groff programs (or "roff") and macro packages in italics.
    * Spell "grap" and "pic" in lowercase.
    * Capitalize "Gremlin" when referring to the file format.
    * Drop unnecessary input line continuation.
    * Name output driver command name instead of groff option with argument.
    * Stop implying that groff's me(7) is restricted to use with groff; it's
      supposed to work in compatibility mode, too, and therefore with other
      *roffs.
---
 contrib/chem/chem.1.man              | 4 +++-
 contrib/eqn2graph/eqn2graph.1.man    | 4 +++-
 contrib/gdiffmk/gdiffmk.1.man        | 4 +++-
 contrib/glilypond/glilypond.1.man    | 4 +++-
 contrib/gperl/gperl.1.man            | 4 +++-
 contrib/gpinyin/gpinyin.1.man        | 4 +++-
 contrib/grap2graph/grap2graph.1.man  | 4 +++-
 contrib/hdtbl/groff_hdtbl.7.man      | 3 ++-
 contrib/mm/groff_mm.7.man            | 3 ++-
 contrib/mm/groff_mmse.7.man          | 3 ++-
 contrib/mm/mmroff.1.man              | 4 +++-
 contrib/pdfmark/pdfroff.1.man        | 3 ++-
 contrib/pic2graph/pic2graph.1.man    | 4 +++-
 man/groff_char.7.man                 | 4 +++-
 man/groff_font.5.man                 | 4 +++-
 man/groff_tmac.5.man                 | 4 +++-
 src/devices/gropdf/gropdf.1.man      | 4 +++-
 src/devices/grops/grops.1.man        | 4 +++-
 src/devices/grotty/grotty.1.man      | 4 +++-
 src/devices/xditview/gxditview.1.man | 4 +++-
 src/preproc/grn/grn.1.man            | 4 +++-
 src/preproc/preconv/preconv.1.man    | 3 ++-
 src/preproc/refer/refer.1.man        | 3 ++-
 src/preproc/tbl/tbl.1.man            | 4 +++-
 src/roff/groff/groff.1.man           | 4 +++-
 src/roff/nroff/nroff.1.man           | 4 +++-
 src/roff/troff/troff.1.man           | 4 +++-
 src/utils/addftinfo/addftinfo.1.man  | 5 ++++-
 src/utils/grog/grog.1.man            | 5 +++--
 src/utils/hpftodit/hpftodit.1.man    | 5 ++++-
 src/utils/xtotroff/xtotroff.1.man    | 4 +++-
 tmac/groff_man.7.man.in              | 7 +++++--
 tmac/groff_me.7.man                  | 5 +++--
 tmac/groff_ms.7.man                  | 4 +++-
 tmac/groff_trace.7.man               | 4 +++-
 tmac/groff_www.7.man                 | 4 +++-
 36 files changed, 106 insertions(+), 39 deletions(-)

diff --git a/contrib/chem/chem.1.man b/contrib/chem/chem.1.man
index c97c55a33..78b55cab6 100644
--- a/contrib/chem/chem.1.man
+++ b/contrib/chem/chem.1.man
@@ -1,6 +1,8 @@
 .TH @g@chem @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-@g@chem \- embed chemical structure diagrams in groff documents
+@g@chem \- embed chemical structure diagrams in
+.I groff
+documents
 .
 .
 .\" ====================================================================
diff --git a/contrib/eqn2graph/eqn2graph.1.man 
b/contrib/eqn2graph/eqn2graph.1.man
index 4df3a267a..697163fc4 100644
--- a/contrib/eqn2graph/eqn2graph.1.man
+++ b/contrib/eqn2graph/eqn2graph.1.man
@@ -1,6 +1,8 @@
 .TH eqn2graph @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-eqn2graph \- convert an eqn equation into a cropped image
+eqn2graph \- convert an
+.I eqn \" generic
+equation into a cropped image
 .
 .
 .\" ====================================================================
diff --git a/contrib/gdiffmk/gdiffmk.1.man b/contrib/gdiffmk/gdiffmk.1.man
index 9c9d1f936..1904c9fbd 100644
--- a/contrib/gdiffmk/gdiffmk.1.man
+++ b/contrib/gdiffmk/gdiffmk.1.man
@@ -1,6 +1,8 @@
 .TH gdiffmk @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-gdiffmk \- mark differences between groff/nroff/troff files
+gdiffmk \- mark differences between
+.IR groff / nroff / troff
+files
 .
 .
 .\" ====================================================================
diff --git a/contrib/glilypond/glilypond.1.man 
b/contrib/glilypond/glilypond.1.man
index e671a4144..6bb5e9941 100644
--- a/contrib/glilypond/glilypond.1.man
+++ b/contrib/glilypond/glilypond.1.man
@@ -1,6 +1,8 @@
 .TH glilypond @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-glilypond \- embed LilyPond musical notation in groff documents
+glilypond \- embed LilyPond musical notation in
+.I 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 a540f3931..ed8f04264 100644
--- a/contrib/gperl/gperl.1.man
+++ b/contrib/gperl/gperl.1.man
@@ -1,6 +1,8 @@
 .TH gperl @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-gperl \- execute Perl commands in groff documents
+gperl \- execute Perl commands in
+.I groff
+documents
 .
 .
 .\" ====================================================================
diff --git a/contrib/gpinyin/gpinyin.1.man b/contrib/gpinyin/gpinyin.1.man
index 579b22b9d..e50d6ab61 100644
--- a/contrib/gpinyin/gpinyin.1.man
+++ b/contrib/gpinyin/gpinyin.1.man
@@ -1,7 +1,9 @@
 '\" t
 .TH gpinyin @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-gpinyin \- use Hanyu Pinyin Chinese in groff documents
+gpinyin \- use Hanyu Pinyin Chinese in
+.I groff
+documents
 .
 .
 .\" ====================================================================
diff --git a/contrib/grap2graph/grap2graph.1.man 
b/contrib/grap2graph/grap2graph.1.man
index 76b7cd06d..7aecc350c 100644
--- a/contrib/grap2graph/grap2graph.1.man
+++ b/contrib/grap2graph/grap2graph.1.man
@@ -1,6 +1,8 @@
 .TH grap2graph @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-grap2graph \- convert a GRAP diagram into a cropped image
+grap2graph \- convert a
+.I grap
+diagram into a cropped image
 .
 .
 .\" ====================================================================
diff --git a/contrib/hdtbl/groff_hdtbl.7.man b/contrib/hdtbl/groff_hdtbl.7.man
index b6120121c..315b01a28 100644
--- a/contrib/hdtbl/groff_hdtbl.7.man
+++ b/contrib/hdtbl/groff_hdtbl.7.man
@@ -1,6 +1,7 @@
 .TH groff_hdtbl @MAN7EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-groff_hdtbl \- Heidelberger table macros for GNU roff
+groff_hdtbl \- Heidelberger table macros for GNU
+.I roff
 .
 .
 .\" ====================================================================
diff --git a/contrib/mm/groff_mm.7.man b/contrib/mm/groff_mm.7.man
index a0b84d15f..3367c7d73 100644
--- a/contrib/mm/groff_mm.7.man
+++ b/contrib/mm/groff_mm.7.man
@@ -1,7 +1,8 @@
 '\" t
 .TH groff_mm @MAN7EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-groff_mm \- memorandum macros for GNU roff
+groff_mm \- memorandum macros for GNU
+.I roff
 .
 .
 .\" ====================================================================
diff --git a/contrib/mm/groff_mmse.7.man b/contrib/mm/groff_mmse.7.man
index 75eeeab58..4e75b621d 100644
--- a/contrib/mm/groff_mmse.7.man
+++ b/contrib/mm/groff_mmse.7.man
@@ -1,6 +1,7 @@
 .TH groff_mmse @MAN7EXT@ "@MDATE@" "groff @VERSION@"
 .SH Namn
-groff_mmse \- svenska \(rqmemorandum\(rq makro f\(:or GNU roff
+groff_mmse \- svenska \(rqmemorandum\(rq makro f\(:or GNU
+.I roff
 .
 .
 .\" Skrivet av J�rgen H�gg, Lund, Sverige
diff --git a/contrib/mm/mmroff.1.man b/contrib/mm/mmroff.1.man
index 17276acb3..c35b46e38 100644
--- a/contrib/mm/mmroff.1.man
+++ b/contrib/mm/mmroff.1.man
@@ -1,6 +1,8 @@
 .TH mmroff @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-mmroff \- cross-referencing front end for GNU roff mm macro package
+mmroff \- cross-referencing front end for GNU
+.I roff mm
+macro package
 .
 .
 .\" ====================================================================
diff --git a/contrib/pdfmark/pdfroff.1.man b/contrib/pdfmark/pdfroff.1.man
index b9e504e98..a49fa3909 100644
--- a/contrib/pdfmark/pdfroff.1.man
+++ b/contrib/pdfmark/pdfroff.1.man
@@ -1,6 +1,7 @@
 .TH pdfroff @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-pdfroff \- construct files in Portable Document Format using groff
+pdfroff \- construct files in Portable Document Format using
+.I groff
 .
 .
 .\" ====================================================================
diff --git a/contrib/pic2graph/pic2graph.1.man 
b/contrib/pic2graph/pic2graph.1.man
index 862b564fd..571a520f2 100644
--- a/contrib/pic2graph/pic2graph.1.man
+++ b/contrib/pic2graph/pic2graph.1.man
@@ -1,6 +1,8 @@
 .TH pic2graph @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-pic2graph \- convert a PIC diagram into a cropped image
+pic2graph \- convert a
+.I pic
+diagram into a cropped image
 .
 .
 .\" ====================================================================
diff --git a/man/groff_char.7.man b/man/groff_char.7.man
index ec4cd1f87..918dfebaf 100644
--- a/man/groff_char.7.man
+++ b/man/groff_char.7.man
@@ -1,7 +1,9 @@
 '\" t
 .TH groff_char @MAN7EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-groff_char \- GNU roff special character and glyph repertoire
+groff_char \- GNU
+.I roff
+special character and glyph repertoire
 .
 .
 .\" ====================================================================
diff --git a/man/groff_font.5.man b/man/groff_font.5.man
index 6252ed90a..d9570d9d9 100644
--- a/man/groff_font.5.man
+++ b/man/groff_font.5.man
@@ -1,6 +1,8 @@
 .TH groff_font @MAN5EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-groff_font \- GNU roff device and font description files
+groff_font \- GNU
+.I roff
+device and font description files
 .
 .
 .\" ====================================================================
diff --git a/man/groff_tmac.5.man b/man/groff_tmac.5.man
index 8def5aa26..ac6af88bf 100644
--- a/man/groff_tmac.5.man
+++ b/man/groff_tmac.5.man
@@ -1,6 +1,8 @@
 .TH groff_tmac @MAN5EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-groff_tmac \- macro files in the GNU roff typesetting system
+groff_tmac \- macro files in the GNU
+.I roff
+typesetting system
 .
 .
 .\" ====================================================================
diff --git a/src/devices/gropdf/gropdf.1.man b/src/devices/gropdf/gropdf.1.man
index 9d4632253..f58ff99a6 100644
--- a/src/devices/gropdf/gropdf.1.man
+++ b/src/devices/gropdf/gropdf.1.man
@@ -1,6 +1,8 @@
 .TH gropdf @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-gropdf \- groff output driver for Portable Document Format
+gropdf \-
+.I groff
+output driver for Portable Document Format
 .
 .
 .\" ====================================================================
diff --git a/src/devices/grops/grops.1.man b/src/devices/grops/grops.1.man
index 833eb0548..d0ce632cb 100644
--- a/src/devices/grops/grops.1.man
+++ b/src/devices/grops/grops.1.man
@@ -1,6 +1,8 @@
 .TH grops @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-grops \- groff output driver for PostScript
+grops \-
+.I groff
+output driver for PostScript
 .
 .
 .\" ====================================================================
diff --git a/src/devices/grotty/grotty.1.man b/src/devices/grotty/grotty.1.man
index d990aa63c..b7c429a88 100644
--- a/src/devices/grotty/grotty.1.man
+++ b/src/devices/grotty/grotty.1.man
@@ -1,6 +1,8 @@
 .TH grotty @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-grotty \- groff output driver for typewriter-like (terminal) devices
+grotty \-
+.I 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 1402950e2..5e4646d66 100644
--- a/src/devices/xditview/gxditview.1.man
+++ b/src/devices/xditview/gxditview.1.man
@@ -1,6 +1,8 @@
 .TH gxditview @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-gxditview \- display groff intermediate output files in X11
+gxditview \- display
+.I groff
+intermediate output files in X11
 .
 .
 .\" ====================================================================
diff --git a/src/preproc/grn/grn.1.man b/src/preproc/grn/grn.1.man
index 5ce1f0530..c8d3f9442 100644
--- a/src/preproc/grn/grn.1.man
+++ b/src/preproc/grn/grn.1.man
@@ -1,7 +1,9 @@
 '\" t
 .TH @g@grn @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-@g@grn \- embed gremlin images in groff documents
+@g@grn \- embed Gremlin images in
+.I groff
+documents
 .
 .
 .\" ====================================================================
diff --git a/src/preproc/preconv/preconv.1.man 
b/src/preproc/preconv/preconv.1.man
index 332b1f065..0e888c567 100644
--- a/src/preproc/preconv/preconv.1.man
+++ b/src/preproc/preconv/preconv.1.man
@@ -1,6 +1,7 @@
 .TH preconv @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-preconv \- prepare files for typesetting with groff
+preconv \- prepare files for typesetting with
+.I groff
 .
 .
 .\" ====================================================================
diff --git a/src/preproc/refer/refer.1.man b/src/preproc/refer/refer.1.man
index 137229cdc..e23b6f974 100644
--- a/src/preproc/refer/refer.1.man
+++ b/src/preproc/refer/refer.1.man
@@ -1,6 +1,7 @@
 .TH @g@refer @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-@g@refer \- process bibliographic references for groff
+@g@refer \- process bibliographic references for
+.I groff
 .
 .
 .\" ====================================================================
diff --git a/src/preproc/tbl/tbl.1.man b/src/preproc/tbl/tbl.1.man
index 9488b2b41..8910e4b73 100644
--- a/src/preproc/tbl/tbl.1.man
+++ b/src/preproc/tbl/tbl.1.man
@@ -1,7 +1,9 @@
 '\" t
 .TH @g@tbl @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-@g@tbl \- prepare tables for groff documents
+@g@tbl \- prepare tables for
+.I groff
+documents
 .
 .
 .\" ====================================================================
diff --git a/src/roff/groff/groff.1.man b/src/roff/groff/groff.1.man
index 9d3d26ec6..e90c1243b 100644
--- a/src/roff/groff/groff.1.man
+++ b/src/roff/groff/groff.1.man
@@ -1,6 +1,8 @@
 .TH groff @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-groff \- front end to the GNU roff document formatting system
+groff \- front end to the GNU
+.I roff
+document formatting system
 .
 .
 .\" ====================================================================
diff --git a/src/roff/nroff/nroff.1.man b/src/roff/nroff/nroff.1.man
index fc07d7b8b..97c6aace7 100644
--- a/src/roff/nroff/nroff.1.man
+++ b/src/roff/nroff/nroff.1.man
@@ -1,6 +1,8 @@
 .TH @g@nroff @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-@g@nroff \- format documents with groff for TTY (terminal) devices
+@g@nroff \- format documents with
+.I groff
+for TTY (terminal) devices
 .
 .
 .\" ====================================================================
diff --git a/src/roff/troff/troff.1.man b/src/roff/troff/troff.1.man
index 21aba90c7..84ca649cf 100644
--- a/src/roff/troff/troff.1.man
+++ b/src/roff/troff/troff.1.man
@@ -1,7 +1,9 @@
 '\" t
 .TH @g@troff @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-@g@troff \- GNU roff typesetter and document formatter
+@g@troff \- GNU
+.I roff
+typesetter and document formatter
 .
 .
 .\" ====================================================================
diff --git a/src/utils/addftinfo/addftinfo.1.man 
b/src/utils/addftinfo/addftinfo.1.man
index fb79b58bd..3cad99a3c 100644
--- a/src/utils/addftinfo/addftinfo.1.man
+++ b/src/utils/addftinfo/addftinfo.1.man
@@ -1,6 +1,9 @@
 .TH addftinfo @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-addftinfo \- add font metrics to troff fonts for use with groff
+addftinfo \- add font metrics to
+.I troff
+fonts for use with
+.I groff
 .
 .
 .\" ====================================================================
diff --git a/src/utils/grog/grog.1.man b/src/utils/grog/grog.1.man
index 8ca1d27dc..abd020604 100644
--- a/src/utils/grog/grog.1.man
+++ b/src/utils/grog/grog.1.man
@@ -1,7 +1,8 @@
 .TH grog @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-grog \- \(lqgroff guess\(rq\(eminfer the groff command a document \
-requires
+grog \- \(lqgroff guess\(rq\(eminfer the
+.I groff
+command a document requires
 .
 .
 .\" ====================================================================
diff --git a/src/utils/hpftodit/hpftodit.1.man 
b/src/utils/hpftodit/hpftodit.1.man
index ff14ec719..e645beb7b 100644
--- a/src/utils/hpftodit/hpftodit.1.man
+++ b/src/utils/hpftodit/hpftodit.1.man
@@ -1,6 +1,9 @@
 .TH hpftodit @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-hpftodit \- create font description files for use with groff \-Tlj4
+hpftodit \- create font description files for use with
+.I groff
+and
+.I grolj4
 .
 .
 .\" ====================================================================
diff --git a/src/utils/xtotroff/xtotroff.1.man 
b/src/utils/xtotroff/xtotroff.1.man
index 6b7b704cf..f598f4896 100644
--- a/src/utils/xtotroff/xtotroff.1.man
+++ b/src/utils/xtotroff/xtotroff.1.man
@@ -1,6 +1,8 @@
 .TH xtotroff @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-xtotroff \- convert X font metrics into groff font metrics
+xtotroff \- convert X font metrics into
+.I groff
+font metrics
 .
 .
 .\" ====================================================================
diff --git a/tmac/groff_man.7.man.in b/tmac/groff_man.7.man.in
index 2683c0fb7..5942d36ef 100644
--- a/tmac/groff_man.7.man.in
+++ b/tmac/groff_man.7.man.in
@@ -47,10 +47,13 @@ _ifstyle()dnl
 _endif()dnl
 .SH Name
 _ifnotstyle()dnl
-groff_man \- compose manual pages with GNU roff
+groff_man \- compose manual pages with GNU
+.I roff
 _endif()dnl
 _ifstyle()dnl
-groff_man_style \- GNU roff man page tutorial and style guide
+groff_man_style \- GNU
+.I roff
+man page tutorial and style guide
 _endif()dnl
 .
 .
diff --git a/tmac/groff_me.7.man b/tmac/groff_me.7.man
index 2392d18b5..8777157c3 100644
--- a/tmac/groff_me.7.man
+++ b/tmac/groff_me.7.man
@@ -1,8 +1,9 @@
 '\" t
 .TH groff_me @MAN7EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-groff_me \- \(lqme\(rq macro package for formatting documents with GNU \
-roff
+groff_me \- \(lqme\(rq macro package for formatting
+.I roff
+documents
 .
 .
 .\" ====================================================================
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index c0368bb79..4d385a630 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -1,7 +1,9 @@
 '\" t
 .TH groff_ms @MAN7EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-groff_ms \- GNU roff manuscript macro package for formatting documents
+groff_ms \- GNU
+.I roff
+manuscript macro package for formatting documents
 .
 .
 .\" ====================================================================
diff --git a/tmac/groff_trace.7.man b/tmac/groff_trace.7.man
index 5b4d17286..45fbed598 100644
--- a/tmac/groff_trace.7.man
+++ b/tmac/groff_trace.7.man
@@ -1,6 +1,8 @@
 .TH groff_trace @MAN7EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-groff_trace \- GNU roff macros for debugging groff documents
+groff_trace \- macros for debugging GNU
+.I roff
+documents
 .
 .
 .\" ====================================================================
diff --git a/tmac/groff_www.7.man b/tmac/groff_www.7.man
index fd38235ee..4b34d3eef 100644
--- a/tmac/groff_www.7.man
+++ b/tmac/groff_www.7.man
@@ -1,6 +1,8 @@
 .TH groff_www @MAN7EXT@ "@MDATE@" "groff @VERSION@"
 .SH Name
-groff_www \- GNU roff macros for authoring web pages
+groff_www \- GNU
+.I roff
+macros for authoring web pages
 .
 .
 .\" ====================================================================



reply via email to

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