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

placeholder copies of doc/*.txt until cron job gets repaired

Browse Source
This commit is contained in:
nhmall
2023-11-22 17:00:09 -05:00
parent d7bd85c492
commit b09d663f71
4 changed files with 194 additions and 215 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
doc/dlb.txt
View File

@@ -1,7 +1,5 @@
DLB(6) Games Manual DLB(6) DLB(6) Games Manual DLB(6)
NAME NAME
dlb - NetHack data librarian dlb - NetHack data librarian
@@ -11,21 +9,19 @@ SYNOPSIS
DESCRIPTION DESCRIPTION
Dlb is a file archiving tool in the spirit (and tradition) of tar for Dlb is a file archiving tool in the spirit (and tradition) of tar for
NetHack version 3.1 and higher. It is used to maintain the archive NetHack version 3.1 and higher. It is used to maintain the archive
files from which NetHack reads special level files and other read-only files from which NetHack reads special level files and other read‐only
information. Note that like tar the command and option specifiers are information. Note that like tar the command and option specifiers are
specified as a continuous string and are followed by any arguments specified as a continuous string and are followed by any arguments re‐
required in the same order as the option specifiers. quired in the same order as the option specifiers.
^?ALLDOCS This facility is optional and may be excluded during NetHack This facility is optional but is included in this NetHack configura‐
configuration. ^: ^?DLB This facility is optional but is included in tion.
this NetHack configuration. ^: This facility is optional and was
excluded from this NetHack configuration. ^. ^.
COMMANDS COMMANDS
The x command causes dlb to extract the contents of the archive into The x command causes dlb to extract the contents of the archive into
the current directory. the current directory.
The c command causes dlb to create a new archive from files in the cur- The c command causes dlb to create a new archive from files in the cur‐
rent directory. rent directory.
The t command lists the files in the archive. The t command lists the files in the archive.
@@ -40,14 +36,14 @@ OPTIONS AND ARGUMENTS
or extract from the archive if no files are listed on the command line. or extract from the archive if no files are listed on the command line.
Default for archive creation if no files are listed is LIBLISTFILE. Default for archive creation if no files are listed is LIBLISTFILE.
C dir change directory. Changes directory before trying to read C dir change directory. Changes directory before trying to read
any files (including the archive and the lfile). any files (including the archive and the lfile).
EXAMPLES EXAMPLES
Create the default archive from the default file list: Create the default archive from the default file list:
dlb c dlb c
List the contents of the archive 'foo': List the contents of the archive ’foo’:
dlb tf foo dlb tf foo
AUTHOR AUTHOR
@@ -57,16 +53,14 @@ SEE ALSO
nethack(6), tar(1) nethack(6), tar(1)
BUGS BUGS
Not a good tar emulation; - does not mean stdin or stdout. Should Not a good tar emulation; ‐ does not mean stdin or stdout. Should in‐
include an optional compression facility. Not all read-only files for clude an optional compression facility. Not all read‐only files for
NetHack can be read out of an archive; examining the source is the only NetHack can be read out of an archive; examining the source is the only
way to know which files can be. way to know which files can be.
COPYRIGHT COPYRIGHT
This file is Copyright (C) Kenneth Lorber, 2022 for version This file is Copyright (C) Kenneth Lorber, 2022 for version
NetHack-3.7:1.12. NetHack may be freely redistributed. See license NetHack‐3.7:1.12. NetHack may be freely redistributed. See license
for details. for details.
NETHACK 8 February 2022 DLB(6) NETHACK 8 February 2022 DLB(6)

116
doc/makedefs.txt
View File

@@ -1,121 +1,119 @@
MAKEDEFS(6) Games Manual MAKEDEFS(6) MAKEDEFS(6) Games Manual MAKEDEFS(6)
NAME NAME
makedefs - NetHack miscellaneous build-time functions makedefs - NetHack miscellaneous build‐time functions
SYNOPSIS SYNOPSIS
makedefs { -o | -d | -e | -m | -v | -p | -q | -r | -h } makedefs { ‐o | ‐d | ‐e | ‐m | ‐v | ‐p | ‐q | ‐r | ‐h }
makedefs --input file --output file --command makedefs ‐‐input file ‐‐output file ‐‐command
DESCRIPTION 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 file creation and modification tasks. For historical reasons, makedefs
takes two types of command lines. When invoked with a short option, takes two types of command lines. When invoked with a short option,
the files operated on are determined when makedefs is compiled. When the files operated on are determined when makedefs is compiled. When
invoked with a long option, the --input and --output options are used invoked with a long option, the ‐‐input and ‐‐output options are used
to specify the files for the --command. Each command is only available to specify the files for the ‐‐command. Each command is only available
in one of the two formats. in one of the two formats.
SHORT COMMANDS SHORT COMMANDS
Upper and lower case are both accepted for the short commands. Upper and lower case are both accepted for the short commands.
-o Generate onames.h. ‐o Generate onames.h.
-d Generate data.base. ‐d Generate data.base.
-e Generate dungeon.pdf. The input file dungeon.def is passed ‐e Generate dungeon.pdf. The input file dungeon.def is passed
through the same logic as that used by the --grep command; see through the same logic as that used by the ‐‐grep command; see
the MDGREP FUNCTIONS section below for details. 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= only if it is present, to obtain githash= and gitbranch=
info and include related preprocessor #defines in date.h file. info and include related preprocessor #defines in date.h file.
-p Generate pm.h ‐p Generate pm.h
-q Generate the rumors file. ‐q Generate the rumors file.
-s Generate the bogusmon , engrave and epitaphfiles. ‐s Generate the bogusmon , engrave and epitaphfiles.
-h Generate the oracles file. ‐h Generate the oracles file.
LONG COMMANDS LONG COMMANDS
--debug ‐‐debug
Show debugging output. Show debugging output.
--make [command] ‐‐make [command]
Execute a short command. Command is given without preceding Execute a short command. Command is given without preceding
dash. dash.
--input file ‐‐input file
Specify the input file for the command (if needed). If the file Specify the input file for the command (if needed). If the file
is - standard input is read. is ‐ standard input is read.
--output file ‐‐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. file is ‐ standard output is written.
--svs [delimiter] ‐‐svs [delimiter]
Generate a version string to standard output without a trailing Generate a version string to standard output without a trailing
newline. If specified, the delimiter is used between each part newline. If specified, the delimiter is used between each part
of the version string. 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 TIONS section below for information on controlling the filtering
operation. operation.
--grep-showvars ‐‐grep‐showvars
Show the name and value for each variable known to the grep Show the name and value for each variable known to the grep op‐
option. tion.
--grep-trace ‐‐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). specified as well).
--grep-defined symbol ‐‐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). exit shell false (1).
--grep-define symbol ‐‐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. be known to makedefs.
--grep-undef symbol ‐‐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. already be known to makedefs.
MDGREP FUNCTIONS MDGREP FUNCTIONS
The --grep command (and certain other commands) filter their input, on The ‐‐grep command (and certain other commands) filter their input, on
a line-by-line basis, according to control lines embedded in the input a line‐by‐line basis, according to control lines embedded in the input
and on information gleaned from the NetHack(6) configuration. This and on information gleaned from the NetHack(6) configuration. This al‐
allows certain changes such as embedding platform-specific documenta- lows certain changes such as embedding platform‐specific documentation
tion into the master documentation files. into the master documentation files.
Rules: Rules:
- The default conditional state is printing enabled. ‐ The default conditional state is printing enabled.
- Any line NOT starting with a caret (^) is either suppressed ‐ Any line NOT starting with a caret (^) is either suppressed
or passed through unchanged depending on the current condi- or passed through unchanged depending on the current condi‐
tional state. tional state.
- Any line starting with a caret is a control line; as in C, ‐ 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- zero or more spaces may be embedded in the line almost any‐
where (except immediately after the caret); however the where (except immediately after the caret); however the
caret must be in column 1. caret must be in column 1.
- Conditionals may be nested. ‐ Conditionals may be nested.
- Makedefs will exit with an error code if any errors are ‐ Makedefs will exit with an error code if any errors are de‐
detected; processing will continue (if it can) to allow as tected; processing will continue (if it can) to allow as
many errors as possible to be detected. many errors as possible to be detected.
- Unknown identifiers are treated as both TRUE and as an ‐ Unknown identifiers are treated as both TRUE and as an er‐
error. Note that --undef or #undef in the NetHack(6) con- ror. Note that ‐‐undef or #undef in the NetHack(6) configu‐
figuration are different from unknown. ration are different from unknown.
Control lines: Control lines:
@@ -137,10 +135,8 @@ AUTHOR
The NetHack Development Team The NetHack Development Team
COPYRIGHT COPYRIGHT
This file is Copyright (C) Kenneth Lorber, 2022 for version keni-crash- This file is Copyright (C) Kenneth Lorber, 2022 for version keni‐crash‐
web2:1.21. NetHack may be freely redistributed. See license for web2:1.21. NetHack may be freely redistributed. See license for de‐
details. tails.
NETHACK 8 February 2022 MAKEDEFS(6) NETHACK 8 February 2022 MAKEDEFS(6)

186
doc/nethack.txt
View File

@@ -1,13 +1,11 @@
NETHACK(6) Games Manual NETHACK(6) NETHACK(6) Games Manual NETHACK(6)
NAME NAME
nethack - Exploring The Mazes of Menace nethack - Exploring The Mazes of Menace
SYNOPSIS SYNOPSIS
nethack [ -d|--directory directory ] [ -w|--windowtype interface ] nethack [ -d|--directory directory ] [ -w|--windowtype interface ]
[ --nethackrc:RC-file | --no-nethackrc ] [ -n ] [ -dec | -ibm ] [ --nethackrc:RC‐file | --no-nethackrc ] [ -n ] [ -dec | -ibm ]
[ -u playername ] [ -X | -D ] [ -p profession ] [ -r race ] [ -@ ] [ -u playername ] [ -X | -D ] [ -p profession ] [ -r race ] [ -@ ]
Also [ -A|-Arc | -B|-Bar | -C|-Cav | -H|-Hea | -K|-Kni | -M|-Mon | Also [ -A|-Arc | -B|-Bar | -C|-Cav | -H|-Hea | -K|-Kni | -M|-Mon |
@@ -19,104 +17,104 @@ SYNOPSIS
nethack [ --usage | --help ] [ --showpaths ] [ --version[:copy] ] nethack [ --usage | --help ] [ --showpaths ] [ --version[:copy] ]
DESCRIPTION DESCRIPTION
NetHack is a display oriented Dungeons & Dragons(tm) - like game. The NetHack is a display oriented Dungeons & Dragons(tm) ‐ like game. The
standard tty display and command structure resemble rogue. standard tty display and command structure resemble rogue.
Other, more graphical display options exist for most platforms. Other, more graphical display options exist for most platforms.
To get started you really only need to know two commands. The command To get started you really only need to know two commands. The command
? will give you a list of the available commands (as well as other ? will give you a list of the available commands (as well as other
information) and the command / will identify the things you see on the information) and the command / will identify the things you see on the
screen. screen.
To win the game (as opposed to merely playing to beat other people's To win the game (as opposed to merely playing to beat other people’s
high scores) you must locate the Amulet of Yendor which is somewhere high scores) you must locate the Amulet of Yendor which is somewhere
below the 20th level of the dungeon and get it out. Few people achieve below the 20th level of the dungeon and get it out. Few people achieve
this; most never do. Those who have done so go down in history as he- this; most never do. Those who have done so go down in history as
roes among heroes -- and then they find ways of making the game even heroes among heroes — and then they find ways of making the game even
harder. See the Guidebook section on Conduct if this game has gotten harder. See the Guidebook section on Conduct if this game has gotten
too easy for you. too easy for you.
When the game ends, whether by your dying, quitting, or escaping from When the game ends, whether by your dying, quitting, or escaping from
the caves, NetHack will give you (a fragment of) the list of top scor- the caves, NetHack will give you (a fragment of) the list of top scor‐
ers. The scoring is based on many aspects of your behavior, but a ers. The scoring is based on many aspects of your behavior, but a
rough estimate is obtained by taking the amount of gold you've found in rough estimate is obtained by taking the amount of gold you’ve found in
the cave plus four times your (real) experience. Precious stones may the cave plus four times your (real) experience. Precious stones may
be worth a lot of gold when brought to the exit. There is a 10% be worth a lot of gold when brought to the exit. There is a 10%
penalty for getting yourself killed. penalty for getting yourself killed.
The environment variable NETHACKOPTIONS can be used to initialize many The environment variable NETHACKOPTIONS can be used to initialize many
run-time options. The ? command provides a description of these run‐time options. The ? command provides a description of these
options and syntax. (The -dec and -ibm command line options are mutu- options and syntax. (The -dec and -ibm command line options are mutu‐
ally exclusive and are equivalent to the decgraphics and ibmgraphics ally exclusive and are equivalent to the decgraphics and ibmgraphics
run-time options described there, and are provided purely for conve- run‐time options described there, and are provided purely for conve‐
nience on systems supporting multiple types of terminals.) nience on systems supporting multiple types of terminals.)
Because the option list can be very long, options may also be included Because the option list can be very long, options may also be included
in a configuration file. The default is located in your home directory in a configuration file. The default is located in your home directory
and named .nethackrc on UNIX systems (including descendants such as and named .nethackrc on UNIX systems (including descendants such as
linux, NetBSD, and macOS). On Windows, the name is also .nethackrc but linux, NetBSD, and macOS). On Windows, the name is also .nethackrc but
the location can vary (see --showpaths below). On other systems, the the location can vary (see --showpaths below). On other systems, the
default may be different, possibly NetHack.cnf. On MS-DOS, the name is default may be different, possibly NetHack.cnf. On MS‐DOS, the name is
defaults.nh in NetHack's directory (folder), while on VMS|OpenVMS it is defaults.nh in NetHack’s directory (folder), while on VMS|OpenVMS it is
nethack.ini in your home directory. The default configuration file may nethack.ini in your home directory. The default configuration file may
be overridden via the --nethackrc:rc-file command line option or by be overridden via the --nethackrc:rc‐file command line option or by
setting NETHACKOPTIONS in your environment to a string consisting of an setting NETHACKOPTIONS in your environment to a string consisting of an
@ character followed by the path and filename. @ character followed by the path and filename.
The -u playername option supplies the answer to the question "Who are The -u playername option supplies the answer to the question "Who are
you?". It overrides any name from the options or configuration file, you?". It overrides any name from the options or configuration file,
USER, LOGNAME, or getlogin(), which will otherwise be tried in order. USER, LOGNAME, or getlogin(), which will otherwise be tried in order.
If none of these provides a useful name, the player will be asked for If none of these provides a useful name, the player will be asked for
one. Player names (in conjunction with uids) are used to identify save one. Player names (in conjunction with uids) are used to identify save
files, so you can have several saved games under different names. Con- files, so you can have several saved games under different names. Con‐
versely, you must use the appropriate player name to restore a saved versely, you must use the appropriate player name to restore a saved
game. game.
A playername suffix can be used to specify the profession, race, align- A playername suffix can be used to specify the profession, race, align‐
ment and/or gender of the character. The full syntax of the playername ment and/or gender of the character. The full syntax of the playername
that includes a suffix is "name-ppp-rrr-aaa-ggg". "ppp" are at least that includes a suffix is "name‐ppp‐rrr‐aaa‐ggg". "ppp" are at least
the first three letters of the profession (this can also be specified the first three letters of the profession (this can also be specified
using a separate -p profession option). "rrr" are at least the first using a separate -p profession option). "rrr" are at least the first
three letters of the character's race (this can also be specified using three letters of the character’s race (this can also be specified using
a separate -r race option). "aaa" are at least the first three letters a separate -r race option). "aaa" are at least the first three letters
of the character's alignment, and "ggg" are at least the first three of the character’s alignment, and "ggg" are at least the first three
letters of the character's gender. Any of the parts of the suffix may letters of the character’s gender. Any of the parts of the suffix may
be left out. be left out.
-p profession can be used to determine the character profession, also -p profession can be used to determine the character profession, also
known as the role. You can specify either the male or female name for known as the role. You can specify either the male or female name for
the character role, or the first three characters of the role as an the character role, or the first three characters of the role as an
abbreviation. abbreviation.
Likewise, -r race can be used to explicitly request that a race be cho- Likewise, -r race can be used to explicitly request that a race be cho‐
sen. sen.
The -A|-Arc | -B|-Bar | -C|-Cav | -H|-Hea | -K|-Kni | -M|-Mon | -P|-Pri The -A|-Arc | -B|-Bar | -C|-Cav | -H|-Hea | -K|-Kni | -M|-Mon | -P|-Pri
| -R|-Rog | -Ran | -S|-Sam | -T|-Tou | -V|-Val | -W|-Wiz options for | -R|-Rog | -Ran | -S|-Sam | -T|-Tou | -V|-Val | -W|-Wiz options for
role selection are maintained for compatibility with older versions of role selection are maintained for compatibility with older versions of
the program. They are mutually exclusive and the single-letter form the program. They are mutually exclusive and the single‐letter form
must be uppercase. Ranger has no single-letter choice because -R is must be uppercase. Ranger has no single‐letter choice because -R is
already used for the Rogue role. already used for the Rogue role.
-@ tells nethack to choose any omitted characteristics (profes- -@ tells nethack to choose any omitted characteristics (profes‐
sion/role, race, gender, alignment) randomly without prompting. Other- sion/role, race, gender, alignment) randomly without prompting. Other‐
wise, leaving out any of these characteristics will result in you being wise, leaving out any of these characteristics will result in you being
prompted during game startup for the information. prompted during game startup for the information.
The -n option suppresses printing of any news from the game administra- The -n option suppresses printing of any news from the game administra‐
tor. tor.
The -X option will start the game in a special non-scoring discovery The -X option will start the game in a special non‐scoring discovery
mode (also known as explore mode). -D will start the game in debug mode (also known as explore mode). -D will start the game in debug
mode (also known as wizard mode) after changing the character name to mode (also known as wizard mode) after changing the character name to
"wizard", if the player is allowed. Otherwise it will switch to -X. “wizard”, if the player is allowed. Otherwise it will switch to -X.
Control of who is allowed to use debug mode is done via the "WIZARDS=" Control of who is allowed to use debug mode is done via the “WIZARDS=”
line in nethack's sysconf file. line in nethack’s sysconf file.
The -d or --directory option, which must be the first argument if it The -d or --directory option, which must be the first argument if it
appears, supplies a directory which is to serve as the playground. It appears, supplies a directory which is to serve as the playground. It
overrides the value from NETHACKDIR, HACKDIR, or the directory speci- overrides the value from NETHACKDIR, HACKDIR, or the directory speci‐
fied by the game administrator during compilation (usually fied by the game administrator during compilation (usually
/usr/games/lib/nethackdir). This option is usually only useful to the /usr/games/lib/nethackdir). This option is usually only useful to the
game administrator. The playground must contain several auxiliary game administrator. The playground must contain several auxiliary
@@ -126,45 +124,45 @@ DESCRIPTION
The -w or --windowtype interface option can be used to specify which The -w or --windowtype interface option can be used to specify which
interface to use if the program has been built with support for more interface to use if the program has been built with support for more
than one. Specifying a value on the command line overrides any value than one. Specifying a value on the command line overrides any value
specified in the run-time configuration file. NetHack's #version com- specified in the run‐time configuration file. NetHack’s #version com‐
mand shows available interfaces. mand shows available interfaces.
The --nethackrc:RC-file option will use RC-file instead of the default The --nethackrc:RC‐file option will use RC‐file instead of the default
run-time configuration file (typically ~/.nethackrc) and the run‐time configuration file (typically ~/.nethackrc) and the
--no-nethackrc option can be used to skip any run-time configuration --no-nethackrc option can be used to skip any run‐time configuration
file. file.
Some options provide feedback and then exit rather than play the game: Some options provide feedback and then exit rather than play the game:
The -s or --scores option alone will print out the list of your scores The -s or --scores option alone will print out the list of your scores
on the current version. An immediately following -v reports on all on the current version. An immediately following -v reports on all
versions present in the score file. '-s|-s -v' may also be followed by versions present in the score file. ‘-s|-s -v’ may also be followed by
arguments -p profession and -r race to print the scores of particular arguments -p profession and -r race to print the scores of particular
roles and races only. Either can be specified multiple times to roles and races only. Either can be specified multiple times to
include more than one role or more than one race. When both are speci- include more than one role or more than one race. When both are speci‐
fied, score entries which match either the role or the race (or both) fied, score entries which match either the role or the race (or both)
are printed rather than just entries which match both. '-s|-s -v' may are printed rather than just entries which match both. ‘-s|-s -v’ may
be followed by one or more player names to print the scores of the be followed by one or more player names to print the scores of the
players mentioned, by 'all' to print out all scores, or by a number to players mentioned, by ’all’ to print out all scores, or by a number to
print that many top scores. Combining names with role or race or both print that many top scores. Combining names with role or race or both
will report entries which match any of those rather than just the ones will report entries which match any of those rather than just the ones
which match all. which match all.
--version can be used to cause NetHack to show the version information --version can be used to cause NetHack to show the version information
it was compiled with, then exit. That will include the git commit hash it was compiled with, then exit. That will include the git commit hash
if the information was available when the game was compiled. On some if the information was available when the game was compiled. On some
platforms, such as Windows and macOS, a variation --version:copy can be platforms, such as Windows and macOS, a variation --version:copy can be
used to cause NetHack to show the version information, then exit, while used to cause NetHack to show the version information, then exit, while
also leaving a copy of the version information in the paste buffer or also leaving a copy of the version information in the paste buffer or
clipboard for potential insertion into things like bug reports. clipboard for potential insertion into things like bug reports.
--showpaths can be used to cause NetHack to show where it is expecting --showpaths can be used to cause NetHack to show where it is expecting
to find various files. Among other things it shows the path to and to find various files. Among other things it shows the path to and
name for the player's run-time configuration file, a text file which name for the player’s run‐time configuration file, a text file which
can be editted to customize aspects of how the game operates. can be editted to customize aspects of how the game operates.
--usage or --help will display information similar to this manual page, --usage or --help will display information similar to this manual page,
then exit. Use 'nethack --usage | more' to read it a page at a time. then exit. Use ‘nethack --usage | more’ to read it a page at a time.
AUTHORS AUTHORS
Jay Fenlason (+ Kenny Woodland, Mike Thome and Jon Payne) wrote the Jay Fenlason (+ Kenny Woodland, Mike Thome and Jon Payne) wrote the
@@ -174,19 +172,19 @@ AUTHORS
different game. different game.
Mike Stephenson has continued the perversion of sources, adding various Mike Stephenson has continued the perversion of sources, adding various
warped character classes and sadistic traps with the help of many warped character classes and sadistic traps with the help of many
strange people who reside in that place between the worlds, the Usenet strange people who reside in that place between the worlds, the Usenet
Zone. A number of these miscreants are immortalized in the historical Zone. A number of these miscreants are immortalized in the historical
roll of dishonor and various other places. roll of dishonor and various other places.
The resulting mess is now called NetHack, to denote its development by The resulting mess is now called NetHack, to denote its development by
the Usenet. Andries Brouwer has made this request for the distinction, the Usenet. Andries Brouwer has made this request for the distinction,
as he may eventually release a new version of his own. as he may eventually release a new version of his own.
FILES FILES
Run-time configuration options were discussed above and use a platform Run‐time configuration options were discussed above and use a platform
specific name for a file in a platform specific location. For Unix, specific name for a file in a platform specific location. For Unix,
the name is '.nethackrc' in the user's home directory. the name is ’.nethackrc’ in the user’s home directory.
All other files are in the playground directory, normally All other files are in the playground directory, normally
/usr/games/lib/nethackdir. If DLB was defined during the compile, the /usr/games/lib/nethackdir. If DLB was defined during the compile, the
@@ -194,7 +192,7 @@ FILES
nhdat, instead of being separate files. nhdat, instead of being separate files.
nethack The program itself. nethack The program itself.
Guidebook | Guidebook.txt NetHack's user manual. Guidebook | Guidebook.txt NetHack’s user manual.
data, oracles, rumors Data files used by NetHack. data, oracles, rumors Data files used by NetHack.
bogusmon Another data file. bogusmon Another data file.
engrave, epitaph, tribute Still more data files. engrave, epitaph, tribute Still more data files.
@@ -202,8 +200,8 @@ FILES
for how to display monsters, objects, and for how to display monsters, objects, and
map features. map features.
options Data file containing a description of the options Data file containing a description of the
build-time option settings. build‐time option settings.
help, hh, cmdhelp Help data files. ('cmdhelp' is obsolete.) help, hh, cmdhelp Help data files. (’cmdhelp’ is obsolete.)
opthelp, optmenu, wizhelp More help data files. opthelp, optmenu, wizhelp More help data files.
keyhelp, usagehlp Even more help data files. keyhelp, usagehlp Even more help data files.
*.lua Predefined special levels, dungeon control *.lua Predefined special levels, dungeon control
@@ -213,37 +211,37 @@ FILES
record The list of top scorers. record The list of top scorers.
logfile An extended list of games played logfile An extended list of games played
(optional). (optional).
xlogfile A more detailed version of 'logfile' xlogfile A more detailed version of ’logfile’
(also optional). (also optional).
paniclog Record of exceptional conditions paniclog Record of exceptional conditions
discovered during program execution. discovered during program execution.
xlock.nn Description of dungeon level 'nn' of xlock.nn Description of dungeon level ’nn’ of
active game 'x' if there's a limit on the active game ’x’ if there’s a limit on the
number of simultaneously active games. number of simultaneously active games.
UUcccccc.nn Alternate form for dungeon level 'nn' UUcccccc.nn Alternate form for dungeon level ’nn’
of active game by user 'UU' playing of active game by user ’UU’ playing
character named 'cccccc' when there's no character named ’cccccc’ when there’s no
limit on number of active games. limit on number of active games.
perm Lock file for xlock.0 or UUcccccc.0. perm Lock file for xlock.0 or UUcccccc.0.
bonD0.nn Descriptions of the ghost and belongings bonD0.nn Descriptions of the ghost and belongings
of a deceased adventurer who met his or of a deceased adventurer who met his or
her demise on level 'nn'. A subsequent her demise on level ’nn’. A subsequent
character might encounter this old level. character might encounter this old level.
save/ A subdirectory containing saved games. save/ A subdirectory containing saved games.
sysconf System-wide options. Required if sysconf System‐wide options. Required if
program is built with 'SYSCF' option program is built with ’SYSCF’ option
enabled, ignored if not. enabled, ignored if not.
The location of 'sysconf' is specified at build time and can't be The location of ’sysconf’ is specified at build time and can’t be
changed except by updating source file "config.h" and rebuilding the changed except by updating source file "config.h" and rebuilding the
program. program.
NetHack's Guidebook might not be present if whoever packaged or NetHack’s Guidebook might not be present if whoever packaged or
installed the program distribution neglected to include it. installed the program distribution neglected to include it.
In a perfect world, 'paniclog' would remain empty. In a perfect world, ’paniclog’ would remain empty.
ENVIRONMENT ENVIRONMENT
USER or LOGNAME Your login name. USER or LOGNAME Your login name.
@@ -261,7 +259,7 @@ ENVIRONMENT
the value assigned in NETHACKOPTIONS takes precedence. the value assigned in NETHACKOPTIONS takes precedence.
SHOPTYPE and SPLEVTYPE can be used in debugging (wizard) mode. SHOPTYPE and SPLEVTYPE can be used in debugging (wizard) mode.
DEBUGFILES can be used if the program was built with 'DEBUG' enabled. DEBUGFILES can be used if the program was built with ’DEBUG’ enabled.
SEE ALSO SEE ALSO
recover(6) recover(6)
@@ -271,11 +269,9 @@ BUGS
COPYRIGHT COPYRIGHT
This file is Copyright (C) Robert Patrick Rankin, 2022 for version This file is Copyright (C) Robert Patrick Rankin, 2022 for version
NetHack-3.7:1.31. NetHack may be freely redistributed. See license NetHack‐3.7:1.31. NetHack may be freely redistributed. See license
for details. for details.
Dungeons & Dragons is a Trademark of Wizards of the Coast, Inc. Dungeons & Dragons is a Trademark of Wizards of the Coast, Inc.
NETHACK 21 February 2022 NETHACK(6) NETHACK 21 February 2022 NETHACK(6)

79
doc/recover.txt
View File

@@ -1,7 +1,5 @@
RECOVER(6) Games Manual RECOVER(6) RECOVER(6) Games Manual RECOVER(6)
NAME NAME
recover - recover a NetHack game interrupted by disaster recover - recover a NetHack game interrupted by disaster
@@ -11,7 +9,7 @@ SYNOPSIS
DESCRIPTION DESCRIPTION
Occasionally, a NetHack game will be interrupted by disaster when the Occasionally, a NetHack game will be interrupted by disaster when the
game or the system crashes. Prior to NetHack v3.1, these games were game or the system crashes. Prior to NetHack v3.1, these games were
lost because various information like the player's inventory was kept lost because various information like the player’s inventory was kept
only in memory. Now, all pertinent information can be written out to only in memory. Now, all pertinent information can be written out to
disk, so such games can be recovered at the point of the last level disk, so such games can be recovered at the point of the last level
change. change.
@@ -21,51 +19,48 @@ DESCRIPTION
The -d option, which must be the first argument if it appears, supplies The -d option, which must be the first argument if it appears, supplies
a directory which is the NetHack playground. It overrides the value a directory which is the NetHack playground. It overrides the value
from NETHACKDIR, HACKDIR, or the directory specified by the game admin- from NETHACKDIR, HACKDIR, or the directory specified by the game admin‐
istrator during compilation (usually /usr/games/lib/nethackdir). istrator during compilation (usually /usr/games/lib/nethackdir).
^?ALLDOCS For recovery to be possible, nethack must have been compiled For recovery to be possible, nethack must have been compiled with the
with the INSURANCE option, and the run-time option checkpoint must also INSURANCE option (this configuration was), and the run‐time option
have been on. ^: ^?INSURANCE For recovery to be possible, nethack must checkpoint must also have been on. NetHack normally writes out files
have been compiled with the INSURANCE option (this configuration was), for levels as the player leaves them, so they will be ready for return
and the run-time option checkpoint must also have been on. ^: This visits. When checkpointing, NetHack also writes out the level entered
configuration of nethack was created without support for recovery. ^. and the current game state on every level change. This naturally slows
^. NetHack normally writes out files for levels as the player leaves level changes down somewhat.
them, so they will be ready for return visits. When checkpointing,
NetHack also writes out the level entered and the current game state on
every level change. This naturally slows level changes down somewhat.
The level file names are of the form base.nn, where nn is an internal The level file names are of the form base.nn, where nn is an internal
bookkeeping number for the level. The file base.0 is used for game bookkeeping number for the level. The file base.0 is used for game
identity, locking, and, when checkpointing, for the game state. Vari- identity, locking, and, when checkpointing, for the game state. Vari‐
ous OSes use different strategies for constructing the base name. ous OSes use different strategies for constructing the base name. Mi‐
Microcomputers use the character name, possibly truncated and modified crocomputers use the character name, possibly truncated and modified to
to be a legal filename on that system. Multi-user systems use the be a legal filename on that system. Multi‐user systems use the (modi‐
(modified) character name prefixed by a user number to avoid conflicts, fied) character name prefixed by a user number to avoid conflicts, or
or "xlock" if the number of concurrent players is being limited. It "xlock" if the number of concurrent players is being limited. It may
may be necessary to look in the playground to find the correct base be necessary to look in the playground to find the correct base name of
name of the interrupted game. recover will transform these level files the interrupted game. recover will transform these level files into a
into a save file of the same name as nethack would have used. save file of the same name as nethack would have used.
Since recover must be able to read and delete files from the playground Since recover must be able to read and delete files from the playground
and create files in the save directory, it has interesting interactions and create files in the save directory, it has interesting interactions
with game security. Giving ordinary players access to recover through with game security. Giving ordinary players access to recover through
setuid or setgid is tantamount to leaving the playground world- setuid or setgid is tantamount to leaving the playground world‐
writable, with respect to both cheating and messing up other players. writable, with respect to both cheating and messing up other players.
For a single-user system, this of course does not change anything, so For a single‐user system, this of course does not change anything, so
some of the microcomputer ports install recover by default. some of the microcomputer ports install recover by default.
For a multi-user system, the game administrator may want to arrange for For a multi‐user system, the game administrator may want to arrange for
all .0 files in the playground to be fed to recover when the host all .0 files in the playground to be fed to recover when the host ma‐
machine boots, and handle game crashes individually. If the user popu- chine boots, and handle game crashes individually. If the user popula‐
lation is sufficiently trustworthy, recover can be installed with the tion is sufficiently trustworthy, recover can be installed with the
same permissions the nethack executable has. In either case, recover same permissions the nethack executable has. In either case, recover
is easily compiled from the distribution utility directory. is easily compiled from the distribution utility directory.
NOTES NOTES
Like nethack itself, recover will overwrite existing savefiles of the Like nethack itself, recover will overwrite existing savefiles of the
same name. Savefiles created by recover are uncompressed; they may be same name. Savefiles created by recover are uncompressed; they may be
compressed afterwards if desired, but even a compression-using nethack compressed afterwards if desired, but even a compression‐using nethack
will find them in the uncompressed form. will find them in the uncompressed form.
SEE ALSO SEE ALSO
@@ -73,17 +68,15 @@ SEE ALSO
BUGS BUGS
recover makes no attempt to find out if a base name specifies a game in recover makes no attempt to find out if a base name specifies a game in
progress. If multiple machines share a playground, this would be progress. If multiple machines share a playground, this would be im‐
impossible to determine. possible to determine.
recover should be taught to use the nethack playground locking mecha- recover should be taught to use the nethack playground locking mecha‐
nism to avoid conflicts. nism to avoid conflicts.
COPYRIGHT COPYRIGHT
This file is Copyright (C) Kenneth Lorber, 2022 for version This file is Copyright (C) Kenneth Lorber, 2022 for version
NetHack-3.7:1.12. NetHack may be freely redistributed. See license NetHack‐3.7:1.12. NetHack may be freely redistributed. See license
for details. for details.
NETHACK 8 February 2022 RECOVER(6) NETHACK 8 February 2022 RECOVER(6)