nethack-gwaa-kiwi/nethack
1
0
Fork 0
Code Pull Requests Activity

doc/makedefs.6: Fix style and markup nits

Browse Source 
* Set cross reference to "nethack" man page in lowercase, because that's
  the name under which it's installed, and POSIX systems are
  case-sensitive.
* Refer to the "nethack" command using a man page cross reference only
  on its first occurrence.
* Favor bullets over hyphens for itemized list.
* Drop explicit indentation amounts from lists.  The man(7) package's
  default suffices on all of Solaris 10, DWB 3.3, Plan 9, Heirloom
  Doctools, and GNU *roffs, and on mandoc(1).
* Use tagged paragraphs to set synopses of syntax productions used in
  the documented file format.
* Drop inset (indentation) of itemized and tagged lists; the bullets
  make the structure clear, and (with the foregoing change) this way the
  paragraphs align.
This commit is contained in:
G. Branden Robinson
2026-05-06 04:53:12 -05:00
parent 61a16e6983
commit 74a3dc9d71
1 changed files with 22 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/makedefs.6
+22 -19
View File
@@ -42,7 +42,7 @@ makedefs \- NetHack miscellaneous build-time functions
.SH DESCRIPTION .SH DESCRIPTION
.B Makedefs .B Makedefs
is a build-time tool used for a variety of is a build-time tool used for a variety of
.BR NetHack (6) .IR nethack (6)
source file creation and modification tasks. source file creation and modification tasks.
For historical reasons, For historical reasons,
.B makedefs .B makedefs
@@ -210,58 +210,61 @@ The
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
.IR NetHack (6) .I nethack
configuration. configuration.
This allows certain changes such as embedding platform-specific This allows certain changes such as embedding platform-specific
documentation into the master documentation files. documentation into the master documentation files.
.P .P
Rules: Rules:
.RS .IP \(bu
.IP - 4
The default conditional state is printing enabled. The default conditional state is printing enabled.
.IP - 4 .IP \(bu
Any line Any line
.I NOT .I NOT
starting with a caret (\*^) is either suppressed or passed through unchanged starting with a caret (\*^) is either suppressed or passed through unchanged
depending on the current conditional state. depending on the current conditional state.
.IP - 4 .IP \(bu
Any line starting with a caret is a control line; as in C, zero or more spaces Any line starting with a caret is a control line; as in C, zero or more spaces
may be embedded in the line almost anywhere (except immediately after the may be embedded in the line almost anywhere (except immediately after the
caret); however the caret must be in column 1. caret); however the caret must be in column 1.
.IP - 4 .IP \(bu
Conditionals may be nested. Conditionals may be nested.
.IP - 4 .IP \(bu
.I Makedefs .I Makedefs
will exit with an error code if any errors are detected; processing will will exit with an error code if any errors are detected; processing will
continue (if it can) to allow as many errors as possible to be detected. continue (if it can) to allow as many errors as possible to be detected.
.IP - 4 .IP \(bu
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
.IR NetHack (6) .I nethack
configuration are different from unknown. configuration are different from unknown.
.RE
.P .P
Control lines: Control lines:
.RS .TP
.IP \*^\*^ 4 .B
\*^\*^
a line starting with a (single) literal caret a line starting with a (single) literal caret
.IP \*^# .TP
.B \*^#
a comment a comment
.IP \*^?\fIID .TP
.B \*^?\fIID
if the if the
.I ID .I ID
is defined set the conditional state to TRUE is defined set the conditional state to TRUE
.IP \*^!\fIID .TP
.B \*^!\fIID
if the if the
.I ID .I ID
is not defined set the conditional state to TRUE is not defined set the conditional state to TRUE
.IP \*^: .TP
.B \*^:
else; invert the conditional state else; invert the conditional state
.IP \*^. .TP
.B \*^.
end the most recent conditional end the most recent conditional
.RE
.\".SH EXAMPLES .\".SH EXAMPLES
.SH AUTHOR .SH AUTHOR
The NetHack Development Team The NetHack Development Team