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

    man/server.template: Improve option formatting

    1.  Favor man(7) font selection macros over roff(7) font selection
        escape sequences.
    2.  Break input lines at sentence endings.

    groff_man_style(7):
                   As long as at most two styles are needed in a word, style
                   macros like .B and .BI usually result in more readable
                   roff source than \f escape sequences do.

    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/server.template | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

diff --git a/man/server.template b/man/server.template
index 62954128..7ce2a3b3 100644
--- a/man/server.template
+++ b/man/server.template
@@ -23,18 +23,21 @@ game should be specified by the first player to connect to the server,
 who is designated the controlling player.
 .SH OPTIONS
 .TP
-\fB-ignoreversion\fR
-Ignore version mismatches between the server and the client. Using this
-option may cause game desyncs to occur, or differences in protocol may
-mean the netgame will simply not function at all.
+.B \-ignoreversion
+Ignore version mismatches between the server and the client.
+Using this option may cause game desyncs to occur,
+or differences in protocol may mean the netgame will simply not function
+at all.
 .TP
-\fB-port <n>\fR
-Use the specified UDP port for communications, instead of the default (2342).
+.BI \-port\~ n
+Use UDP port
+.I n
+for communications instead of the default (2342).
 .TP
-\fB-privateserver\fR
+.B \-privateserver
 Don't register with the global master server.
 .TP
-\fB-servername <name>\fR
+.BI \-servername\~ name
 Specify a name for the server.
 .SH SEE ALSO
 \fB@PROGRAM_SPREFIX@-doom\fR(6),