[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 04/12: [man pages]: Use sentence case in section heads.
|
From: |
G. Branden Robinson |
|
Subject: |
[groff] 04/12: [man pages]: Use sentence case in section heads. |
|
Date: |
Thu, 6 May 2021 05:02:24 -0400 (EDT) |
gbranden pushed a commit to branch master
in repository groff.
commit f879fa88499b092eaf0720ba8e291497d55799f3
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Thu May 6 13:32:53 2021 +1000
[man pages]: Use sentence case in section heads.
...as discussed on the groff development list[1]. Thanks to Ingo
Schwarze, John Gardner, and Peter Schaffter for the discussion.
Also simplify some section headings.
* "The Language" -> Language
* "Perl Parts" -> "Perl regions"[2]
* "groff Macro Packages" -> "Macro packages" (the context is obvious)
* "Full packages" -> "Full-service packages" (also used in groff.texi)
* "Simple Examples" -> "Examples" (after Linux man-pages 5.07)
And drop the entire subsection of gperl(1) which seems to be saying that
the standard error stream behaves normally. This is news?!
[1] https://lists.gnu.org/archive/html/groff/2020-01/msg00063.html
[2] The previous author of this man page shares with the Ada language
standardization committee an unrelenting preoccupation with the word
"part", which always puts me in mind of a Sol Star/Seth Bullock
colloquy.
"He looked pale to me."
"What if he was? Let's say he was. Will you shut up about it? What is
my part and your part? What part of my part is your part? Is my foot
your knee? What about your ear? What the **** is that?"
---
contrib/chem/chem.1.man | 2 +-
contrib/glilypond/glilypond.1.man | 6 +++---
contrib/gperl/gperl.1.man | 15 +--------------
contrib/groff_filenames/groff_filenames.5.man | 2 +-
contrib/hdtbl/groff_hdtbl.7.man | 4 ++--
contrib/mm/groff_mmse.7.man | 2 +-
contrib/mom/groff_mom.7.man | 6 +++---
man/groff.7.man | 6 +++---
man/groff_diff.7.man | 4 ++--
man/groff_out.5.man | 4 ++--
man/groff_tmac.5.man | 4 ++--
src/devices/grolbp/grolbp.1.man | 6 +++---
src/devices/gropdf/gropdf.1.man | 2 +-
src/devices/grops/grops.1.man | 4 ++--
src/preproc/eqn/eqn.1.man | 2 +-
src/preproc/tbl/tbl.1.man | 2 +-
src/roff/groff/groff.1.man | 2 +-
tmac/groff_ms.7.man | 2 +-
tmac/groff_www.7.man | 2 +-
19 files changed, 32 insertions(+), 45 deletions(-)
diff --git a/contrib/chem/chem.1.man b/contrib/chem/chem.1.man
index 84aaaa3..1c40f5b 100644
--- a/contrib/chem/chem.1.man
+++ b/contrib/chem/chem.1.man
@@ -209,7 +209,7 @@ for the activation of
.
.
.\" ====================================================================
-.SH "The Language"
+.SH Language
.\" ====================================================================
.
The
diff --git a/contrib/glilypond/glilypond.1.man
b/contrib/glilypond/glilypond.1.man
index 8b6cb87..c519838 100644
--- a/contrib/glilypond/glilypond.1.man
+++ b/contrib/glilypond/glilypond.1.man
@@ -170,7 +170,7 @@ does not work.
.
.
.\" ====================================================================
-.SH "Option Overview"
+.SH "Option overview"
.\" ====================================================================
.
.
@@ -559,7 +559,7 @@ files.
.
.
.\" ====================================================================
-.SH "Generated Files"
+.SH "Generated files"
.\" ====================================================================
.
By the transformation process of
@@ -632,7 +632,7 @@ are needed for the display which can take a long time.
.
.
.\" ====================================================================
-.SH "Transformation Processes for Generating EPS Files"
+.SH "Transformation processes for generating EPS files"
.\" ====================================================================
.
.\" ====================================================================
diff --git a/contrib/gperl/gperl.1.man b/contrib/gperl/gperl.1.man
index 72a2484..955413d 100644
--- a/contrib/gperl/gperl.1.man
+++ b/contrib/gperl/gperl.1.man
@@ -102,7 +102,7 @@ all exit afterward.
.
.
.\" ====================================================================
-.SH "Perl Parts"
+.SH "Perl regions"
.\" ====================================================================
.
.I Perl
@@ -357,19 +357,6 @@ by
.
.
.\" ====================================================================
-.SS "Printing towards STDERR is without storage"
-.\" ====================================================================
-.
-The printing towards
-.IR STDERR ,
-(standard error) works as usual.
-.
-All error information goes to the real normal
-.IR "standard error" ,
-without other automatic storage.
-.
-.
-.\" ====================================================================
.SH Example
.\" ====================================================================
.
diff --git a/contrib/groff_filenames/groff_filenames.5.man
b/contrib/groff_filenames/groff_filenames.5.man
index 1c3025f..1e2808d 100644
--- a/contrib/groff_filenames/groff_filenames.5.man
+++ b/contrib/groff_filenames/groff_filenames.5.man
@@ -92,7 +92,7 @@ and only comment the structure
.
.
.\" ====================================================================
-.SH "Man Pages"
+.SH "Man pages"
.\" ====================================================================
.
The
diff --git a/contrib/hdtbl/groff_hdtbl.7.man b/contrib/hdtbl/groff_hdtbl.7.man
index 7626241..be11c3a 100644
--- a/contrib/hdtbl/groff_hdtbl.7.man
+++ b/contrib/hdtbl/groff_hdtbl.7.man
@@ -489,7 +489,7 @@ enclosed in double quotes.
.
.
.\" ====================================================================
-.SH "Macros and Arguments"
+.SH "Macros and arguments"
.\" ====================================================================
.
The order of macro calls and other tokens follows the HTML model.
@@ -1243,7 +1243,7 @@ macro package.
.
.
.\" ====================================================================
-.SH "Bugs and Suggestions"
+.SH "Bugs and suggestions"
.\" ====================================================================
.
Please send your comments to the
diff --git a/contrib/mm/groff_mmse.7.man b/contrib/mm/groff_mmse.7.man
index 4c0068e..eb9d9b9 100644
--- a/contrib/mm/groff_mmse.7.man
+++ b/contrib/mm/groff_mmse.7.man
@@ -136,7 +136,7 @@ D
.
.
.\" ====================================================================
-.SH "Skrivet Av"
+.SH "Skrivet av"
.\" ====================================================================
.
J�rgen H�gg, Lund, Sweden <Jorgen.Hagg@axis.se>
diff --git a/contrib/mom/groff_mom.7.man b/contrib/mom/groff_mom.7.man
index 63f731c..63551cf 100644
--- a/contrib/mom/groff_mom.7.man
+++ b/contrib/mom/groff_mom.7.man
@@ -208,7 +208,7 @@ usage.
.
.
.\" ====================================================================
-.SH "Documentation in Alphabetical Order"
+.SH "Documentation in alphabetical order"
.\" ====================================================================
.
.
@@ -250,7 +250,7 @@ arrangement.
.
.
.\" ====================================================================
-.SH "Quick Reference"
+.SH "Quick reference"
.\" ====================================================================
.
.\" ====================================================================
@@ -613,7 +613,7 @@ set the minimum word space size
.
.
.\" ====================================================================
-.SH "Documentation of Details"
+.SH "Documentation of details"
.\" ====================================================================
.
.\" ====================================================================
diff --git a/man/groff.7.man b/man/groff.7.man
index 3b99a04..96be62e 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -567,7 +567,7 @@ Texinfo manual.
.
.
.\" ====================================================================
-.SH "Control Characters"
+.SH "Control characters"
.\" ====================================================================
.
There is a small set of characters that have a special controlling
@@ -750,7 +750,7 @@ There is a sophisticated interface for handling tab
positions.
.
.
.\" ====================================================================
-.SH "Numerical Expressions"
+.SH "Numerical expressions"
.\" ====================================================================
.
A
@@ -2962,7 +2962,7 @@ yet.
.
.
.\" ====================================================================
-.SH "Escape Sequences"
+.SH "Escape sequences"
.\" ====================================================================
.
Whereas requests must occur on control lines,
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index dc8a79d..25364ac 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -4115,7 +4115,7 @@ Example:
.
.
.\" ====================================================================
-.SH "Intermediate Output Format"
+.SH "Intermediate output format"
.\" ====================================================================
.
The output format of
@@ -4525,7 +4525,7 @@ to the standard error stream.
.
.
.\" ====================================================================
-.SH "Implementation Differences"
+.SH "Implementation differences"
.\" ====================================================================
.
.I groff
diff --git a/man/groff_out.5.man b/man/groff_out.5.man
index 6af0431..302171a 100644
--- a/man/groff_out.5.man
+++ b/man/groff_out.5.man
@@ -196,7 +196,7 @@ still supported, but not used any longer by
.
.
.\" ====================================================================
-.SH "Language Concepts"
+.SH "Language concepts"
.\" ====================================================================
.
During the run of
@@ -448,7 +448,7 @@ is done relative to the current location within this page.
.
.
.\" ====================================================================
-.SH "Command Reference"
+.SH "Command reference"
.\" ====================================================================
.
This section describes all
diff --git a/man/groff_tmac.5.man b/man/groff_tmac.5.man
index 68f0121..d5c7728 100644
--- a/man/groff_tmac.5.man
+++ b/man/groff_tmac.5.man
@@ -56,7 +56,7 @@ directories.
.
.
.\" ====================================================================
-.SH "groff Macro Packages"
+.SH "Macro packages"
.\" ====================================================================
.
.I groff
@@ -127,7 +127,7 @@ Multiple man pages (in either format) can be handled.
.
.
.\" ====================================================================
-.SS "Full packages"
+.SS "Full-service packages"
.\" ====================================================================
.
The packages in this section provide a complete set of macros for
diff --git a/src/devices/grolbp/grolbp.1.man b/src/devices/grolbp/grolbp.1.man
index 1ef5946..176da05 100644
--- a/src/devices/grolbp/grolbp.1.man
+++ b/src/devices/grolbp/grolbp.1.man
@@ -225,7 +225,7 @@ Elite | ER | EB | EI |
.
.
.\" ====================================================================
-.SH "Paper Sizes"
+.SH "Paper sizes"
.\" ====================================================================
.
The paper size can be set in the
@@ -275,7 +275,7 @@ file or the command line, a default size of A4 is used.
.
.
.\" ====================================================================
-.SH "Page Orientation"
+.SH "Page orientation"
.\" ====================================================================
.
As with the page size, the orientation of the printed page
@@ -323,7 +323,7 @@ option to force the pages to be printed in landscape.
.
.
.\" ====================================================================
-.SH "Font File Format"
+.SH "Font file format"
.\" ====================================================================
.
In addition to the usual commands described in
diff --git a/src/devices/gropdf/gropdf.1.man b/src/devices/gropdf/gropdf.1.man
index 6466a35..c58530b 100644
--- a/src/devices/gropdf/gropdf.1.man
+++ b/src/devices/gropdf/gropdf.1.man
@@ -1201,7 +1201,7 @@ does not support any other fonts except Adobe Type 1 (PFA
or PFB).
.
.
.\" ====================================================================
-.SH "Font Installation"
+.SH "Font installation"
.\" ====================================================================
.
This section gives a summary of the above explanations; it can serve
diff --git a/src/devices/grops/grops.1.man b/src/devices/grops/grops.1.man
index 186e6b4..92491af 100644
--- a/src/devices/grops/grops.1.man
+++ b/src/devices/grops/grops.1.man
@@ -1282,7 +1282,7 @@ option.
.
.
.\" ====================================================================
-.SH "Font Installation"
+.SH "Font installation"
.\" ====================================================================
.
This section summarizes the above explanations; it can serve as a
@@ -1416,7 +1416,7 @@ thus the following line should be added to
.
.
.\" ====================================================================
-.SH "Old Fonts"
+.SH "Old fonts"
.\" ====================================================================
.
groff versions 1.19.2 and earlier contain a slightly different set of
diff --git a/src/preproc/eqn/eqn.1.man b/src/preproc/eqn/eqn.1.man
index db672e2..0c5a8c2 100644
--- a/src/preproc/eqn/eqn.1.man
+++ b/src/preproc/eqn/eqn.1.man
@@ -1452,7 +1452,7 @@ Initialization file.
.
.
.\" ====================================================================
-.SH "MathML Mode Limitations"
+.SH "MathML mode limitations"
.\" ====================================================================
.
MathML is designed on the assumption that it cannot know the exact
diff --git a/src/preproc/tbl/tbl.1.man b/src/preproc/tbl/tbl.1.man
index c0952db..75042a6 100644
--- a/src/preproc/tbl/tbl.1.man
+++ b/src/preproc/tbl/tbl.1.man
@@ -1226,7 +1226,7 @@ note that such columns usually don't work with terminal
devices.
.
.
.\" ====================================================================
-.SH "Simple Examples"
+.SH Examples
.\" ====================================================================
.
A simple table definition follows.
diff --git a/src/roff/groff/groff.1.man b/src/roff/groff/groff.1.man
index 6cdd1b5..6379ab0 100644
--- a/src/roff/groff/groff.1.man
+++ b/src/roff/groff/groff.1.man
@@ -1701,7 +1701,7 @@ is not available on \f[CR]ASCII\f[] based operating
systems.
.
.
.\" ====================================================================
-.SH "Installation Directories"
+.SH "Installation directories"
.\" ====================================================================
.
.I groff
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index f8b37de..ee82403 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -1921,7 +1921,7 @@ produces an n with a tilde over it.
.
.
.\" ====================================================================
-.SH "Naming Conventions"
+.SH "Naming conventions"
.\" ====================================================================
.
The following conventions are used for names of macros,
diff --git a/tmac/groff_www.7.man b/tmac/groff_www.7.man
index 608af47..8c572d9 100644
--- a/tmac/groff_www.7.man
+++ b/tmac/groff_www.7.man
@@ -682,7 +682,7 @@ but these values will be superseded by a user call to
LINKSTYLE.
.
.
.\" ====================================================================
-.SH "Section Heading Links"
+.SH "Section heading links"
.\" ====================================================================
.
By default
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 04/12: [man pages]: Use sentence case in section heads.,
G. Branden Robinson <=