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

This is cron-daily v1-Jan-14-2020. manpages updated: recover.txt

Browse Source
This commit is contained in:
nhw_cron
2020-01-14 11:17:43 -05:00
committed by nhmall
parent 0415a5a235
commit 2e570e03e9
1 changed files with 65 additions and 108 deletions
Download Patch File Download Diff File Expand all files Collapse all files

173
doc/recover.txt
View File

@@ -1,132 +1,89 @@
RECOVER(6) Games Manual 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 ^?ALLDOCS For recovery to be possible, nethack must have been compiled
with the INSURANCE option, and the run-time option check- with the INSURANCE option, and the run-time option checkpoint must also
point must also have been on. NetHack normally writes out have been on. ^: ^?INSURANCE For recovery to be possible, nethack must
files for levels as the player leaves them, so they will be have been compiled with the INSURANCE option (this configuration was),
ready for return visits. When checkpointing, NetHack also and the run-time option checkpoint must also have been on. ^: This
writes out the level entered and the current game state on configuration of nethack was created without support for recovery. ^.
every level change. This naturally slows level changes down ^. NetHack normally writes out files for levels as the player leaves
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 The level file names are of the form base.nn, where nn is an internal
internal bookkeeping number for the level. The file base.0 bookkeeping number for the level. The file base.0 is used for game
is used for game identity, locking, and, when checkpointing, identity, locking, and, when checkpointing, for the game state. Vari-
for the game state. Various OSes use different strategies ous OSes use different strategies for constructing the base name.
for constructing the base name. Microcomputers use the Microcomputers use the character name, possibly truncated and modified
character name, possibly truncated and modified to be a to be a legal filename on that system. Multi-user systems use the
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 or "xlock" if the number of concurrent players is being limited. It
conflicts, or "xlock" if the number of concurrent players is may be necessary to look in the playground to find the correct base
being limited. It may be necessary to look in the play- name of the interrupted game. recover will transform these level files
ground to find the correct base name of the interrupted into a save file of the same name as nethack would have used.
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 Since recover must be able to read and delete files from the playground
playground and create files in the save directory, it has and create files in the save directory, it has interesting interactions
interesting interactions with game security. Giving ordi- with game security. Giving ordinary players access to recover through
nary players access to recover through setuid or setgid is setuid or setgid is tantamount to leaving the playground world-
tantamount to leaving the playground world-writable, with writable, with respect to both cheating and messing up other players.
respect to both cheating and messing up other players. For 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
January Last change: 9 1 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.
COPYRIGHT
This file is Copyright (C) Kenneth Lorber and was last modified
2018/04/25 (version NetHack-3.6.0:1.9). NetHack may be freely redis-
tributed. See license for details.
January Last change: 9 2
NETHACK 14 December 2015 RECOVER(6)