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

more doc updates

Browse Source
This commit is contained in:
nhmall
2024-12-24 13:41:17 -05:00
parent c27cb28ec5
commit 4507323a42
6 changed files with 2117 additions and 2105 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3814
doc/Guidebook.txt
View File

File diff suppressed because it is too large Load Diff

33
doc/dlb.txt
View File

@@ -1,7 +1,10 @@
WARNING OLD LINE DOES NOT MATCH .TH DLB 6 OLDLINE: '.TH DLB 6
DLB(6) Games Manual DLB(6)
"DATE(%-d %B %Y)" NETHACK'
NAME
dlb - NetHack data librarian
@@ -9,18 +12,18 @@ SYNOPSIS
dlb { xct } [ vfIC ] arguments... [ files... ]
DESCRIPTION
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
files from which NetHack reads special level files and other read-only
information. Note that like tar the command and option specifiers are
specified as a continuous string and are followed by any arguments re-
quired in the same order as the option specifiers.
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
files from which NetHack reads special level files and other read-only
information. Note that like tar the command and option specifiers are
specified as a continuous string and are followed by any arguments
required in the same order as the option specifiers.
This facility is optional and may be excluded during NetHack configura-
tion.
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 c command causes dlb to create a new archive from files in the cur-
@@ -34,11 +37,11 @@ OPTIONS AND ARGUMENTS
f archive specify the archive. Default if f not specified is LIBFILE
(usually the nhdat file in the playground).
I lfile specify the file containing the list of files to put in to
I lfile specify the file containing the list of files to put in to
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.
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).
EXAMPLES
@@ -55,16 +58,16 @@ SEE ALSO
nethack(6), tar(1)
BUGS
Not a good tar emulation; - does not mean stdin or stdout. Should in-
clude an optional compression facility. Not all read-only files for
Not a good tar emulation; - does not mean stdin or stdout. Should
include an optional compression facility. Not all read-only files for
NetHack can be read out of an archive; examining the source is the only
way to know which files can be.
COPYRIGHT
This file is Copyright (C) Kenneth Lorber, DATE(%Y) for version keni-
gitset:1.13. NetHack may be freely redistributed. See license for de-
tails.
This file is Copyright (C) Kenneth Lorber, 2024 for version keni-git-
set:1.13. NetHack may be freely redistributed. See license for
details.
NETHACK DATE(1-d 1B 1Y) DLB(6)
Project(uc) 24 December 2024 DLB(6)

75
doc/makedefs.txt
View File

@@ -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)

18
doc/mn.txt
View File

@@ -17,8 +17,8 @@ DESCRIPTION
All -mn macros, diversions, string registers, and number registers are
defined below. Many nroff and troff requests are unsafe in conjunction
with this package. However, the requests below may be used with
impunity:
with this package. However, the requests below may be used with im-
punity:
.bp begin new page
.br break output line
@@ -29,8 +29,8 @@ DESCRIPTION
Font and point size changes with \f and \s are also allowed; for exam-
ple, ``\f2word\fR'' will italicize word. Output of the tbl(1), eqn(1),
and refer(1) preprocessors for equations, tables, and references is
acceptable as input.
and refer(1) preprocessors for equations, tables, and references is ac-
ceptable as input.
FILES
/usr/lib/tmac/tmac.n
@@ -47,12 +47,12 @@ WARNINGS
This package is not now intended for uses other than with the news doc-
umentation.
Bug reports are always welcome; please send them to the author.
(Include a sample of the input; this helps track down the bug.)
Bug reports are always welcome; please send them to the author. (In-
clude a sample of the input; this helps track down the bug.)
AUTHOR
Matt Bishop (mab@riacs.arpa, ihnp4!ames!riacs!mab, dec-
vax!decwrl!riacs!mab)
Matt Bishop (mab@riacs.arpa, ihnp4!ames!riacs!mab, decvax!decwrl!ri-
acs!mab)
Updated for versions 1.4-1.6 by The NetHack Development Team
REQUESTS
@@ -82,7 +82,7 @@ bt num .5i+1v - bottom of footer to bottom of page
cm num 0 - 0 if no cut marks, nonzero if cut marks
.cn x y z mac - - print computer/site name; same as .i
.dd div - i text of display
dg str *,- - footnote mark
dg str *,<*> - footnote mark
dw str current - name of current day of week
dy str current - full date
.ed mac - b end display

