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

This is cron-daily v1-May-7-2026. 005manpages updated: recover.txt

Browse Source
This commit is contained in:
nhw_cron
2026-05-07 23:24:22 -04:00
committed by nhmall
parent 4938a85068
commit 92734c3283
1 changed files with 26 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/recover.txt
+26 -26
View File
@@ -6,39 +6,39 @@ 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 playground-directory] base ...
DESCRIPTION DESCRIPTION
Occasionally, a NetHack game will be interrupted by disaster when the Occasionally, a NetHack game is interrupted by disaster when the pro-
game or the system crashes. Prior to NetHack v3.1, these games were gram 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 information like the player's inventory was kept only in
only in memory. Now, all pertinent information can be written out to memory. Now, all pertinent information can be written out to disk, so
disk, so such games can be recovered at the point of the last level such games can be recovered at the point of the last level change.
change.
The base options tell recover which files to process. Each base option Base operands tell recover which files to process. Each base specifies
specifies recovery of a separate game. recovery of a separate game.
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 the directory housing the NetHack playground. It overrides the value
from NETHACKDIR, HACKDIR, or the directory specified by the game admin- of the environment variables NETHACKDIR and HACKDIR, and the directory
istrator during compilation (usually /usr/games/lib/nethackdir). specified by the game administrator during compilation (usually
NetHack normally writes out files for levels as the player leaves them, /usr/games/lib/nethackdir). nethack(6) normally writes out files for
so they will be ready for return visits. When checkpointing, NetHack levels as the player leaves them, so they will be ready for return vis-
also writes out the level entered and the current game state on every its. When checkpointing, it also writes out the level entered and the
level change. This naturally slows level changes down somewhat. current game state on every level change. This procedure slows level
changes.
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. Sin-
Microcomputers use the character name, possibly truncated and modified gle-user systems use the character name, possibly truncated and modi-
to be a legal filename on that system. Multi-user systems use the fied to be a legal filename on that system. Multi-user systems use the
(modified) character name prefixed by a user number to avoid conflicts, (modified) character name prefixed by a user number to avoid conflicts,
or "xlock" if the number of concurrent players is being limited. It or 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 transforms these level files into a save
into a save file of the same name as nethack would have used. file of the same name that 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
@@ -46,7 +46,7 @@ DESCRIPTION
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 these 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
@@ -56,7 +56,7 @@ DESCRIPTION
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 save files 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.