doc/*.6: Fix unescaped hyphens

groff_man_style(7):
     •  Option dashes are specified with the \- escape sequence; this is
        an important practice to make them clearly visible and to
        facilitate copy‐and‐paste from the rendered man page to a shell
        prompt or text file.
...
     \-     Minus sign.  \- produces the basic Latin hyphen‐minus
            (U+002D) specifying Unix command‐line options and frequently
            used in file names.  “-” is a hyphen in roff; some output
            devices format it as U+2010 (hyphen).
This commit is contained in:
G. Branden Robinson
2026-05-06 04:39:57 -05:00
parent 2566ddefdf
commit 9508a133d0
3 changed files with 45 additions and 45 deletions
+1 -1
View File
@@ -144,7 +144,7 @@ Kenneth Lorber
Not a good Not a good
.I tar .I tar
emulation; emulation;
.B - .B \-
does not mean stdin or stdout. does not mean stdin or stdout.
.IP \(bu .IP \(bu
Should include an optional compression facility. Should include an optional compression facility.
+43 -43
View File
@@ -21,30 +21,30 @@ makedefs \- NetHack miscellaneous build-time functions
.SH SYNOPSIS .SH SYNOPSIS
.B makedefs .B makedefs
{ {
.B -o .B \-o
| |
.B -d .B \-d
| |
.B -e .B \-e
| |
.B -m .B \-m
| |
.B -v .B \-v
| |
.B -p .B \-p
| |
.B -q .B \-q
| |
.B -r .B \-r
| |
.B -h .B \-h
} }
.P .P
.B makedefs --input .B makedefs \-\-input
.I file .I file
.B --output .B \-\-output
.I file .I file
.BI -- command .BI \-\- command
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
.B Makedefs .B Makedefs
@@ -60,39 +60,39 @@ the files operated on are determined when
is compiled. is compiled.
When invoked with a long option, When invoked with a long option,
the the
.B --input .B \-\-input
and and
.B --output .B \-\-output
options are used to specify the files for the options are used to specify the files for the
.BI -- command. .BI \-\- command.
Each command is only available in one of the two formats. Each command is only available in one of the two formats.
.SH SHORT COMMANDS .SH SHORT COMMANDS
Upper and lower case are both accepted for the short commands. Upper and lower case are both accepted for the short commands.
.TP .TP
.B -o .B \-o
Generate Generate
.I onames.h. .I onames.h.
.br .br
.TP .TP
.B -d .B \-d
Generate Generate
.I data.base. .I data.base.
.br .br
.TP .TP
.B -e .B \-e
Generate Generate
.I dungeon.pdf. .I dungeon.pdf.
The input file The input file
.I dungeon.def .I dungeon.def
is passed through the is passed through the
same logic as that used by the same logic as that used by the
.B --grep .B \-\-grep
command; see the command; see the
.B MDGREP FUNCTIONS .B MDGREP FUNCTIONS
section below for details. section below for details.
.br .br
.TP .TP
.B -m .B \-m
Generate Generate
.I date.h .I date.h
and and
@@ -108,78 +108,78 @@ info and include related preprocessor #defines in
file. file.
.br .br
.TP .TP
.B -p .B \-p
Generate Generate
.I pm.h .I pm.h
.br .br
.TP .TP
.B -q .B \-q
Generate the Generate the
.I rumors .I rumors
file. file.
.br .br
.TP .TP
.B -s .B \-s
Generate the Generate the
.IR bogusmon ", " engrave ", and " epitaph " files." .IR bogusmon ", " engrave ", and " epitaph " files."
.br .br
.TP .TP
.B -1 .B \-1
Generate the Generate the
.I epitaph .I epitaph
file. file.
.br .br
.TP .TP
.B -2 .B \-2
Generate the Generate the
.I engrave .I engrave
file. file.
.br .br
.TP .TP
.B -3 .B \-3
Generate the Generate the
.I bogusmon .I bogusmon
file. file.
.br .br
.TP .TP
.B -h .B \-h
Generate the Generate the
.B oracles .B oracles
file. file.
.br .br
.SH LONG COMMANDS .SH LONG COMMANDS
.TP .TP
.B --debug .B \-\-debug
Show debugging output. Show debugging output.
.br .br
.TP .TP
.B --make \fR[\fIcommand\fR] .B \-\-make \fR[\fIcommand\fR]
Execute a short command. Execute a short command.
.I Command .I Command
is given without preceding dash. is given without preceding dash.
.TP .TP
.BI --input " file" .BI \-\-input " file"
Specify the input Specify the input
.I file .I file
for the command (if needed). for the command (if needed).
If the file is - standard If the file is \- standard
input is read. input is read.
.br .br
.TP .TP
.BI --output " file" .BI \-\-output " file"
Specify the output Specify the output
.I file .I file
for the command (if needed). for the command (if needed).
If the file is - standard If the file is \- standard
output is written. output is written.
.br .br
.TP .TP
.B --svs \fR[\fIdelimiter\fR] .B \-\-svs \fR[\fIdelimiter\fR]
Generate a version string to standard output without a trailing newline. Generate a version string to standard output without a trailing newline.
If specified, the delimiter is used between each part of the version string. If specified, the delimiter is used between each part of the version string.
.br .br
.TP .TP
.B --grep .B \-\-grep
Filter the input Filter the input
.I file to the output .I file to the output
.IR file . .IR file .
@@ -188,22 +188,22 @@ See the
section below for information on controlling the filtering operation. section below for information on controlling the filtering operation.
.br .br
.TP .TP
.B --grep-showvars .B \-\-grep\-showvars
Show the name and value for each variable known to the grep option. Show the name and value for each variable known to the grep option.
.br .br
.TP .TP
.B --grep-trace .B \-\-grep\-trace
Turn on debug tracing for the grep function ( Turn on debug tracing for the grep function (
.B --grep .B \-\-grep
must be specified as well). must be specified as well).
.br .br
.TP .TP
.BI --grep-defined " symbol" .BI \-\-grep\-defined " symbol"
Exit shell true (0) if Exit shell true (0) if
.I symbol .I symbol
is known and defined, otherwise exit shell false (1). is known and defined, otherwise exit shell false (1).
.TP .TP
.BI --grep-define " symbol" .BI \-\-grep\-define " symbol"
Force the value of Force the value of
.I symbol .I symbol
to be "defined." to be "defined."
@@ -212,7 +212,7 @@ must already be known to
.BR makedefs . .BR makedefs .
.br .br
.TP .TP
.BI --grep-undef " symbol" .BI \-\-grep\-undef " symbol"
Force the definition of Force the definition of
.I symbol .I symbol
to be "undefined." to be "undefined."
@@ -221,7 +221,7 @@ must already be known to
.BR makedefs . .BR makedefs .
.SH MDGREP FUNCTIONS .SH MDGREP FUNCTIONS
The The
.B --grep .B \-\-grep
command (and certain other commands) filter their input, on a line-by-line command (and certain other commands) filter their input, on a line-by-line
basis, according to control lines embedded in the input and on information basis, according to control lines embedded in the input and on information
gleaned from the gleaned from the
@@ -252,7 +252,7 @@ continue (if it can) to allow as many errors as possible to be detected.
.IP - 4 .IP - 4
Unknown identifiers are treated as both TRUE and as an error. Unknown identifiers are treated as both TRUE and as an error.
Note that Note that
.BR --undef " or " #undef .BR \-\-undef " or " #undef
in the in the
.BR NetHack (6) .BR NetHack (6)
configuration are different from unknown. configuration are different from unknown.
+1 -1
View File
@@ -224,7 +224,7 @@ A
suffix can be used to specify the profession, race, alignment and/or gender suffix can be used to specify the profession, race, alignment and/or gender
of the character. of the character.
The full syntax of the playername that includes a The full syntax of the playername that includes a
suffix is "name-ppp-rrr-aaa-ggg". suffix is "name\-ppp\-rrr\-aaa\-ggg".
"ppp" are at least the first three letters "ppp" are at least the first three letters
of the profession (this can also be specified using a separate of the profession (this can also be specified using a separate
.B \-p .B \-p