201
doc/nethack.txt
View File

@@ -1,7 +1,10 @@
WARNING OLD LINE DOES NOT MATCH .TH NETHACK 6 OLDLINE: '.TH
NETHACK(6) Games Manual NETHACK(6)
NETHACK 6 "21 February 2022" NETHACK'
NAME
nethack - Exploring The Mazes of Menace
@@ -20,84 +23,84 @@ SYNOPSIS
[ --version[:copy|:dump|:show] ]
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.
Other, more graphical display options exist for most platforms.
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
information) and the command / will identify the things you see on the
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
information) and the command / will identify the things you see on the
screen.
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
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
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
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
this; most never do. Those who have done so go down in history as
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
too easy for you.
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-
ers. The scoring is based on many aspects of your behavior, but a
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-
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
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% pen-
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% pen-
alty for getting yourself killed.
The environment variable NETHACKOPTIONS can be used to initialize many
run-time options. The ? command provides a description of these
options and syntax. (The -dec and -ibm command line options are mutu-
ally exclusive and are equivalent to the decgraphics and ibmgraphics
run-time options described there, and are provided purely for conve-
The environment variable NETHACKOPTIONS can be used to initialize many
run-time options. The ? command provides a description of these
options and syntax. (The -dec and -ibm command line options are mutu-
ally exclusive and are equivalent to the decgraphics and ibmgraphics
run-time options described there, and are provided purely for conve-
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
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
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
defaults.nh in NetHack's directory (folder), while on VMS|OpenVMS it is
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
@ character followed by the path and filename.
The -u playername option supplies the answer to the question "Who are
you?". It overrides any name from the options or configuration file,
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
The -u playername option supplies the answer to the question "Who are
you?". It overrides any name from the options or configuration file,
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
one. Player names (in conjunction with uids) are used to identify save
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.
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
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
using a separate -p profession option). "rrr" are at least the first
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
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
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
letters of the character's gender. Any of the parts of the suffix may
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
be left out.
-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
the character role, or the first three characters of the role as an
-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
the character role, or the first three characters of the role as an
abbreviation.
Likewise, -r race can be used to explicitly request that a race be cho-
sen.
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
role selection are maintained for compatibility with older versions of
the program. They are mutually exclusive and the single-letter form
must be uppercase. Ranger has no single-letter choice because -R is
| -R|-Rog | -Ran | -S|-Sam | -T|-Tou | -V|-Val | -W|-Wiz options for
role selection are maintained for compatibility with older versions of
the program. They are mutually exclusive and the single-letter form
must be uppercase. Ranger has no single-letter choice because -R is
already used for the Rogue role.
-@ tells nethack to choose any omitted characteristics (profes-
@@ -108,97 +111,97 @@ DESCRIPTION
The -n option suppresses printing of any news from the game administra-
tor.
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 wizard mode) after changing the character name to
"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="
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 wizard mode) after changing the character name to
"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="
line in nethack's sysconf file.
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
overrides the value from NETHACKDIR, HACKDIR, or the directory speci-
fied by the game administrator during compilation (usually
/usr/games/lib/nethackdir). This option is usually only useful to the
game administrator. The playground must contain several auxiliary
files such as help files, the list of top scorers, and a subdirectory
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
overrides the value from NETHACKDIR, HACKDIR, or the directory speci-
fied by the game administrator during compilation (usually
/usr/games/lib/nethackdir). This option is usually only useful to the
game administrator. The playground must contain several auxiliary
files such as help files, the list of top scorers, and a subdirectory
save where games are saved.
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
than one. Specifying a value on the command line overrides any value
specified in the run-time configuration file. NetHack's #version com-
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
than one. Specifying a value on the command line overrides any value
specified in the run-time configuration file. NetHack's #version com-
mand shows available interfaces.
The --nethackrc:RC-file option will use RC-file instead of the default
run-time configuration file (typically ~/.nethackrc) and the
--no-nethackrc option can be used to skip any run-time configuration
The --nethackrc:RC-file option will use RC-file instead of the default
run-time configuration file (typically ~/.nethackrc) and the
--no-nethackrc option can be used to skip any run-time configuration
file.
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
on the current version. An immediately following -v reports on all
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
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
roles and races only. Either can be specified multiple times to
arguments -p profession and -r race to print the scores of particular
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-
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
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
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
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
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
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
which match all.
--version or --version:show can be used to cause NetHack to show the
version number, the date and time that the program was built from its
source code, and possibly some auxiliary information about that source
--version or --version:show can be used to cause NetHack to show the
version number, the date and time that the program was built from its
source code, and possibly some auxiliary information about that source
code, then exit. The optional auxiliary information is git commit hash
(reflecting the source code's most recent modification when extracted
from the git version control system, if that is in use) if available
when the program was built. On some platforms such as Windows and
macOS, a variation, --version:copy, can be used to cause NetHack to
show the version information, then exit, while also leaving a copy of
that information in the paste buffer or clipboard for potential inser-
(reflecting the source code's most recent modification when extracted
from the git version control system, if that is in use) if available
when the program was built. On some platforms such as Windows and
macOS, a variation, --version:copy, can be used to cause NetHack to
show the version information, then exit, while also leaving a copy of
that information in the paste buffer or clipboard for potential inser-
tion into things like bug reports. On any platform, --version:dump can
be used to show most of the data used when checking whether a save file
or bones file is compatible with the program. The program will display
a line containing five numbers expressed in hexadecimal, then exit.
--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
name for the player's run-time configuration file, a text file which
--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
name for the player's run-time configuration file, a text file which
can be edited to customize aspects of how the game operates.
--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.
AUTHORS
Jay Fenlason (+ Kenny Woodland, Mike Thome and Jon Payne) wrote the
Jay Fenlason (+ Kenny Woodland, Mike Thome and Jon Payne) wrote the
original hack, very much like rogue (but full of bugs).
Andries Brouwer continuously deformed their sources into an entirely
Andries Brouwer continuously deformed their sources into an entirely
different game.
Mike Stephenson has continued the perversion of sources, adding various
warped character classes and sadistic traps with the help of many
strange people who reside in that place between the worlds, the Usenet
Zone. A number of these miscreants are immortalized in the historical
warped character classes and sadistic traps with the help of many
strange people who reside in that place between the worlds, the Usenet
Zone. A number of these miscreants are immortalized in the historical
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,
as he may eventually release a new version of his own.
FILES
Run-time configuration options were discussed above and use a platform
specific name for a file in a platform specific location. For Unix,
Run-time configuration options were discussed above and use a platform
specific name for a file in a platform specific location. For Unix,
the name is '.nethackrc' in the user's home directory.
All other files are in the playground directory, normally
/usr/games/lib/nethackdir. If DLB was defined during the compile, the
data files and special levels will be inside a larger file, normally
All other files are in the playground directory, normally
/usr/games/lib/nethackdir. If DLB was defined during the compile, the
data files and special levels will be inside a larger file, normally
nhdat, instead of being separate files.
nethack The program itself.
@@ -244,11 +247,11 @@ FILES
program is built with 'SYSCF' option
enabled, ignored if not.
The location of 'sysconf' is specified at build time and can't be
changed except by updating source file "config.h" and rebuilding the
The location of 'sysconf' is specified at build time and can't be
changed except by updating source file "config.h" and rebuilding the
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.
In a perfect world, 'paniclog' would remain empty.
@@ -265,7 +268,7 @@ ENVIRONMENT
NETHACKDIR or HACKDIR Playground.
NETHACKOPTIONS String predefining several NetHack options.
If the same option is specified in both NETHACKOPTIONS and .nethackrc,
If the same option is specified in both NETHACKOPTIONS and .nethackrc,
the value assigned in NETHACKOPTIONS takes precedence.
SHOPTYPE and SPLEVTYPE can be used in debugging (wizard) mode.
@@ -278,12 +281,12 @@ BUGS
Probably infinite.
COPYRIGHT
This file is Copyright (C) Robert Patrick Rankin, 2022 for version
NetHack-3.7:1.31. NetHack may be freely redistributed. See license
This file is Copyright (C) Robert Patrick Rankin, 2024 for version
NetHack-3.7:1.31. NetHack may be freely redistributed. See license
for details.
Dungeons & Dragons is a Trademark of Wizards of the Coast, Inc.
NETHACK 21 February 2022 NETHACK(6)
Project(uc) 24 December 2024 NETHACK(6)

