more doc updates
This commit is contained in:
nhmall
+39
-36
@@ -1,7 +1,10 @@
|
||||
WARNING OLD LINE DOES NOT MATCH .TH MAKEDEFS 6 OLDLINE: '.TH
|
||||
MAKEDEFS(6) Games Manual MAKEDEFS(6)
|
||||
|
||||
|
||||
|
||||
MAKEDEFS 6 "8 February 2022" NETHACK'
|
||||
|
||||
NAME
|
||||
makedefs - NetHack miscellaneous build-time functions
|
||||
|
||||
@@ -11,11 +14,11 @@ SYNOPSIS
|
||||
makedefs --input file --output file --command
|
||||
|
||||
DESCRIPTION
|
||||
Makedefs is a build-time tool used for a variety of NetHack(6) source
|
||||
Makedefs is a build-time tool used for a variety of NetHack(6) source
|
||||
file creation and modification tasks. For historical reasons, makedefs
|
||||
takes two types of command lines. When invoked with a short option,
|
||||
the files operated on are determined when makedefs is compiled. When
|
||||
invoked with a long option, the --input and --output options are used
|
||||
takes two types of command lines. When invoked with a short option,
|
||||
the files operated on are determined when makedefs is compiled. When
|
||||
invoked with a long option, the --input and --output options are used
|
||||
to specify the files for the --command. Each command is only available
|
||||
in one of the two formats.
|
||||
|
||||
@@ -26,11 +29,11 @@ SHORT COMMANDS
|
||||
|
||||
-d Generate data.base.
|
||||
|
||||
-e Generate dungeon.pdf. The input file dungeon.def is passed
|
||||
through the same logic as that used by the --grep command; see
|
||||
-e Generate dungeon.pdf. The input file dungeon.def is passed
|
||||
through the same logic as that used by the --grep command; see
|
||||
the MDGREP FUNCTIONS section below for details.
|
||||
|
||||
-m Generate date.h and options file. It will read dat/gitinfo.txt,
|
||||
-m Generate date.h and options file. It will read dat/gitinfo.txt,
|
||||
only if it is present, to obtain githash= and gitbranch=
|
||||
info and include related preprocessor #defines in date.h file.
|
||||
|
||||
@@ -53,7 +56,7 @@ LONG COMMANDS
|
||||
Show debugging output.
|
||||
|
||||
--make [command]
|
||||
Execute a short command. Command is given without preceding
|
||||
Execute a short command. Command is given without preceding
|
||||
dash.
|
||||
|
||||
--input file
|
||||
@@ -61,67 +64,67 @@ LONG COMMANDS
|
||||
is - standard input is read.
|
||||
|
||||
--output file
|
||||
Specify the output file for the command (if needed). If the
|
||||
Specify the output file for the command (if needed). If the
|
||||
file is - standard output is written.
|
||||
|
||||
--svs [delimiter]
|
||||
Generate a version string to standard output without a trailing
|
||||
newline. If specified, the delimiter is used between each part
|
||||
Generate a version string to standard output without a trailing
|
||||
newline. If specified, the delimiter is used between each part
|
||||
of the version string.
|
||||
|
||||
--grep Filter the input file to the output file. See the MDGREP FUNC-
|
||||
--grep Filter the input file to the output file. See the MDGREP FUNC-
|
||||
TIONS section below for information on controlling the filtering
|
||||
operation.
|
||||
|
||||
--grep-showvars
|
||||
Show the name and value for each variable known to the grep op-
|
||||
tion.
|
||||
Show the name and value for each variable known to the grep
|
||||
option.
|
||||
|
||||
--grep-trace
|
||||
Turn on debug tracing for the grep function ( --grep must be
|
||||
Turn on debug tracing for the grep function ( --grep must be
|
||||
specified as well).
|
||||
|
||||
--grep-defined symbol
|
||||
Exit shell true (0) if symbol is known and defined, otherwise
|
||||
Exit shell true (0) if symbol is known and defined, otherwise
|
||||
exit shell false (1).
|
||||
|
||||
--grep-define symbol
|
||||
Force the value of symbol to be "defined." Symbol must already
|
||||
Force the value of symbol to be "defined." Symbol must already
|
||||
be known to makedefs.
|
||||
|
||||
--grep-undef symbol
|
||||
Force the definition of symbol to be "undefined." Symbol must
|
||||
Force the definition of symbol to be "undefined." Symbol must
|
||||
already be known to makedefs.
|
||||
|
||||
MDGREP FUNCTIONS
|
||||
The --grep 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 gleaned from the NetHack(6) configuration. This al-
|
||||
lows certain changes such as embedding platform-specific documentation
|
||||
into the master documentation files.
|
||||
The --grep 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 gleaned from the NetHack(6) configuration. This
|
||||
allows certain changes such as embedding platform-specific documenta-
|
||||
tion into the master documentation files.
|
||||
|
||||
Rules:
|
||||
|
||||
- The default conditional state is printing enabled.
|
||||
|
||||
- Any line NOT starting with a caret (^) is either suppressed
|
||||
or passed through unchanged depending on the current condi-
|
||||
- Any line NOT starting with a caret (^) is either suppressed
|
||||
or passed through unchanged depending on the current condi-
|
||||
tional state.
|
||||
|
||||
- Any line starting with a caret is a control line; as in C,
|
||||
zero or more spaces may be embedded in the line almost any-
|
||||
where (except immediately after the caret); however the
|
||||
- Any line starting with a caret is a control line; as in C,
|
||||
zero or more spaces may be embedded in the line almost any-
|
||||
where (except immediately after the caret); however the
|
||||
caret must be in column 1.
|
||||
|
||||
- Conditionals may be nested.
|
||||
|
||||
- Makedefs will exit with an error code if any errors are de-
|
||||
tected; processing will continue (if it can) to allow as
|
||||
- Makedefs 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.
|
||||
|
||||
- Unknown identifiers are treated as both TRUE and as an er-
|
||||
ror. Note that --undef or #undef in the NetHack(6) configu-
|
||||
ration are different from unknown.
|
||||
- Unknown identifiers are treated as both TRUE and as an
|
||||
error. Note that --undef or #undef in the NetHack(6) con-
|
||||
figuration are different from unknown.
|
||||
|
||||
Control lines:
|
||||
|
||||
@@ -143,10 +146,10 @@ AUTHOR
|
||||
The NetHack Development Team
|
||||
|
||||
COPYRIGHT
|
||||
This file is Copyright (C) Kenneth Lorber, 2022 for version
|
||||
NetHack-3.7:1.22. NetHack may be freely redistributed. See license
|
||||
This file is Copyright (C) Kenneth Lorber, 2024 for version
|
||||
NetHack-3.7:1.22. NetHack may be freely redistributed. See license
|
||||
for details.
|
||||
|
||||
|
||||
|
||||
NETHACK 8 February 2022 MAKEDEFS(6)
|
||||
Project(uc) 24 December 2024 MAKEDEFS(6)
|
||||
|
||||
Reference in New Issue
Block a user