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

nethack man page updates

Browse Source 
- as requested by ESR, remove the use of parentheses from the usage
summary, it confused some man page conversion tool he has
- updated documentation for the -p option to mention the word "role"
so anyone search for role in the man page will still find it
- removed use of .UC, it is listed as deprecated in all the current man
documentation I could find, when it was even documented at all
- other minor spelling and formatting (hyphenation) changes
This commit is contained in:
cohrs
2004-03-26 17:23:15 +00:00
parent 8e4821a8f2
commit f349b74e0b
3 changed files with 126 additions and 141 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/fixes34.4
+2
View File
@@ -24,6 +24,8 @@ if your blindfold glows and you're not otherwise blinded, you can see it
Platform- and/or Interface-Specific Fixes Platform- and/or Interface-Specific Fixes
----------------------------------------- -----------------------------------------
unix: remove use of parentheses in nethack man page usage that confused a
man page conversion tool
General New Features General New Features
doc/nethack.6
+9 -8
View File
@@ -1,5 +1,4 @@
.TH NETHACK 6 "9 August 2002" .TH NETHACK 6 "6 March 2004"
.UC 4
.SH NAME .SH NAME
nethack \- Exploring The Mazes of Menace nethack \- Exploring The Mazes of Menace
.SH SYNOPSIS .SH SYNOPSIS
@@ -15,7 +14,7 @@ nethack \- Exploring The Mazes of Menace
] ]
[ [
.B \-p .B \-p
.I profession (role) .I profession
] ]
[ [
.B \-r .B \-r
@@ -46,7 +45,7 @@ nethack \- Exploring The Mazes of Menace
] ]
[ [
.B \-p .B \-p
.I profession (role) .I profession
] ]
[ [
.B \-r .B \-r
@@ -57,6 +56,8 @@ nethack \- Exploring The Mazes of Menace
] ]
.ad .ad
.hy 14 .hy 14
.\" Make sure path is not hyphenated below
.hw nethackdir
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
.I NetHack .I NetHack
@@ -77,7 +78,7 @@ 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 scores) you must locate the Amulet of Yendor which is somewhere below
the 20th level of the dungeon and get it out. the 20th level of the dungeon and get it out.
Nobody has achieved this yet; anybody who does will probably go down Nobody has achieved this yet; anybody who does will probably go down
in history as a hero among heros. in history as a hero among heroes.
.PP .PP
When the game ends, whether by your dying, quitting, or escaping When the game ends, whether by your dying, quitting, or escaping
from the caves, from the caves,
@@ -143,9 +144,9 @@ character's gender. Any of the parts of the suffix may be left out.
.PP .PP
.B \-p .B \-p
.I profession .I profession
can be used to determine the character role. You can specify either the can be used to determine the character profession, also know as the role.
male or female name for the character role, or the first three characters You can specify either the male or female name for the character role, or
of the role as an abbreviation. the first three characters of the role as an abbreviation.
.B "\-p \@" .B "\-p \@"
has been retained to explicitly request that a random role be chosen. has been retained to explicitly request that a random role be chosen.
It may need to be quoted with a backslash (\\@) if @ It may need to be quoted with a backslash (\\@) if @
doc/nethack.txt
+115 -133
View File
@@ -1,4 +1,4 @@
NETHACK(6) NETHACK(6) NETHACK(6) NETHACK(6)
@@ -6,169 +6,153 @@ NAME
nethack - Exploring The Mazes of Menace nethack - Exploring The Mazes of Menace
SYNOPSIS SYNOPSIS
nethack [ -d directory ] [ -n ] [ -p profession (role) ] [ nethack [ -d directory ] [ -n ] [ -p profession ] [ -r race ] [
-r race ] [ -[DX] ] [ -u playername ] [ -dec ] [ -ibm ] -[DX] ] [ -u playername ] [ -dec ] [ -ibm ]
nethack [ -d directory ] -s [ -v ] [ -p profession (role) nethack [ -d directory ] -s [ -v ] [ -p profession ] [ -r race ]
] [ -r race ] [ playernames ] [ playernames ]
DESCRIPTION DESCRIPTION
NetHack is a display oriented Dungeons & Dragons(tm) - NetHack is a display oriented Dungeons & Dragons(tm) - like game.
like game. The standard tty display and command structure The standard tty display and command structure resemble rogue.
resemble rogue.
Other, more graphical display options exist if you are Other, more graphical display options exist if you are using
using either a PC, or an X11 interface. either a PC, or an X11 interface.
To get started you really only need to know two commands. To get started you really only need to know two commands. The
The command ? will give you a list of the available com- command ? will give you a list of the available commands (as
mands (as well as other information) and the command / well as other information) and the command / will identify the
will identify the things you see on the screen. things you see on the screen.
To win the game (as opposed to merely playing to beat To win the game (as opposed to merely playing to beat other peo-
other people's high scores) you must locate the Amulet of ple's high scores) you must locate the Amulet of Yendor which is
Yendor which is somewhere below the 20th level of the dun- somewhere below the 20th level of the dungeon and get it out.
geon and get it out. Nobody has achieved this yet; any- Nobody has achieved this yet; anybody who does will probably go
body who does will probably go down in history as a hero down in history as a hero among heroes.
among heros.
When the game ends, whether by your dying, quitting, or When the game ends, whether by your dying, quitting, or escaping
escaping from the caves, NetHack will give you (a fragment from the caves, NetHack will give you (a fragment of) the list of
of) the list of top scorers. The scoring is based on many top scorers. The scoring is based on many aspects of your behav-
aspects of your behavior, but a rough estimate is obtained ior, but a rough estimate is obtained by taking the amount of
by taking the amount of gold you've found in the cave plus gold you've found in the cave plus four times your (real) experi-
four times your (real) experience. Precious stones may be ence. Precious stones may be worth a lot of gold when brought to
worth a lot of gold when brought to the exit. There is a the exit. There is a 10% penalty for getting yourself killed.
10% penalty for getting yourself killed.
The environment variable NETHACKOPTIONS can be used to The environment variable NETHACKOPTIONS can be used to initialize
initialize many run-time options. The ? command provides many run-time options. The ? command provides a description of
a description of these options and syntax. (The -dec and these options and syntax. (The -dec and -ibm command line
-ibm command line options are equivalent to the decgraph- options are equivalent to the decgraphics and ibmgraphics run-
ics and ibmgraphics run-time options described there, and time options described there, and are provided purely for conve-
are provided purely for convenience on systems supporting nience on systems supporting multiple types of terminals.)
multiple types of terminals.)
Because the option list can be very long (particularly Because the option list can be very long (particularly when spec-
when specifying graphics characters), options may also be ifying graphics characters), options may also be included in a
included in a configuration file. The default is located configuration file. The default is located in your home direc-
in your home directory and named .nethackrc on Unix sys- tory and named .nethackrc on Unix systems. On other systems, the
tems. On other systems, the default may be different, default may be different, usually NetHack.cnf. On DOS or Win-
usually NetHack.cnf. On DOS or Windows, the name is dows, the name is defaults.nh, while on the Macintosh or BeOS, it
defaults.nh, while on the Macintosh or BeOS, it is NetHack is NetHack Defaults. The configuration file's location may be
Defaults. The configuration file's location may be speci- specified by setting NETHACKOPTIONS to a string consisting of an
fied by setting NETHACKOPTIONS to a string consisting of @ character followed by the filename.
an @ character followed by the filename.
The -u playername option supplies the answer to the ques- The -u playername option supplies the answer to the question "Who
tion "Who are you?". It overrides any name from the are you?". It overrides any name from the options or configura-
options or configuration file, USER, LOGNAME, or getlo- tion file, USER, LOGNAME, or getlogin(), which will otherwise be
gin(), which will otherwise be tried in order. If none of tried in order. If none of these provides a useful name, the
these provides a useful name, the player will be asked for player will be asked for one. Player names (in conjunction with
one. Player names (in conjunction with uids) are used to uids) are used to identify save files, so you can have several
identify save files, so you can have several saved games saved games under different names. Conversely, you must use the
under different names. Conversely, you must use the
appropriate player name to restore a saved game. appropriate player name to restore a saved game.
A playername suffix can be used to specify the profession, A playername suffix can be used to specify the profession, race,
race, alignment and/or gender of the character. The full alignment and/or gender of the character. The full syntax of the
syntax of the playername that includes a suffix is "name- playername that includes a suffix is "name-ppp-rrr-aaa-ggg".
ppp-rrr-aaa-ggg". "ppp" are at least the first three let- "ppp" are at least the first three letters of the profession
ters of the profession (this can also be specified using a (this can also be specified using a separate -p profession
separate -p profession option). "rrr" are at least the option). "rrr" are at least the first three letters of the char-
first three letters of the character's race (this can also acter's race (this can also be specified using a separate -r race
be specified using a separate -r race option). "aaa" are option). "aaa" are at last the first three letters of the char-
at last the first three letters of the character's align- acter's alignment, and "ggg" are at least the first three letters
ment, and "ggg" are at least the first three letters of of the character's gender. Any of the parts of the suffix may be
the character's gender. Any of the parts of the suffix left out.
may be left out.
-p profession can be used to determine the character role. -p profession can be used to determine the character profession,
You can specify either the male or female name for the also know as the role. You can specify either the male or female
character role, or the first three characters of the role name for the character role, or the first three characters of the
as an abbreviation. -p @ has been retained to explicitly role as an abbreviation. -p @ has been retained to explicitly
request that a random role be chosen. It may need to be request that a random role be chosen. It may need to be quoted
quoted with a backslash (\@) if @ is the "kill" character with a backslash (\@) if @ is the "kill" character (see "stty")
(see "stty") for the terminal, in order to prevent the for the terminal, in order to prevent the current input line from
current input line from being cleared. being cleared.
Likewise, -r race can be used to explicitly request that a Likewise, -r race can be used to explicitly request that a race
race be chosen. be chosen.
Leaving out any of these characteristics will result in Leaving out any of these characteristics will result in you being
you being prompted during the game startup for the infor- prompted during the game startup for the information.
mation.
The -s option alone will print out the list of your scores The -s option alone will print out the list of your scores on the
on the current version. An immediately following -v current version. An immediately following -v reports on all ver-
reports on all versions present in the score file. The -s sions present in the score file. The -s may also be followed by
may also be followed by arguments -p and -r to print the arguments -p and -r to print the scores of particular roles and
scores of particular roles and races only. It may also be races only. It may also be followed by one or more player names
followed by one or more player names to print the scores to print the scores of the players mentioned, by 'all' to print
of the players mentioned, by 'all' to print out all out all scores, or by a number to print that many top scores.
scores, or by a number to print that many top scores.
The -n option suppresses printing of any news from the The -n option suppresses printing of any news from the game
game administrator. administrator.
The -D or -X option will start the game in a special non- The -D or -X option will start the game in a special non-scoring
scoring discovery mode. -D will, if the player is the discovery mode. -D will, if the player is the game administra-
game administrator, start in debugging (wizard) mode tor, start in debugging (wizard) mode instead.
instead.
The -d option, which must be the first argument if it The -d option, which must be the first argument if it appears,
appears, supplies a directory which is to serve as the supplies a directory which is to serve as the playground. It
playground. It overrides the value from NETHACKDIR, HACK- overrides the value from NETHACKDIR, HACKDIR, or the directory
DIR, or the directory specified by the game administrator specified by the game administrator during compilation (usually
during compilation (usually /usr/games/lib/nethackdir). /usr/games/lib/nethackdir). This option is usually only useful
This option is usually only useful to the game administra- to the game administrator. The playground must contain several
tor. The playground must contain several auxiliary files auxiliary files such as help files, the list of top scorers, and
such as help files, the list of top scorers, and a subdi- a subdirectory save where games are saved.
rectory save where games are saved.
AUTHORS AUTHORS
Jay Fenlason (+ Kenny Woodland, Mike Thome and Jon Payne) Jay Fenlason (+ Kenny Woodland, Mike Thome and Jon Payne) wrote
wrote the original hack, very much like rogue (but full of the original hack, very much like rogue (but full of bugs).
bugs).
Andries Brouwer continuously deformed their sources into Andries Brouwer continuously deformed their sources into an
an entirely different game. entirely different game.
Mike Stephenson has continued the perversion of sources, Mike Stephenson has continued the perversion of sources, adding
adding various warped character classes and sadistic traps various warped character classes and sadistic traps with the help
with the help of many strange people who reside in that of many strange people who reside in that place between the
place between the worlds, the Usenet Zone. A number of worlds, the Usenet Zone. A number of these miscreants are immor-
these miscreants are immortalized in the historical roll talized in the historical roll of dishonor and various other
of dishonor and various other places. places.
The resulting mess is now called NetHack, to denote its The resulting mess is now called NetHack, to denote its develop-
development by the Usenet. Andries Brouwer has made this ment by the Usenet. Andries Brouwer has made this request for
request for the distinction, as he may eventually release the distinction, as he may eventually release a new version of
a new version of his own. his own.
FILES FILES
All files are in the playground, normally All files are in the playground, normally
/usr/games/lib/nethackdir. If DLB was defined during the /usr/games/lib/nethackdir. If DLB was defined during the com-
compile, the data files and special levels will be inside pile, the data files and special levels will be inside a larger
a larger file, normally nhdat, instead of being separate file, normally nhdat, instead of being separate files.
files.
nethack The program itself. nethack The program itself.
data, oracles, rumors Data files used by NetHack. data, oracles, rumors Data files used by NetHack.
options, quest.dat More data files. options, quest.dat More data files.
help, hh Help data files. help, hh Help data files.
cmdhelp, opthelp, wizhelp More help data files. cmdhelp, opthelp, wizhelp More help data files.
*.lev Predefined special levels. *.lev Predefined special levels.
dungeon Control file for special lev- dungeon Control file for special levels.
els.
history A short history of NetHack. history A short history of NetHack.
license Rules governing redistribu- license Rules governing redistribution.
tion.
record The list of top scorers. record The list of top scorers.
logfile An extended list of games logfile An extended list of games
played. played.
xlock.nnn Description of a dungeon xlock.nnn Description of a dungeon level.
level.
perm Lock file for xlock.dd. perm Lock file for xlock.dd.
bonesDD.nn Descriptions of the ghost and bonesDD.nn Descriptions of the ghost and
belongings of a deceased belongings of a deceased
@@ -184,13 +168,12 @@ ENVIRONMENT
HACKPAGER or PAGER Replacement for default pager. HACKPAGER or PAGER Replacement for default pager.
MAIL Mailbox file. MAIL Mailbox file.
MAILREADER Replacement for default reader MAILREADER Replacement for default reader
(probably /bin/mail or (probably /bin/mail or /usr/ucb/mail).
/usr/ucb/mail).
NETHACKDIR Playground. NETHACKDIR Playground.
NETHACKOPTIONS String predefining several NetHack NETHACKOPTIONS String predefining several NetHack
options. options.
In addition, SHOPTYPE is used in debugging (wizard) mode. In addition, SHOPTYPE is used in debugging (wizard) mode.
SEE ALSO SEE ALSO
dgn_comp(6), lev_comp(6), recover(6) dgn_comp(6), lev_comp(6), recover(6)
@@ -200,9 +183,8 @@ BUGS
Dungeons & Dragons is a Trademark of Wizards of the Coast, Dungeons & Dragons is a Trademark of Wizards of the Coast, Inc.
Inc.
9 August 2002 NETHACK(6) 6 March 2004 NETHACK(6)