81
doc/recover.txt
View File

@@ -1,7 +1,10 @@
WARNING OLD LINE DOES NOT MATCH .TH RECOVER 6 OLDLINE: '.TH RE-
RECOVER(6) Games Manual RECOVER(6)
COVER 6 "8 February 2022" NETHACK'
NAME
recover - recover a NetHack game interrupted by disaster
@@ -9,60 +12,60 @@ SYNOPSIS
recover [ -d directory ] base1 base2 ...
DESCRIPTION
Occasionally, a NetHack game will be interrupted by disaster when the
game or the system crashes. Prior to NetHack v3.1, these games were
lost because various information like the player's inventory was kept
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
Occasionally, a NetHack game will be interrupted by disaster when the
game or the system crashes. Prior to NetHack v3.1, these games were
lost because various information like the player's inventory was kept
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
change.
The base options tell recover which files to process. Each base option
specifies recovery of a separate game.
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-
istrator during compilation (usually /usr/games/lib/nethackdir).
For recovery to be possible, nethack must have been compiled with the
INSURANCE option, and the run-time option checkpoint must also have
been on. NetHack normally writes out files for levels as the player
For recovery to be possible, nethack must have been compiled with the
INSURANCE option, and the run-time option checkpoint must also have
been on. NetHack normally writes out files for levels as the player
leaves them, so they will be ready for return visits. When checkpoint-
ing, NetHack also writes out the level entered and the current game
state on every level change. This naturally slows level changes down
ing, 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
bookkeeping number for the level. The file base.0 is used for game
identity, locking, and, when checkpointing, for the game state. Vari-
ous OSes use different strategies for constructing the base name. Mi-
crocomputers use the character name, possibly truncated and modified to
be a legal filename on that system. Multi-user systems use the (modi-
fied) character name prefixed by a user number to avoid conflicts, or
"xlock" if the number of concurrent players is being limited. It may
be necessary to look in the playground to find the correct base name of
the interrupted game. recover will transform these level files into a
save file of the same name as nethack would have used.
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
identity, locking, and, when checkpointing, for the game state. Vari-
ous OSes use different strategies for constructing the base name.
Microcomputers use the character name, possibly truncated and modified
to be a legal filename on that system. Multi-user systems use the
(modified) character name prefixed by a user number to avoid conflicts,
or "xlock" if the number of concurrent players is being limited. It
may be necessary to look in the playground to find the correct base
name of the interrupted game. recover will transform these level files
into a save file of the same name as nethack would have used.
Since recover must be able to read and delete files from the playground
and create files in the save directory, it has interesting interactions
with game security. Giving ordinary players access to recover through
setuid or setgid is tantamount to leaving the playground world-
writable, with respect to both cheating and messing up other players.
For a single-user system, this of course does not change anything, so
with game security. Giving ordinary players access to recover through
setuid or setgid is tantamount to leaving the playground world-
writable, with respect to both cheating and messing up other players.
For a single-user system, this of course does not change anything, so
some of the microcomputer ports install recover by default.
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 ma-
chine boots, and handle game crashes individually. If the user popula-
tion is sufficiently trustworthy, recover can be installed with the
same permissions the nethack executable has. In either case, recover
all .0 files in the playground to be fed to recover when the host
machine boots, and handle game crashes individually. If the user popu-
lation is sufficiently trustworthy, recover can be installed with the
same permissions the nethack executable has. In either case, recover
is easily compiled from the distribution utility directory.
NOTES
Like nethack itself, recover will overwrite existing savefiles of the
same name. Savefiles created by recover are uncompressed; they may be
compressed afterwards if desired, but even a compression-using nethack
Like nethack itself, recover will overwrite existing savefiles of the
same name. Savefiles created by recover are uncompressed; they may be
compressed afterwards if desired, but even a compression-using nethack
will find them in the uncompressed form.
SEE ALSO
@@ -70,17 +73,17 @@ SEE ALSO
BUGS
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 im-
possible to determine.
progress. If multiple machines share a playground, this would be
impossible 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.
COPYRIGHT
This file is Copyright (C) Kenneth Lorber, 2022 for version
NetHack-3.7:1.12. NetHack may be freely redistributed. See license
This file is Copyright (C) Kenneth Lorber, 2024 for version
NetHack-3.7:1.12. NetHack may be freely redistributed. See license
for details.
NETHACK 8 February 2022 RECOVER(6)
Project(uc) 24 December 2024 RECOVER(6)