From e6e0913878f69a47ade98acbea5b87ca9554ae8c Mon Sep 17 00:00:00 2001 From: nhmall Date: Thu, 26 Dec 2024 17:34:18 -0500 Subject: [PATCH] doc/* from cron job --- doc/Guidebook.txt | 230 +++++++++++++++++++++++----------------------- doc/dlb.txt | 29 +++--- doc/makedefs.txt | 69 +++++++------- doc/nethack.txt | 201 ++++++++++++++++++++-------------------- doc/recover.txt | 71 +++++++------- 5 files changed, 294 insertions(+), 306 deletions(-) diff --git a/doc/Guidebook.txt b/doc/Guidebook.txt index 480c55893..73e12bdb0 100644 --- a/doc/Guidebook.txt +++ b/doc/Guidebook.txt @@ -15,7 +15,7 @@ Original version - Eric S. Raymond (Edited and expanded for NetHack 3.7.0 by Mike Stephenson and others) - November 16, 2024 + December 25, 2024 @@ -126,7 +126,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -192,7 +192,7 @@ NetHack continues this fine tradition. Unlike text adventure games - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -258,7 +258,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -324,7 +324,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -390,7 +390,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -456,7 +456,7 @@ The number of turns elapsed so far, displayed if you have the - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -522,7 +522,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -588,7 +588,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -654,7 +654,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -720,7 +720,7 @@ instead. Only these one-step movement commands cause you to - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -786,7 +786,7 @@ ing . ^ is used as shorthand elsewhere in the - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -852,7 +852,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -918,7 +918,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -984,7 +984,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -1050,7 +1050,7 @@ at an adjacent "remembered, unseen monster" marker. - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -1116,7 +1116,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -1182,7 +1182,7 @@ (R)UNIX is a registered trademark of The Open Group. - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -1248,7 +1248,7 @@ menu_next_page, and menu_last_page keys (`^', `<', `>', `|' by - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -1314,7 +1314,7 @@ doesn't and give that name to the result, while splitting (count - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -1380,7 +1380,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -1446,7 +1446,7 @@ extinct. - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -1512,7 +1512,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -1578,7 +1578,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -1644,7 +1644,7 @@ right away.) Since using this command by accident can cause - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -1710,7 +1710,7 @@ Default key is `M-R'. - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -1776,7 +1776,7 @@ (worn blindfold or towel or lenses, lit lamp(s) and/or candle(s), - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -1842,7 +1842,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -1908,7 +1908,7 @@ line will show "(no travel path)" if your character does not know - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -1974,7 +1974,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -2040,7 +2040,7 @@ Set one or more intrinsic attributes. Autocompletes. Debug mode - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -2106,7 +2106,7 @@ "high"] bit), you can invoke many extended commands by meta-ing the - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -2172,7 +2172,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -2238,7 +2238,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -2304,7 +2304,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -2370,7 +2370,7 @@ them). Some monsters who can open doors can also use unlocking tools. - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -2436,7 +2436,7 @@ been nullified, giving access to whatever is beyond them. In the - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -2502,7 +2502,7 @@ play. - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -2568,7 +2568,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -2634,7 +2634,7 @@ attack, when guessing where an unseen monster is or when deliberately - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -2700,7 +2700,7 @@ noid_confirmation:attack option to require a response of "yes" - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -2766,7 +2766,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -2832,7 +2832,7 @@ are encumbered, one of the conditions Burdened, Stressed, Strained, - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -2898,7 +2898,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -2964,7 +2964,7 @@ `X' command to engage or disengage that. Only some types of charac- - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -3030,7 +3030,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -3096,7 +3096,7 @@ you'll be told that you feel more confident in your skills. At that - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -3162,7 +3162,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -3228,7 +3228,7 @@ what you eat." - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -3294,7 +3294,7 @@ ever, for this is often unwise. Other types of wands don't require a - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -3360,7 +3360,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -3426,7 +3426,7 @@ play the entire game without being able to see (a self-imposed chal- - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -3492,7 +3492,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -3558,7 +3558,7 @@ set the goldX option if you prefer to have gold pieces be treated as - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -3624,7 +3624,7 @@ eating such items still counts against foodless conduct. - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -3690,7 +3690,7 @@ "X" (the traditional signature of an illiterate person). Reading an - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -3756,7 +3756,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -3822,7 +3822,7 @@ achievement. - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -3888,7 +3888,7 @@ (the closing `]' can be followed by whitespace and then an arbitrary - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -3954,7 +3954,7 @@ problems is kept. Defaults to HACKDIR, must be writable. - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -4020,7 +4020,7 @@ Custom symbols for the rogue level's symbol set. See SYMBOLS below. - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -4086,7 +4086,7 @@ You turn one of these on by adding the name of the option to the list, - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -4152,7 +4152,7 @@ and the non-human races restrict which alignments are allowed. See - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -4218,7 +4218,7 @@ wielded weapon (if you omit untrap or decline to attempt - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -4284,7 +4284,7 @@ If this option is on, items you dropped will not be automatically - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -4350,7 +4350,7 @@ Name your starting dog (for example "dogname:Fang"). Cannot be set - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -4416,7 +4416,7 @@ blessed or cursed, but it is not described as "uncursed" even when - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -4482,7 +4482,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -4548,7 +4548,7 @@ response to the Drop (aka droptype) command, for instance). The - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -4614,7 +4614,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -4680,7 +4680,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -4746,7 +4746,7 @@ are filled in at the end from the previous order. - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -4812,7 +4812,7 @@ new entries and remove some old ones, you can use multiple para- - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -4878,7 +4878,7 @@ Persistent. - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -4944,7 +4944,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -5010,7 +5010,7 @@ trol+direction and so forth, or via the travel command or mouse - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -5076,7 +5076,7 @@ ants, or you are making screenshots or streaming video. Using the - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -5142,7 +5142,7 @@ others; - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -5208,7 +5208,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -5274,7 +5274,7 @@ on a doorway, it will consider the area on the side of the door you - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -5340,7 +5340,7 @@ right) - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -5406,7 +5406,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -5472,7 +5472,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -5538,7 +5538,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -5604,7 +5604,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -5670,7 +5670,7 @@ strokes that the operating system returns to NetHack to help compen- - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -5736,7 +5736,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -5802,7 +5802,7 @@ The menu control or accelerator keys can also be rebound via OPTIONS - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -5868,7 +5868,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -5934,7 +5934,7 @@ ing for more info, and exit the location asking loop. Default is - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -6000,7 +6000,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -6066,7 +6066,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -6132,7 +6132,7 @@ cause the hitpoints field to display in the color red if your hit- - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -6198,7 +6198,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -6264,7 +6264,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -6330,7 +6330,7 @@ value, and the ^ prefix causes the following character to be treated - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -6396,7 +6396,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -6462,7 +6462,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -6528,7 +6528,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -6594,7 +6594,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -6660,7 +6660,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -6726,7 +6726,7 @@ seen via the "#attributes" command. - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -6792,7 +6792,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -6858,7 +6858,7 @@ the livelog file if one is present. The sample sysconf file accom- - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -6924,7 +6924,7 @@ are left for the trepid reader to discover. - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -6990,7 +6990,7 @@ 1.4 in 1987. He then coordinated a cast of thousands in enhancing and - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -7056,7 +7056,7 @@ NetHack 3.1 to the Atari. Pat Rankin, with help from Joshua - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -7122,7 +7122,7 @@ Slash'EM, and with the help of Kevin Hugo, added more features. Kevin - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -7188,7 +7188,7 @@ the Macintosh port of 3.4. - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -7254,7 +7254,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -7320,7 +7320,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -7386,7 +7386,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -7452,7 +7452,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -7518,7 +7518,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 @@ -7584,7 +7584,7 @@ - NetHack 3.7.0 November 16, 2024 + NetHack 3.7.0 December 25, 2024 diff --git a/doc/dlb.txt b/doc/dlb.txt index 9e59bfd21..412c19820 100644 --- a/doc/dlb.txt +++ b/doc/dlb.txt @@ -1,10 +1,7 @@ -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 @@ -12,18 +9,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 + 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- @@ -37,11 +34,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 @@ -58,16 +55,16 @@ SEE ALSO nethack(6), tar(1) BUGS - Not a good tar emulation; - does not mean stdin or stdout. Should - include 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, 2024 for version keni-git- - set:1.13. NetHack may be freely redistributed. See license for + This file is Copyright (C) Kenneth Lorber, 2024 for version keni-git- + set:1.13. NetHack may be freely redistributed. See license for details. -Project(uc) 24 December 2024 DLB(6) +NETHACK 25 December 2024 DLB(6) diff --git a/doc/makedefs.txt b/doc/makedefs.txt index e8c3a6c81..e784946c3 100644 --- a/doc/makedefs.txt +++ b/doc/makedefs.txt @@ -1,10 +1,7 @@ -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 @@ -14,11 +11,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. @@ -29,11 +26,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. @@ -56,7 +53,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 @@ -64,66 +61,66 @@ 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 + 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 - allows certain changes such as embedding platform-specific documenta- + 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 - detected; 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 - error. Note that --undef or #undef in the NetHack(6) con- + - 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: @@ -146,10 +143,10 @@ AUTHOR The NetHack Development Team COPYRIGHT - This file is Copyright (C) Kenneth Lorber, 2024 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. -Project(uc) 24 December 2024 MAKEDEFS(6) +NETHACK 25 December 2024 MAKEDEFS(6) diff --git a/doc/nethack.txt b/doc/nethack.txt index 80c7870f2..ca120c3e0 100644 --- a/doc/nethack.txt +++ b/doc/nethack.txt @@ -1,10 +1,7 @@ -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 @@ -23,84 +20,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- @@ -111,97 +108,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. @@ -247,11 +244,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. @@ -268,7 +265,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. @@ -281,12 +278,12 @@ BUGS Probably infinite. COPYRIGHT - This file is Copyright (C) Robert Patrick Rankin, 2024 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. -Project(uc) 24 December 2024 NETHACK(6) +NETHACK 25 December 2024 NETHACK(6) diff --git a/doc/recover.txt b/doc/recover.txt index 49c583642..09e05f4fd 100644 --- a/doc/recover.txt +++ b/doc/recover.txt @@ -1,10 +1,7 @@ -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 @@ -12,60 +9,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. - Microcomputers use the character name, possibly truncated and modified - to be a legal filename on that system. Multi-user systems use the + 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 + 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 + 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 + 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 @@ -73,17 +70,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 + 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, 2024 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. -Project(uc) 24 December 2024 RECOVER(6) +NETHACK 25 December 2024 RECOVER(6)