documentation updates

- 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
This commit is contained in:
cohrs
2002-03-12 07:29:59 +00:00
parent 5673ae6e94
commit ef11d4b5e0
6 changed files with 60 additions and 20 deletions

View 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''.

View 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}''.

View 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