foxygit / doom Log in
commit bb27d57ff711d9363d11d7f7692d69e790f8f04a
Author:     G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sat Sep 14 02:51:21 2024 -0500
Commit:     Fabian Greffrath <fabian@greffrath.com>
CommitDate: Wed Jul 2 08:24:12 2025 +0200

    man/{server,setup}.template: Adjust formatting

    1.  Set program executable names in italics, not bold.
    2.  Break input lines at sentence endings.
    3.  Protect lengthy literal from hyphenation.

    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.

    groff_man_style(7):
         \%        Control hyphenation.  The location of this escape
                   sequence within a word marks a hyphenation point,
                   supplementing groff’s automatic hyphenation patterns.  At
                   the beginning of a word, it suppresses any hyphenation
                   breaks within except those specified with \%.
---
 man/server.template | 12 +++++++-----
 man/setup.template  |  4 ++--
 2 files changed, 9 insertions(+), 7 deletions(-)

diff --git a/man/server.template b/man/server.template
index 6bdbf627..437dc2f0 100644
--- a/man/server.template
+++ b/man/server.template
@@ -9,11 +9,13 @@
 @PACKAGE_NAME@ is a modern doom engine designed to behave
 as similar to the original doom game as is possible.
 .PP
-.B @PROGRAM_SPREFIX@\-server
-is a dedicated server for @PACKAGE_SHORTNAME@. It is equivalent to
-running
-.B @PROGRAM_SPREFIX@\-doom
-with the "\-dedicated" option.
+.I \%@PROGRAM_SPREFIX@\-server
+is a dedicated server for @PACKAGE_SHORTNAME@.
+It is equivalent to running
+\fB@PROGRAM_SPREFIX@-doom\fR(6)
+with the
+.B \%\-dedicated
+option.
 .PP
 Game options are not specified to the server, which merely acts to
 retransmit data between players in the game; parameters for the
diff --git a/man/setup.template b/man/setup.template
index f1ba627b..909c4338 100644
--- a/man/setup.template
+++ b/man/setup.template
@@ -9,12 +9,12 @@
 @PACKAGE_SHORTNAME@ @GAME_UPPER@ is a modern @GAME_UPPER@ engine designed to behave
 as similar to the original @GAME_UPPER@ game as is possible.
 .PP
-.B @PROGRAM_SPREFIX@\-@GAME@-setup
+.I @PROGRAM_SPREFIX@\-@GAME@-setup
 is a tool for configuring @PACKAGE_SHORTNAME@ @GAME_UPPER@. It provides a menu\-based
 interface for the display, joystick, keyboard, mouse, sound and
 compatibility settings.
 .PP
-.B @PROGRAM_SPREFIX@\-@GAME@-setup
+.I @PROGRAM_SPREFIX@\-@GAME@-setup
 can also be used to start and join network games.
 .PP
 .SH OPTIONS