commit 5584e66c5df3c8cd6e81759900d5858ae6762eb7
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sat Sep 14 02:18:29 2024 -0500
Commit: Fabian Greffrath <fabian@greffrath.com>
CommitDate: Wed Jul 2 08:24:12 2025 +0200
man/*.template: Parallelize "FILES" sections
1. Set file names in italics, not bold, as suggested in
groff_man_style(7) and for consistency with "default.cfg.template"
and "extra.cfg.template".
2. Break input lines at sentence endings.
groff_man_style(7):
Use italics for file and path names, for environment
variables, for C data types, for enumeration or preprocessor
constants in C, for variant (user‐replaceable) portions of
syntax synopses, for the first occurrence (only) of a
technical concept being introduced, for names of journals
and of literary works longer than an article, and anywhere a
parameter requiring replacement by the user is encountered.
...
roff(7):
A roff formatter attempts to detect boundaries between sentences,
and supplies additional inter‐sentence space between them. It
flags certain characters (normally “!”, “?”, and “.”) as
potentially ending a sentence. When the formatter encounters one
of these end‐of‐sentence characters at the end of an input line, or
one of them is followed by two (unescaped) spaces on the same input
line, it appends an inter‐word space followed by an inter‐sentence
space in the output. ...
Input conventions
Since troff fills text automatically, it is common practice in the
roff language to avoid visual composition of text in input files:
the esthetic appeal of the formatted output is what matters.
Therefore, roff input should be arranged such that it is easy for
authors and maintainers to compose and develop the document,
understand the syntax of roff requests, macro calls, and
preprocessor languages used, and predict the behavior of the
formatter. Several traditions have accrued in service of these
goals.
• Follow sentence endings in the input with newlines to ease their
recognition. It is frequently convenient to end text lines
after colons and semicolons as well, as these typically precede
independent clauses. Consider doing so after commas; they often
occur in lists that become easy to scan when itemized by line,
or constitute supplements to the sentence that are added,
deleted, or updated to clarify it. Parenthetical and quoted
phrases are also good candidates for placement on text lines by
themselves.
---
man/doom.template | 10 ++++++----
man/heretic.template | 10 ++++++----
man/hexen.template | 12 +++++++-----
man/strife.template | 12 +++++++-----
4 files changed, 26 insertions(+), 18 deletions(-)
diff --git a/man/doom.template b/man/doom.template
index dd3b31a4..f7ab80e8 100644
--- a/man/doom.template
+++ b/man/doom.template
@@ -19,12 +19,14 @@ This section describes environment variables that control
@include environ.man
.SH FILES
.TP
-\fB$HOME/.local/share/@PROGRAM_SPREFIX@\-doom/default.cfg\fR
-The main configuration file for @PACKAGE_NAME@. See \fBdefault.cfg\fR(5).
+.I $HOME/.local/share/@PROGRAM_SPREFIX@\-doom/default.cfg
+The main configuration file for @PACKAGE_NAME@.
+See \fBdefault.cfg\fR(5).
.TP
-\fB$HOME/.local/share/@PROGRAM_SPREFIX@\-doom/@PROGRAM_SPREFIX@\-doom.cfg\fR
+.I $HOME/.local/share/@PROGRAM_SPREFIX@\-doom/@PROGRAM_SPREFIX@\-doom.cfg
Extra configuration values that are specific to @PACKAGE_NAME@ and not
-present in Vanilla Doom. See \fB@PROGRAM_SPREFIX@\-doom.cfg\fR(5).
+present in Vanilla Doom.
+See \fB@PROGRAM_SPREFIX@\-doom.cfg\fR(5).
.SH SEE ALSO
\fB@PROGRAM_SPREFIX@\-server\fR(6),
\fB@PROGRAM_SPREFIX@\-setup\fR(6),
diff --git a/man/heretic.template b/man/heretic.template
index 31e63f37..71098822 100644
--- a/man/heretic.template
+++ b/man/heretic.template
@@ -19,12 +19,14 @@ This section describes environment variables that control
@include environ.man
.SH FILES
.TP
-\fB$HOME/.local/share/@PROGRAM_SPREFIX@\-doom/heretic.cfg\fR
-The main configuration file for @PACKAGE_SHORTNAME@ Heretic. See \fBheretic.cfg\fR(5).
+.I $HOME/.local/share/@PROGRAM_SPREFIX@\-doom/heretic.cfg
+The main configuration file for @PACKAGE_SHORTNAME@ Heretic.
+See \fBheretic.cfg\fR(5).
.TP
-\fB$HOME/.local/share/@PROGRAM_SPREFIX@\-doom/@PROGRAM_SPREFIX@\-heretic.cfg\fR
+.I $HOME/.local/share/@PROGRAM_SPREFIX@\-doom/@PROGRAM_SPREFIX@\-heretic.cfg
Extra configuration values that are specific to @PACKAGE_SHORTNAME@ Heretic and not
-present in Vanilla Heretic. See \fB@PROGRAM_SPREFIX@\-heretic.cfg\fR(5).
+present in Vanilla Heretic.
+See \fB@PROGRAM_SPREFIX@\-heretic.cfg\fR(5).
.SH SEE ALSO
\fB@PROGRAM_SPREFIX@\-doom\fR(6),
\fB@PROGRAM_SPREFIX@\-hexen\fR(6),
diff --git a/man/hexen.template b/man/hexen.template
index de4234a4..dc35715e 100644
--- a/man/hexen.template
+++ b/man/hexen.template
@@ -19,12 +19,14 @@ This section describes environment variables that control
@include environ.man
.SH FILES
.TP
-\fB$HOME/.local/share/@PROGRAM_SPREFIX@\-doom/hexen.cfg\fR
-The main configuration file for @PACKAGE_SHORTNAME@ Hexen. See \fBhexen.cfg\fR(5).
+.I $HOME/.local/share/@PROGRAM_SPREFIX@\-doom/hexen.cfg
+The main configuration file for @PACKAGE_SHORTNAME@ Hexen.
+See \fBhexen.cfg\fR(5).
.TP
-\fB$HOME/.local/share/@PROGRAM_SPREFIX@\-doom/@PROGRAM_SPREFIX@\-hexen.cfg\fR
-Extra configuration values that are specific to @PACKAGE_SHORTNAME@ Hexen and not
-present in Vanilla Hexen. See \fB@PROGRAM_SPREFIX@\-hexen.cfg\fR(5).
+.I $HOME/.local/share/@PROGRAM_SPREFIX@\-doom/@PROGRAM_SPREFIX@\-hexen.cfg
+Extra configuration values that are specific to @PACKAGE_SHORTNAME@
+Hexen and not present in Vanilla Hexen.
+See \fB@PROGRAM_SPREFIX@\-hexen.cfg\fR(5).
.SH SEE ALSO
\fB@PROGRAM_SPREFIX@\-doom\fR(6),
\fB@PROGRAM_SPREFIX@\-heretic\fR(6),
diff --git a/man/strife.template b/man/strife.template
index 6f983174..f1a2bb83 100644
--- a/man/strife.template
+++ b/man/strife.template
@@ -21,12 +21,14 @@ This section describes environment variables that control
@include environ.man
.SH FILES
.TP
-\fB$HOME/.local/share/@PROGRAM_SPREFIX@\-doom/strife.cfg\fR
-The main configuration file for @PACKAGE_SHORTNAME@ Strife. See \fBstrife.cfg\fR(5).
+.I $HOME/.local/share/@PROGRAM_SPREFIX@\-doom/strife.cfg
+The main configuration file for @PACKAGE_SHORTNAME@ Strife.
+See \fBstrife.cfg\fR(5).
.TP
-\fB$HOME/.local/share/@PROGRAM_SPREFIX@\-doom/@PROGRAM_SPREFIX@\-strife.cfg\fR
-Extra configuration values that are specific to @PACKAGE_SHORTNAME@ Strife and not
-present in Vanilla Strife. See \fB@PROGRAM_SPREFIX@\-strife.cfg\fR(5).
+.I $HOME/.local/share/@PROGRAM_SPREFIX@\-doom/@PROGRAM_SPREFIX@\-strife.cfg
+Extra configuration values that are specific to @PACKAGE_SHORTNAME@
+Strife and not present in Vanilla Strife.
+See \fB@PROGRAM_SPREFIX@\-strife.cfg\fR(5).
.SH SEE ALSO
\fB@PROGRAM_SPREFIX@\-doom\fR(6),
\fB@PROGRAM_SPREFIX@\-server\fR(6),