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

man page updates

Browse Source 
Update the man pages and generated text copies for nethack and recover.
I haven't looked at the other four (dlb, makedefs, dgn_comp, lev_comp).

recover's page referred to INSURANCE as being conditional, which is no
longer the case.  nethack's page was missing a bunch of files to be
found in the playground and also a couple of environment variables.
I haven't read through the text of the page to try to see whether other
updates are warranted.

The generated text is wider than the previous copy (one or two space
right margin instead of 5 or so).  I just used 'make nethack.txt' and
'make recover.txt' so don't know why that changed.  (The older, wider
margin looks better, so if anyone knows how to fix this, please do.
And there's got to be a better way to force a blank line inside a
table than my <space><tab> hack.)
This commit is contained in:
PatR
2015-12-08 15:15:00 -08:00
parent 48f1c6711e
commit 7ac64532a9
4 changed files with 300 additions and 274 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
doc/nethack.6
View File

@@ -1,5 +1,5 @@
.TH NETHACK 6 "6 March 2004" .TH NETHACK 6 "7 December 2015"
.\" NetHack 3.6 nethack.6 $NHDT-Date: 1432512786 2015/05/25 00:13:06 $ $NHDT-Branch: master $:$NHDT-Revision: 1.10 $ .\" NetHack 3.6 nethack.6 $NHDT-Date: 1449616496 2015/12/08 23:14:56 $ $NHDT-Branch: NetHack-3.6.0 $:$NHDT-Revision: 1.11 $
.SH NAME .SH NAME
nethack \- Exploring The Mazes of Menace nethack \- Exploring The Mazes of Menace
.SH SYNOPSIS .SH SYNOPSIS
@@ -226,10 +226,17 @@ development by the Usenet. Andries Brouwer has made this request for the
distinction, as he may eventually release a new version of his own. distinction, as he may eventually release a new version of his own.
.SH FILES .SH FILES
.PP .PP
All files are in the playground, normally /usr/games/lib/nethackdir. 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.
.br
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 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 will be inside a larger file, normally nhdat, instead of being separate
files. files.
.br .br
.DT .DT
.ta \w'cmdhelp, opthelp, wizhelp\ \ \ 'u .ta \w'cmdhelp, opthelp, wizhelp\ \ \ 'u
@@ -237,7 +244,18 @@ nethack The program itself.
.br .br
data, oracles, rumors Data files used by NetHack. data, oracles, rumors Data files used by NetHack.
.br .br
options, quest.dat More data files. quest.dat, bogusmon More data files.
.br
engrave, epitaph, tribute Still more data files.
.br
symbols Data file holding sets of specifications
.br
for how to display monsters, objects, and
.br
map features.
.br
options Data file containing a description of the
build-time option settings.
.br .br
help, hh Help data files. help, hh Help data files.
.br .br
@@ -253,26 +271,63 @@ license Rules governing redistribution.
.br .br
record The list of top scorers. record The list of top scorers.
.br .br
logfile An extended list of games logfile An extended list of games played
.br .br
played. (optional).
.br .br
xlock.nnn Description of a dungeon level. xlogfile A more detailed version of 'logfile'
.br .br
perm Lock file for xlock.dd. (also optional).
.br .br
bonesDD.nn Descriptions of the ghost and paniclog Record of exceptional conditions
.br .br
belongings of a deceased discovered during program execution.
.br .br
adventurer. xlock.nn Description of dungeon level 'nn' of
.br .br
save A subdirectory containing the active game 'x' if there's a limit on the
.br .br
saved games. number of simultaneously active games.
.br
UUcccccc.nn Alternate form for dungeon level 'nn'
.br
of active game by user 'UU' playing
.br
character named 'cccccc' when there's no
.br
limit on number of active games.
.br
perm Lock file for xlock.0 or UUcccccc.0.
.br
bonesDD.nn Descriptions of the ghost and belongings
.br
of a deceased adventurer who met his
.br
or her demise on level 'nn'.
.br
.\"following line should contain <space><tab>
.br
save/ A subdirectory containing saved games.
.br
.\"following line should contain <space><tab>
.br
sysconf System-wide options. Required if
.br
program is built with 'SYSCF' option
.br
enabled, ignored if not.
.br
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.
.br
In a perfect world, 'paniclog' would remain empty.
.SH ENVIRONMENT .SH ENVIRONMENT
.DT .DT
.ta \w'HACKPAGER or PAGER\ \ \ 'u .ta \w'NETHACKDIR or HACKDIR\ \ \ 'u
USER or LOGNAME Your login name. USER or LOGNAME Your login name.
.br .br
HOME Your home directory. HOME Your home directory.
@@ -289,14 +344,20 @@ MAILREADER Replacement for default reader
.br .br
(probably /bin/mail or /usr/ucb/mail). (probably /bin/mail or /usr/ucb/mail).
.br .br
NETHACKDIR Playground. NETHACKDIR or HACKDIR Playground.
.br .br
NETHACKOPTIONS String predefining several NetHack NETHACKOPTIONS String predefining several NetHack
.br .br
options. options.
.br .br
In addition, SHOPTYPE is used in debugging (wizard) mode. If the same option is specified in both NETHACKOPTIONS and .nethackrc,
the value assigned in NETHACKOPTIONS takes precedence.
.br
SHOPTYPE and SPLEVTYPE can be used in debugging (wizard) mode.
.br
DEBUGFILES can be used if the program was built with 'DEBUG' enabled.
.SH "SEE ALSO" .SH "SEE ALSO"
.PP .PP
dgn_comp(6), lev_comp(6), recover(6) dgn_comp(6), lev_comp(6), recover(6)

