]> granicus.if.org Git - nethack/commitdiff
documentation updates
authorcohrs <cohrs>
Tue, 12 Mar 2002 07:29:59 +0000 (07:29 +0000)
committercohrs <cohrs>
Tue, 12 Mar 2002 07:29:59 +0000 (07:29 +0000)
- various commands were missing from various help files
- fix a few inconsistencies between similar help files
- M-2 doesn't do #twoweapon when number_pad is enabled
- M-? usually displays #? help info
- weasel-word the reason the screen shown in the Guidebook looks little like
  several windowports
- document the playersuffix syntax in the nethack.6 man page

dat/cmdhelp
dat/help
dat/hh
doc/Guidebook.mn
doc/Guidebook.tex
doc/nethack.6

index e6d018920d7195e7b7207281afdc4b3dfdb0b0e6..790c528d0598295ee8402ca074fc644c9077199e 100644 (file)
@@ -30,7 +30,7 @@ f       Fire ammunition from quiver
 F       Followed by direction, fight a monster (even if you don't sense it)
 g       Followed by direction, move until you are near something
 G       Followed by direction, same as control-direction
-h       Go west 1 space
+h       Go west 1 space (if number_pad is on, display help message)
 H       Go west until you are on top of something
 ^H      Go west until you are near something
 i       Show your inventory
@@ -98,7 +98,8 @@ _       Travel via a shortest-path algorithm to a point on the map
 $       Count your gold
 +       List known spells
 #       Perform an extended command
-M-2     Toggle two-weapon combat
+M-?     Display extended command help (if the platform allows this)
+M-2     Toggle two-weapon combat (unless number_pad is enabled)
 M-a     Adjust inventory letters
 M-c     Talk to someone
 M-d     Dip an object into something
index 0216addd92d229cbc167a26749dae82843c60f6b..3e6aac6eabd882dec427053309a9eed083e68b83 100644 (file)
--- a/dat/help
+++ b/dat/help
@@ -43,7 +43,7 @@ on.
         \        An opulent throne.
         `        A boulder or statue.
         A to Z, a to z, and several others:  Monsters.
-        I        Invisible monster's last known location
+        I        Invisible or unseen monster's last known location
 
                  You can find out what a symbol represents by typing
                  '/' and following the directions to move the cursor
@@ -60,7 +60,10 @@ b j n   1 2 3           g<dir>:   run in direction <dir> until something
                         G<dir>,   same, except a branching corridor isn't
  <  up                  ^<dir>:     considered interesting
  >  down                m<dir>:   move without picking up objects
+                        F<dir>:   fight even if you don't sense a monster
                 If the number_pad option is set, the number keys move instead.
+                Depending on the platform, Shift number (on the numberpad),
+                Meta number, or Alt number will invoke the YUHJKLBN commands.
 
 Commands:
         NetHack knows the following commands:
@@ -162,15 +165,17 @@ Commands:
                 has a meta key (which, when pressed in combination with another
                 key, modifies it by setting the 'meta' (8th, or 'high') bit),
                 these extended commands can be invoked by meta-ing the first
-                letter of the command.
+                letter of the command.  An alt key may have a similar effect.
 
         If the "number_pad" option is on, some additional letter commands
         are available:
 
+        h       displays the help menu, like '?'
         j       Jump to another location.
         k       Kick (for doors, usually).
         l       Loot a box on the floor.
-        n       Name an object or type of object.
+        n       followed by number of times to repeat the next command
+        N       Name an object or type of object.
         u       Untrap a trapped object or door.
 
         You can put a number before a command to repeat it that many times,
@@ -178,7 +183,8 @@ Commands:
         must type 'n' to prefix the count, as in "n40." or "n20s".
 
 
-        Some information is displayed on the bottom line.  You see your
+        Some information is displayed on the bottom line or perhaps in a
+        box, depending on the platform you are using.  You see your
         attributes, your alignment, what dungeon level you are on, how many
         hit points you have now (and will have when fully recovered), what
         your armor class is (the lower the better), your experience level,
diff --git a/dat/hh b/dat/hh
index e5ad45e8f97a774df1b7a8f5e04372437557fd8f..3f85d8797c74171b55c24c4d04248d983c387564 100644 (file)
--- a/dat/hh
+++ b/dat/hh
@@ -9,6 +9,8 @@ b j n   1 2 3           g<dir>:   run in direction <dir> until something
  >  down                m<dir>:   move without picking up objects/fighting
                         F<dir>:   fight even if you don't sense a monster
                 If the number_pad option is set, the number keys move instead.
+                Depending on the platform, Shift number (on the numberpad),
+                Meta number, or Alt number will invoke the YUHJKLBN commands.
 
 General commands:
 ?       help    display one of several informative texts
@@ -78,7 +80,8 @@ _       travel  move via a shortest-path algorithm to a point on the map
 Keyboards that have a meta key can also use these extended commands
 via the meta modifier instead of the # prefix:
 
-M-2     twoweapon toggle two-weapon combat
+M-?             Display extended command help (if the platform allows this)
+M-2     twoweapon toggle two-weapon combat (unless number_pad is enabled)
 M-a     adjust  adjust inventory letters
 M-c     chat    talk to someone
 M-d     dip     dip an object into something
@@ -102,6 +105,7 @@ M-w     wipe    wipe off your face
 If the "number_pad" option is on, these additional variants are available:
 
 n               followed by number of times to repeat the next command
+h       help    display one of several informative texts, like '?'
 j       jump    jump to another location
 k       kick    kick something (usually a door)
 l       loot    loot a box on the floor
index e47b86f3a24014d6221cd2db2ada3fd15e8b693c..ba4db132a2d321eb20433a2f6b0d2b9cda0f4ddf 100644 (file)
@@ -189,6 +189,7 @@ In order to understand what is going on in NetHack, first you must
 understand what NetHack is doing with the screen.  The NetHack screen
 replaces the ``You see ...'' descriptions of text adventure games.
 Figure 1 is a sample of what a NetHack screen might look like.
+The way the screen looks for you depends on your platform.
 
 .TS S
 center tab(~);
@@ -205,7 +206,7 @@ The bat bites!
 
 
 
-Player the Rambler         St:12 Dx:7 Co:18 In:11 Wi:9 Ch:15  Neutral
+Player the Rambler     St:12 Dx:7 Co:18 In:11 Wi:9 Ch:15  Neutral
 Dlvl:1 $:0  HP:9(12) Pw:3(3) AC:10 Exp:1/19 T:257 Weak
 
 _
@@ -719,8 +720,10 @@ letter of the command.
 .\" on the Amiga set the {\it altmeta\/} option to get this behavior.
 In NT, OS/2, and PC NetHack, the `Alt' key
 can be used in this fashion.
+.lp M-?
+#? (not supported by all platforms)
 .lp M-2
-#twoweapon
+#twoweapon (unless the number_pad option is enabled)
 .lp M-a
 #adjust
 .lp M-c
@@ -763,6 +766,8 @@ can be used in this fashion.
 If the
 .op number_pad
 option is on, some additional letter commands are available:
+.lp h
+Help menu:  display one of several help texts available, like ``?''.
 .lp j
 Jump to another location.  Same as ``#jump'' or ``M-j''.
 .lp k
@@ -771,7 +776,7 @@ Kick something (usually a door).  Same as `^D'.
 Loot a box or bag on the floor beneath you, or the saddle 
 from a horse standing next to you.  Same as ``#loot'' or ``M-l''.
 .lp N
-Name an item or type of object.  Same as ``#name'' or ``M-N''.
+Name an item or type of object.  Same as ``#name'' or ``M-n''.
 .lp u
 Untrap a trap, door, or chest.  Same as ``#untrap'' or ``M-u''.
 
index 5dd07be1496166d73d726cc3d6c43023e9ba186d..b37db014309a881ce14836af4abc5056bc5752ee 100644 (file)
@@ -274,6 +274,7 @@ In order to understand what is going on in {\it NetHack}, first you must
 understand what {\it NetHack\/} is doing with the screen.  The {\it NetHack\/}
 screen replaces the ``You see \ldots'' descriptions of text adventure games.
 Figure 1 is a sample of what a {\it NetHack\/} screen might look like.
+The way the screen looks for you depends on your platform.
 
 \vbox{
 \begin{verbatim}
@@ -288,7 +289,7 @@ Figure 1 is a sample of what a {\it NetHack\/} screen might look like.
 
 
 
-        Player the Rambler         St:12 Dx:7 Co:18 In:11 Wi:9 Ch:15  Neutral
+        Player the Rambler     St:12 Dx:7 Co:18 In:11 Wi:9 Ch:15  Neutral
         Dlvl:1  $:0  HP:9(12) Pw:3(3) AC:10 Exp:1/19 T:257 Weak
 \end{verbatim}
 \begin{center}
@@ -960,9 +961,12 @@ letter of the command.
 In {\it NT, OS/2, {\rm and} PC NetHack},
 the `Alt' key can be used in this fashion.
 \blist{}
+%.lp 
+\item[\tb{M-?}]
+{\tt\#?} (not supported by all platforms)
 %.lp
 \item[\tb{M-2}]
-{\tt\#twoweapon}
+{\tt\#twoweapon} (unless the {\it number\_pad\/} option is enabled)
 %.lp
 \item[\tb{M-a}]
 {\tt\#adjust}
@@ -1026,6 +1030,9 @@ the `Alt' key can be used in this fashion.
 \nd If the {\it number\_pad\/} option is on, some additional letter commands
 are available:
 \blist{}
+%.lp 
+\item[\tb{h}]
+Help menu:  display one of several help texts available, like ``{\tt ?}''.
 %.lp
 \item[\tb{j}]
 Jump to another location.  Same as ``{\tt \#jump}'' or ``{\tt M-j}''.
@@ -1038,7 +1045,7 @@ Loot a box or bag on the floor beneath you, or the saddle
 from a horse standing next to you.  Same as ``{\tt \#loot}'' or ``{\tt M-l}''.
 %.lp
 \item[\tb{N}]
-Name an object or type of object.  Same as ``{\tt \#name}'' or ``{\tt M-N}''.
+Name an object or type of object.  Same as ``{\tt \#name}'' or ``{\tt M-n}''.
 %.lp
 \item[\tb{u}]
 Untrap a trap, door, or chest.  Same as ``{\tt \#untrap}'' or ``{\tt M-u}''.
index 923be69031afd970435b7e54cab8c93d68ffc383..5d248eef551d77b28ec77218e0b633adc4631195 100644 (file)
@@ -1,8 +1,10 @@
-.TH NETHACK 6 "17 November 1999"
+.TH NETHACK 6 "12 March 2002"
 .UC 4
 .SH NAME
 nethack \- Exploring The Mazes of Menace
 .SH SYNOPSIS
+.na
+.hy 0
 .B nethack
 [
 .B \-d
@@ -32,7 +34,7 @@ nethack \- Exploring The Mazes of Menace
 [
 .B \-ibm
 ]
-.br
+.PP
 .B nethack
 [
 .B \-d
@@ -53,6 +55,8 @@ nethack \- Exploring The Mazes of Menace
 [
 .I playernames
 ]
+.ad
+.hy 14
 .SH DESCRIPTION
 .PP
 .I NetHack
@@ -105,8 +109,8 @@ graphics characters), options may also be included in a configuration
 file.
 The default is located in your home directory and
 named .nethackrc on Unix systems.  On other systems, the default may be
-different, usually NetHack.cnf.  On DOS the name is defaults.nh, while
-on the Macintosh or BeOS, it is NetHack Defaults.
+different, usually NetHack.cnf.  On DOS or Windows, the name is
+defaults.nh, while on the Macintosh or BeOS, it is NetHack Defaults.
 The configuration file's location may be specified by setting NETHACKOPTIONS
 to a string consisting of an @ character followed by the filename.
 .PP
@@ -123,7 +127,20 @@ Conversely, you must use the appropriate player name to restore a saved game.
 .PP
 A
 .I playername
-suffix or a separate option,
+suffix can be used to specify the profession, race, alignment 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 
+.B \-p
+.I profession
+option).  "rrr" are at least the first three letters of the character's
+race (this can also be specified using a separate 
+.B \-r
+.I race
+option).  "aaa" are at last 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 be left out.
+.PP
 .B \-p
 .I profession
 can be used to determine the character role.  You can specify either the
@@ -140,9 +157,9 @@ Likewise,
 .I race
 can be used to explicitly request that a race be chosen.
 .PP
+Leaving out any of these characteristics will result in you being prompted
+during the game startup for the information.
 .PP
-Leaving out either of these will result in you being prompted during
-the game startup for the information.
 .PP
 The
 .B \-s