doc/nethack.6: Revise scoreboard mode synopsis

Set it as a hanging paragraph, as is idiomatic for Unix command
synopses.  Tighten formatting: set synopsis syntax characters adjacently
to operands.  Since viewing the scoreboard is a separate mode of
operation, arrange first the options that select this mode.[1]  Also
drop explicit line breaks, permitting synopsis to exercise the
configured line length of the selected output device.

Before and after, as rendered with Solaris 10 troff:

-     nethack [ -d|--directory directory ] -s|--scores [ -v ]
-     [ -p profession ] [ -r race ] [ player-name ...]
+     nethack {-s|--scores} [-d|--directory directory] [-v]
+          [-p profession] [-r race] [player-name ...]

Before and after, as rendered with groff, mandoc, and Heirloom Doctools
troff:

-     nethack [ -d|--directory directory ] -s|--scores [ -v ]
-     [ -p profession ] [ -r race ] [ player‐name ...]
+     nethack {-s|--scores} [-d|--directory directory] [-v] [-p profession]
+            [-r race] [player‐name ...]

Not shown: Literal text is in bold, and option arguments in italics.

[1] See, for example,
<https://pubs.opengroup.org/onlinepubs/9799919799.2024edition/utilities/compress.html>.
This commit is contained in:
G. Branden Robinson
2026-05-06 04:53:12 -05:00
parent 2011f8b4c1
commit e4476516cd
+10 -20
View File
@@ -128,27 +128,17 @@ Also
| |
.BR \-W | \-Wiz .BR \-W | \-Wiz
] ]
.PP .HP
.B nethack .B nethack
[ .RB { \-s | \-\-scores }
.BR \-d | \-\-directory .RB [ \-d | \-\-directory\*_\c
.I directory .IR directory ]
] .RB [ \-v ]
.BR \-s | \-\-scores .RB [ \-p\*_\c
[ .IR profession ]
.B \-v .RB [ \-r\*_\c
] .IR race ]
.br .RI [ player-name\*_\c
[
.B \-p
.I profession
]
[
.B \-r
.I race
]
[
.I player-name\*_\c
\&.\|.\|.] \&.\|.\|.]
.PP .PP
.B nethack .B nethack