293
doc/nethack.txt
View File

@@ -1,4 +1,4 @@
NETHACK(6) NETHACK(6) NETHACK(6) NETHACK(6)
@@ -6,143 +6,150 @@ NAME
nethack - Exploring The Mazes of Menace nethack - Exploring The Mazes of Menace
SYNOPSIS SYNOPSIS
nethack [ -d directory ] [ -n ] [ -p profession ] [ -r race ] [ nethack [ -d directory ] [ -n ] [ -p profession ] [ -r race ] [ -[DX] ]
-[DX] ] [ -u playername ] [ -dec ] [ -ibm ] [ -u playername ] [ -dec ] [ -ibm ]
nethack [ -d directory ] -s [ -v ] [ -p profession ] [ -r race ] nethack [ -d directory ] -s [ -v ] [ -p profession ] [ -r race ] [
[ playernames ] playernames ]
DESCRIPTION DESCRIPTION
NetHack is a display oriented Dungeons & Dragons(tm) - like game. NetHack is a display oriented Dungeons & Dragons(tm) - like game. The
The standard tty display and command structure resemble rogue. standard tty display and command structure resemble rogue.
Other, more graphical display options exist if you are using Other, more graphical display options exist for most platforms.
either a PC, or an X11 interface.
To get started you really only need to know two commands. The To get started you really only need to know two commands. The command
command ? will give you a list of the available commands (as ? will give you a list of the available commands (as well as other
well as other information) and the command / will identify the information) and the command / will identify the things you see on the
things you see on the screen. screen.
To win the game (as opposed to merely playing to beat other peo- To win the game (as opposed to merely playing to beat other people's
ple's high scores) you must locate the Amulet of Yendor which is high scores) you must locate the Amulet of Yendor which is somewhere
somewhere below the 20th level of the dungeon and get it out. below the 20th level of the dungeon and get it out. Few people achieve
Nobody has achieved this yet; anybody who does will probably go this; most never do. Those who have go down in history as heros among
down in history as a hero among heroes. 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 When the game ends, whether by your dying, quitting, or escaping from
from the caves, NetHack will give you (a fragment of) the list of the caves, NetHack will give you (a fragment of) the list of top scor-
top scorers. The scoring is based on many aspects of your behav- ers. The scoring is based on many aspects of your behavior, but a
ior, but a rough estimate is obtained by taking the amount of rough estimate is obtained by taking the amount of gold you've found in
gold you've found in the cave plus four times your (real) experi- the cave plus four times your (real) experience. Precious stones may
ence. Precious stones may be worth a lot of gold when brought to be worth a lot of gold when brought to the exit. There is a 10%
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 The environment variable NETHACKOPTIONS can be used to initialize many
many run-time options. The ? command provides a description of run-time options. The ? command provides a description of these
these options and syntax. (The -dec and -ibm command line options and syntax. (The -dec and -ibm command line options are equiv-
options are equivalent to the decgraphics and ibmgraphics run- alent to the decgraphics and ibmgraphics run-time options described
time options described there, and are provided purely for conve- there, and are provided purely for convenience on systems supporting
nience on systems supporting multiple types of terminals.) multiple types of terminals.)
Because the option list can be very long (particularly when spec- Because the option list can be very long (particularly when specifying
ifying graphics characters), options may also be included in a graphics characters), options may also be included in a configuration
configuration file. The default is located in your home direc- file. The default is located in your home directory and named
tory and named .nethackrc on Unix systems. On other systems, the .nethackrc on Unix systems. On other systems, the default may be dif-
default may be different, usually NetHack.cnf. On DOS or Win- ferent, usually NetHack.cnf. On DOS or Windows, the name is
dows, the name is defaults.nh, while on the Macintosh or BeOS, it defaults.nh, while on the Macintosh or BeOS, it is NetHack Defaults.
is NetHack Defaults. The configuration file's location may be The configuration file's location may be specified by setting NETHACK-
specified by setting NETHACKOPTIONS to a string consisting of an OPTIONS to a string consisting of an @ character followed by the file-
@ character followed by the filename. name.
The -u playername option supplies the answer to the question "Who The -u playername option supplies the answer to the question "Who are
are you?". It overrides any name from the options or configura- you?". It overrides any name from the options or configuration file,
tion file, USER, LOGNAME, or getlogin(), which will otherwise be USER, LOGNAME, or getlogin(), which will otherwise be tried in order.
tried in order. If none of these provides a useful name, the If none of these provides a useful name, the player will be asked for
player will be asked for one. Player names (in conjunction with one. Player names (in conjunction with uids) are used to identify save
uids) are used to identify save files, so you can have several files, so you can have several saved games under different names. Con-
saved games under different names. Conversely, you must use the versely, you must use the appropriate player name to restore a saved
appropriate player name to restore a saved game. game.
A playername suffix can be used to specify the profession, race, A playername suffix can be used to specify the profession, race, align-
alignment and/or gender of the character. The full syntax of the ment and/or gender of the character. The full syntax of the playername
playername that includes a suffix is "name-ppp-rrr-aaa-ggg". that includes a suffix is "name-ppp-rrr-aaa-ggg". "ppp" are at least
"ppp" are at least the first three letters of the profession the first three letters of the profession (this can also be specified
(this can also be specified using a separate -p profession using a separate -p profession option). "rrr" are at least the first
option). "rrr" are at least the first three letters of the char- three letters of the character's race (this can also be specified using
acter's race (this can also be specified using a separate -r race a separate -r race option). "aaa" are at last the first three letters
option). "aaa" are at last the first three letters of the char- of the character's alignment, and "ggg" are at least the first three
acter's alignment, and "ggg" are at least the first three letters letters of the character's gender. Any of the parts of the suffix may
of the character's gender. Any of the parts of the suffix may be be left out.
left out.
-p profession can be used to determine the character profession, -p profession can be used to determine the character profession, also
also known as the role. You can specify either the male or female known as the role. You can specify either the male or female name for
name for the character role, or the first three characters of the the character role, or the first three characters of the role as an
role as an abbreviation. -p @ has been retained to explicitly abbreviation. -p @ has been retained to explicitly request that a ran-
request that a random role be chosen. It may need to be quoted dom role be chosen. It may need to be quoted with a backslash (\@) if
with a backslash (\@) if @ is the "kill" character (see "stty") @ is the "kill" character (see "stty") for the terminal, in order to
for the terminal, in order to prevent the current input line from prevent the current input line from being cleared.
being cleared.
Likewise, -r race can be used to explicitly request that a race Likewise, -r race can be used to explicitly request that a race be cho-
be chosen. sen.
Leaving out any of these characteristics will result in you being Leaving out any of these characteristics will result in you being
prompted during the game startup for the information. prompted during the game startup for the information.
The -s option alone will print out the list of your scores on the The -s option alone will print out the list of your scores on the cur-
current version. An immediately following -v reports on all ver- rent version. An immediately following -v reports on all versions
sions present in the score file. The -s may also be followed by present in the score file. The -s may also be followed by arguments -p
arguments -p and -r to print the scores of particular roles and and -r to print the scores of particular roles and races only. It may
races only. It may also be followed by one or more player names also be followed by one or more player names to print the scores of the
to print the scores of the players mentioned, by 'all' to print players mentioned, by 'all' to print out all scores, or by a number to
out all scores, or by a number to print that many top scores. print that many top scores.
The -n option suppresses printing of any news from the game The -n option suppresses printing of any news from the game administra-
administrator. tor.
The -D or -X option will start the game in a special non-scoring The -D or -X option will start the game in a special non-scoring dis-
discovery mode. -D will, if the player is the game administra- covery mode. -D will, if the player is the game administrator, start
tor, start in debugging (wizard) mode instead. in debugging (wizard) mode instead.
The -d option, which must be the first argument if it appears, The -d option, which must be the first argument if it appears, supplies
supplies a directory which is to serve as the playground. It a directory which is to serve as the playground. It overrides the
overrides the value from NETHACKDIR, HACKDIR, or the directory value from NETHACKDIR, HACKDIR, or the directory specified by the game
specified by the game administrator during compilation (usually administrator during compilation (usually /usr/games/lib/nethackdir).
/usr/games/lib/nethackdir). This option is usually only useful This option is usually only useful to the game administrator. The
to the game administrator. The playground must contain several playground must contain several auxiliary files such as help files, the
auxiliary files such as help files, the list of top scorers, and list of top scorers, and a subdirectory save where games are saved.
a subdirectory save where games are saved.
AUTHORS AUTHORS
Jay Fenlason (+ Kenny Woodland, Mike Thome and Jon Payne) wrote Jay Fenlason (+ Kenny Woodland, Mike Thome and Jon Payne) wrote the
the original hack, very much like rogue (but full of bugs). original hack, very much like rogue (but full of bugs).
Andries Brouwer continuously deformed their sources into an Andries Brouwer continuously deformed their sources into an entirely
entirely different game. different game.
Mike Stephenson has continued the perversion of sources, adding Mike Stephenson has continued the perversion of sources, adding various
various warped character classes and sadistic traps with the help warped character classes and sadistic traps with the help of many
of many strange people who reside in that place between the strange people who reside in that place between the worlds, the Usenet
worlds, the Usenet Zone. A number of these miscreants are immor- Zone. A number of these miscreants are immortalized in the historical
talized in the historical roll of dishonor and various other roll of dishonor and various other places.
places.
The resulting mess is now called NetHack, to denote its develop- The resulting mess is now called NetHack, to denote its development by
ment by the Usenet. Andries Brouwer has made this request for the Usenet. Andries Brouwer has made this request for the distinction,
the distinction, as he may eventually release a new version of as he may eventually release a new version of his own.
his own.
FILES FILES
All files are in the playground, normally Run-time configuration options were discussed above and use a platform
/usr/games/lib/nethackdir. If DLB was defined during the com- specific name for a file in a platform specific location. For Unix,
pile, the data files and special levels will be inside a larger the name is '.nethackrc' in the user's home directory.
file, normally nhdat, instead of being separate files.
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. nethack The program itself.
data, oracles, rumors Data files used by NetHack. data, oracles, rumors Data files used by NetHack.
options, quest.dat More data files. quest.dat, bogusmon More data files.
engrave, epitaph, tribute Still more data files.
symbols Data file holding sets of specifications
for how to display monsters, objects, and
map features.
options Data file containing a description of the
build-time option settings.
help, hh Help data files. help, hh Help data files.
cmdhelp, opthelp, wizhelp More help data files. cmdhelp, opthelp, wizhelp More help data files.
*.lev Predefined special levels. *.lev Predefined special levels.
@@ -150,30 +157,54 @@ FILES
history A short history of NetHack. history A short history of NetHack.
license Rules governing redistribution. license Rules governing redistribution.
record The list of top scorers. record The list of top scorers.
logfile An extended list of games logfile An extended list of games played
played. (optional).
xlock.nnn Description of a dungeon level. xlogfile A more detailed version of 'logfile'
perm Lock file for xlock.dd. (also optional).
bonesDD.nn Descriptions of the ghost and paniclog Record of exceptional conditions
belongings of a deceased discovered during program execution.
adventurer. xlock.nn Description of dungeon level 'nn' of
save A subdirectory containing the active game 'x' if there's a limit on the
saved games. number of simultaneously active games.
UUcccccc.nn Alternate form for dungeon level 'nn'
of active game by user 'UU' playing
character named 'cccccc' when there's no
limit on number of active games.
perm Lock file for xlock.0 or UUcccccc.0.
bonesDD.nn Descriptions of the ghost and belongings
of a deceased adventurer who met his
or her demise on level 'nn'.
save/ A subdirectory containing saved games.
sysconf System-wide options. Required if
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
program.
In a perfect world, 'paniclog' would remain empty.
ENVIRONMENT ENVIRONMENT
USER or LOGNAME Your login name. USER or LOGNAME Your login name.
HOME Your home directory. HOME Your home directory.
SHELL Your shell. SHELL Your shell.
TERM The type of your terminal. TERM The type of your terminal.
HACKPAGER or PAGER Replacement for default pager. HACKPAGER or PAGER Replacement for default pager.
MAIL Mailbox file. MAIL Mailbox file.
MAILREADER Replacement for default reader MAILREADER Replacement for default reader
(probably /bin/mail or /usr/ucb/mail). (probably /bin/mail or /usr/ucb/mail).
NETHACKDIR Playground. NETHACKDIR or HACKDIR Playground.
NETHACKOPTIONS String predefining several NetHack NETHACKOPTIONS String predefining several NetHack
options. options.
In addition, SHOPTYPE is used in debugging (wizard) mode. 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.
DEBUGFILES can be used if the program was built with 'DEBUG' enabled.
SEE ALSO SEE ALSO
dgn_comp(6), lev_comp(6), recover(6) dgn_comp(6), lev_comp(6), recover(6)
@@ -187,4 +218,4 @@ BUGS
6 March 2004 NETHACK(6) 7 December 2015 NETHACK(6)

25
doc/recover.6
View File

@@ -1,5 +1,5 @@
.TH RECOVER 6 "9 January 1993" .TH RECOVER 6 "7 December 2015"
.\" NetHack 3.6 recover.6 $NHDT-Date: 1432512786 2015/05/25 00:13:06 $ $NHDT-Branch: master $:$NHDT-Revision: 1.6 $ .\" NetHack 3.6 recover.6 $NHDT-Date: 1449616497 2015/12/08 23:14:57 $ $NHDT-Branch: NetHack-3.6.0 $:$NHDT-Revision: 1.7 $
.UC 4 .UC 4
.SH NAME .SH NAME
recover \- recover a NetHack game interrupted by disaster recover \- recover a NetHack game interrupted by disaster
@@ -34,26 +34,11 @@ It overrides the value from NETHACKDIR, HACKDIR, or the directory
specified by the game administrator during compilation specified by the game administrator during compilation
(usually /usr/games/lib/nethackdir). (usually /usr/games/lib/nethackdir).
.PP .PP
^?ALLDOCS
For recovery to be possible, For recovery to be possible,
.I nethack the run-time option
must have been compiled with the INSURANCE option, and the run-time option
.I checkpoint .I checkpoint
must also have been on. must have been on.
^: .PP
^?INSURANCE
For recovery to be possible,
.I nethack
must have been compiled with the INSURANCE option (this configuration was),
and the run-time option
.I checkpoint
must also have been on.
^:
This configuration of
.I nethack
was created without support for recovery.
^.
^.
NetHack normally writes out files for levels as the player leaves them, NetHack normally writes out files for levels as the player leaves them,
so they will be ready for return visits. so they will be ready for return visits.
When checkpointing, NetHack also writes out the level entered and When checkpointing, NetHack also writes out the level entered and

163
doc/recover.txt
View File

@@ -1,132 +1,81 @@
RECOVER(6) RECOVER(6)
RECOVER(6) 1993 RECOVER(6)
NAME NAME
recover - recover a NetHack game interrupted by disaster recover - recover a NetHack game interrupted by disaster
SYNOPSIS SYNOPSIS
recover [ -d directory ] base1 base2 ... recover [ -d directory ] base1 base2 ...
DESCRIPTION DESCRIPTION
Occasionally, a NetHack game will be interrupted by disaster Occasionally, a NetHack game will be interrupted by disaster when the
when the game or the system crashes. Prior to NetHack v3.1, game or the system crashes. Prior to NetHack v3.1, these games were
these games were lost because various information like the lost because various information like the player's inventory was kept
player's inventory was kept only in memory. Now, all per- only in memory. Now, all pertinent information can be written out to
tinent information can be written out to disk, so such games disk, so such games can be recovered at the point of the last level
can be recovered at the point of the last level change. change.
The base options tell recover which files to process. Each The base options tell recover which files to process. Each base option
base option specifies recovery of a separate game. specifies recovery of a separate game.
The -d option, which must be the first argument if it The -d option, which must be the first argument if it appears, supplies
appears, supplies a directory which is the NetHack play- a directory which is the NetHack playground. It overrides the value
ground. It overrides the value from NETHACKDIR, HACKDIR, or from NETHACKDIR, HACKDIR, or the directory specified by the game admin-
the directory specified by the game administrator during istrator during compilation (usually /usr/games/lib/nethackdir).
compilation (usually /usr/games/lib/nethackdir).
For recovery to be possible, nethack must have been compiled For recovery to be possible, the run-time option checkpoint must have
with the INSURANCE option, and the run-time option check- been on.
point 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 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 NetHack normally writes out files for levels as the player leaves them,
internal bookkeeping number for the level. The file base.0 so they will be ready for return visits. When checkpointing, NetHack
is used for game identity, locking, and, when checkpointing, also writes out the level entered and the current game state on every
for the game state. Various OSes use different strategies level change. This naturally slows level changes down somewhat.
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 play-
ground 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 The level file names are of the form base.nn, where nn is an internal
playground and create files in the save directory, it has bookkeeping number for the level. The file base.0 is used for game
interesting interactions with game security. Giving ordi- identity, locking, and, when checkpointing, for the game state. Vari-
nary players access to recover through setuid or setgid is ous OSes use different strategies for constructing the base name.
tantamount to leaving the playground world-writable, with Microcomputers use the character name, possibly truncated and modified
respect to both cheating and messing up other players. For 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
some of the microcomputer ports install recover by default.
For a multi-user system, the game administrator may want to arrange for
January Last change: 9 1 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.
RECOVER(6) 1993 RECOVER(6)
a single-user system, this of course does not change any-
thing, 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 machine boots, and handle game crashes
individually. If the user population is sufficiently
trustworthy, recover can be installed with the same permis-
sions the nethack executable has. In either case, recover
is easily compiled from the distribution utility directory.
NOTES NOTES
Like nethack itself, recover will overwrite existing save- Like nethack itself, recover will overwrite existing savefiles of the
files of the same name. Savefiles created by recover are same name. Savefiles created by recover are uncompressed; they may be
uncompressed; they may be compressed afterwards if desired, compressed afterwards if desired, but even a compression-using nethack
but even a compression-using nethack will find them in the will find them in the uncompressed form.
uncompressed form.
SEE ALSO SEE ALSO
nethack(6) nethack(6)
BUGS BUGS
recover makes no attempt to find out if a base name speci- recover makes no attempt to find out if a base name specifies a game in
fies a game in progress. If multiple machines share a play- progress. If multiple machines share a playground, this would be
ground, this would be impossible to determine. impossible to determine.
recover should be taught to use the nethack playground lock- recover should be taught to use the nethack playground locking mecha-
ing mechanism to avoid conflicts. nism to avoid conflicts.
January Last change: 9 2
4th Berkeley Distribution 7 December 2015 RECOVER(6)