gbranden pushed a commit to branch master
in repository groff.
commit 9b2925d1fce71d9a7444dd74e0345484821f5c4f
Author: G. Branden Robinson <[email protected]>
AuthorDate: Wed Aug 23 02:26:27 2023 -0500
roff(7): Fix style and markup nits.
* Coalesce one-sentence paragraph into its predecessor.
* Update poor man's keeps.
* Clarify DWB troff's origin.
* Use active voice more.
* Tighten wording.
* Set within-paragraph displays without paragraph spacing.
* Use groff-style special character escape sequences.
* Recast sentence to eliminate dangling colon.
---
man/roff.7.man | 76 +++++++++++++++++++++++++++-------------------------------
1 file changed, 35 insertions(+), 41 deletions(-)
diff --git a/man/roff.7.man b/man/roff.7.man
index fa4233794..d16f584ee 100644
--- a/man/roff.7.man
+++ b/man/roff.7.man
@@ -474,8 +474,6 @@ formatter scans the replacement for further requests,
macro calls,
and escape sequences.
.
-.
-.P
In
.I roff
systems,
@@ -1286,6 +1284,8 @@ preprocessor for formatting tables,
also by Lesk.
.
.
+.br
+.ne 3v
.P
For Unix Version\~7
(January 1979),
@@ -1437,15 +1437,16 @@ In 2007, \" TODO: verify
Caldera/SCO and Sun Microsystems,
having acquired rights to AT&T Documenter's Workbench (DWB)
.I troff
-(a descendant of the Bell Labs code),
+(a descendant of Bell Labs device-independent
+.IR troff ),
released it under a free but GPL-incompatible license.
.
.UR https://\:github\:.com/\:n\-t\-roff/\:DWB3.3
This implementation
.UE
-was made portable to modern POSIX systems,
-and adopted and enhanced first by Gunnar Ritter and then Carsten Kunze
-to produce
+was made portable to modern POSIX systems.
+.
+Gunnar Ritter and later Carsten Kunze then enhanced it to produce
.UR https://github.com/n-t-roff/heirloom-doctools
Heirloom Doctools
.I troff
@@ -1529,8 +1530,7 @@ taken as the input
to the next,
without passing through secondary storage.
.
-(On non-Unix systems,
-pipelines may have to be simulated with temporary files.)
+(Non-Unix systems may simulate pipelines with temporary files.)
.
.
.RS
@@ -2280,14 +2280,14 @@ It is also possible to have the mode automatically
selected when a
file is loaded into the editor.
.
.
-.IP \(bu 3n
-The most general method is to include file-local variables at the end of
+.IP \[bu] 3n
+The most general approach includes file-local variables at the end of
the file;
we can also configure the fill column this way.
.
.
.RS
-.IP
+.RS
.EX
\&.\[rs]" Local Variables:
\&.\[rs]" fill\-column: 72
@@ -2295,40 +2295,40 @@ we can also configure the fill column this way.
\&.\[rs]" End:
.EE
.RE
+.RE
.
-.IP \(bu
+.
+.IP \[bu]
Certain file name extensions,
-such as those commonly used by man pages,
-trigger the automatic activation of the
+like those often
+used by man pages,
+activate
.I nroff
-mode.
+mode automatically.
.
.
.br
.ne 3v
-.IP \(bu
-Technically,
-having the sequence
-.
+.IP \[bu]
+Loading a file with the sequence
.
.RS
-.IP
+.RS
.EX
\&.\[rs]" \%\-*\- nroff \-*\-
.EE
.RE
.
-.
-.IP
-in the first line of a file will cause Emacs to enter the
+in its first line into an Emacs buffer causes the editor to enter its
.I nroff
-major mode when it is loaded into the buffer.
+major mode.
.
Unfortunately,
some implementations of the
.MR man 1
program are confused by this practice,
so we discourage it.
+.RE
.
.
.\" ====================================================================
@@ -2367,7 +2367,7 @@ and \[lq]syntax\[rq].
Then put the following at the end of your
.I roff
files,
-after any Emacs configuration:
+after any Emacs configuration.
.\" ...because Emacs pattern-matches against 3000 bytes from the end of
.\" the buffer [or until hitting a 0x0C (FF, form-feed control)] for
.\" "Local Variables:", but Vim only checks as many lines as its
@@ -2533,12 +2533,8 @@ and can be found at Ralph Corderoy's site
(see above)
or via Internet search.
.
-.
-.P
-Of foremost significance are two mentioned in section \[lq]History\[rq]
-above,
-describing the language and its device-independent implementation,
-respectively.
+Of foremost significance are those describing the language and its
+device-independent implementation.
.
.
.P
@@ -2570,32 +2566,30 @@ GitHub repository
.SS "Manual pages"
.\" ====================================================================
.
-As a system of multiple components,
-a
+A componentized system like
.I roff
-system potentially has many man pages,
+potentially has many man pages,
each describing an aspect of it.
.
Unfortunately,
-there is no consistent naming scheme for these pages among the different
-.I roff
+there is no consistent naming scheme for these pages among the various
implementations.
.
.
.P
-For GNU
+In GNU
.IR roff ,
the
.MR groff @MAN1EXT@
man page enumerates all man pages distributed with the system,
and individual pages frequently refer to external resources as well as
-manuals distributed with
-.I groff
-on a variety of topics.
+manuals on a variety of topics
+distributed with
+.IR groff .
.
.
.P
-With other
+In other
.IR roff s,
you are on your own,
but
_______________________________________________
Groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
