doc/nethack.6

   1 .TH NETHACK 6 "9 August 2002"
   2 .UC 4
   3 .SH NAME
   4 nethack \- Exploring The Mazes of Menace
   5 .SH SYNOPSIS
   6 .na
   7 .hy 0
   8 .B nethack
   9 [
  10 .B \-d
  11 .I directory
  12 ]
  13 [
  14 .B \-n
  15 ]
  16 [
  17 .B \-p
  18 .I profession (role)
  19 ]
  20 [
  21 .B \-r
  22 .I race
  23 ]
  24 [
  25 .B \-[DX]
  26 ]
  27 [
  28 .B \-u
  29 .I playername
  30 ]
  31 [
  32 .B \-dec
  33 ]
  34 [
  35 .B \-ibm
  36 ]
  37 .PP
  38 .B nethack
  39 [
  40 .B \-d
  41 .I directory
  42 ]
  43 .B \-s
  44 [
  45 .B \-v
  46 ]
  47 [
  48 .B \-p
  49 .I profession (role)
  50 ]
  51 [
  52 .B \-r
  53 .I race
  54 ]
  55 [
  56 .I playernames
  57 ]
  58 .ad
  59 .hy 14
  60 .SH DESCRIPTION
  61 .PP
  62 .I NetHack
  63 is a display oriented Dungeons & Dragons(tm) - like game.
  64 The standard tty display and command structure resemble rogue.
  65 .PP
  66 Other, more graphical display options exist if you are using either a PC,
  67 or an X11 interface.
  68 .PP
  69 To get started you really only need to know two commands.  The command
  70 .B ?
  71 will give you a list of the available commands (as well as other information)
  72 and the command
  73 .B /
  74 will identify the things you see on the screen.
  75 .PP
  76 To win the game (as opposed to merely playing to beat other people's high
  77 scores) you must locate the Amulet of Yendor which is somewhere below
  78 the 20th level of the dungeon and get it out.
  79 Nobody has achieved this yet; anybody who does will probably go down
  80 in history as a hero among heros.
  81 .PP
  82 When the game ends, whether by your dying, quitting, or escaping
  83 from the caves,
  84 .I NetHack
  85 will give you (a fragment of) the list of top scorers.
  86 The scoring is based on many aspects of your behavior, but a rough estimate
  87 is obtained by taking the amount of gold you've found in the cave plus four
  88 times your (real) experience.
  89 Precious stones may be worth a lot of gold when brought to the exit.
  90 There is a 10% penalty for getting yourself killed.
  91 .PP
  92 The environment variable NETHACKOPTIONS can be used to initialize many
  93 run-time options.
  94 The ? command provides a description of these options and syntax.
  95 (The
  96 .B \-dec
  97 and
  98 .B \-ibm
  99 command line options are equivalent to the
 100 .B decgraphics
 101 and
 102 .B ibmgraphics
 103 run-time options described there,
 104 and are provided purely for convenience on systems
 105 supporting multiple types of terminals.)
 106 .PP
 107 Because the option list can be very long (particularly when specifying
 108 graphics characters), options may also be included in a configuration
 109 file.
 110 The default is located in your home directory and
 111 named .nethackrc on Unix systems.  On other systems, the default may be
 112 different, usually NetHack.cnf.  On DOS or Windows, the name is
 113 defaults.nh, while on the Macintosh or BeOS, it is NetHack Defaults.
 114 The configuration file's location may be specified by setting NETHACKOPTIONS
 115 to a string consisting of an @ character followed by the filename.
 116 .PP
 117 The
 118 .B \-u
 119 .I playername
 120 option supplies the answer to the question "Who are you?".
 121 It overrides any name from the options or configuration file, USER, LOGNAME,
 122 or getlogin(), which will otherwise be tried in order.
 123 If none of these provides a useful name, the player will be asked for one.
 124 Player names (in conjunction with uids) are used to identify save files,
 125 so you can have several saved games under different names.
 126 Conversely, you must use the appropriate player name to restore a saved game.
 127 .PP
 128 A
 129 .I playername
 130 suffix can be used to specify the profession, race, alignment and/or gender
 131 of the character.  The full syntax of the playername that includes a
 132 suffix is "name-ppp-rrr-aaa-ggg".  "ppp" are at least the first three letters
 133 of the profession (this can also be specified using a separate
 134 .B \-p
 135 .I profession
 136 option).  "rrr" are at least the first three letters of the character's
 137 race (this can also be specified using a separate
 138 .B \-r
 139 .I race
 140 option).  "aaa" are at last the first three letters of the character's
 141 alignment, and "ggg" are at least the first three letters of the
 142 character's gender.  Any of the parts of the suffix may be left out.
 143 .PP
 144 .B \-p
 145 .I profession
 146 can be used to determine the character role.  You can specify either the
 147 male or female name for the character role, or the first three characters
 148 of the role as an abbreviation.
 149 .B "\-p \@"
 150 has been retained to explicitly request that a random role be chosen.
 151 It may need to be quoted with a backslash (\\@) if @
 152 is the "kill" character (see "stty") for the terminal, in order
 153 to prevent the current input line from being cleared.
 154 .PP
 155 Likewise,
 156 .B \-r
 157 .I race
 158 can be used to explicitly request that a race be chosen.
 159 .PP
 160 Leaving out any of these characteristics will result in you being prompted
 161 during the game startup for the information.
 162 .PP
 163 .PP
 164 The
 165 .B \-s
 166 option alone will print out the list of your scores on the current version.
 167 An immediately following
 168 .B \-v
 169 reports on all versions present in the score file.
 170 The
 171 .B \-s
 172 may also be followed by arguments
 173 .B \-p
 174 and
 175 .B \-r
 176 to print the scores of particular roles and races only.
 177 It may also be followed by one or more player names to print the scores of the
 178 players mentioned, by 'all' to print out all scores, or by a number to print
 179 that many top scores.
 180 .PP
 181 The
 182 .B \-n
 183 option suppresses printing of any news from the game administrator.
 184 .PP
 185 The
 186 .B \-D
 187 or
 188 .B \-X
 189 option will start the game in a special non-scoring discovery mode.
 190 .B \-D
 191 will, if the player is the game administrator, start in debugging (wizard)
 192 mode instead.
 193 .PP
 194 The
 195 .B \-d
 196 option, which must be the first argument if it appears,
 197 supplies a directory which is to serve as the playground.
 198 It overrides the value from NETHACKDIR, HACKDIR,
 199 or the directory specified by the game administrator during compilation
 200 (usually /usr/games/lib/nethackdir).
 201 This option is usually only useful to the game administrator.
 202 The playground must contain several auxiliary files such as help files,
 203 the list of top scorers, and a subdirectory
 204 .I save
 205 where games are saved.
 206 .SH AUTHORS
 207 .PP
 208 Jay Fenlason (+ Kenny Woodland, Mike Thome and Jon Payne) wrote the
 209 original hack, very much like rogue (but full of bugs).
 210 .PP
 211 Andries Brouwer continuously deformed their sources into an entirely
 212 different game.
 213 .PP
 214 Mike Stephenson has continued the perversion of sources, adding various
 215 warped character classes and sadistic traps with the help of many strange
 216 people who reside in that place between the worlds, the Usenet Zone.
 217 A number of these miscreants are immortalized in the historical
 218 roll of dishonor and various other places.
 219 .PP
 220 The resulting mess is now called NetHack, to denote its
 221 development by the Usenet.  Andries Brouwer has made this request for the
 222 distinction, as he may eventually release a new version of his own.
 223 .SH FILES
 224 .PP
 225 All files are in the playground, normally /usr/games/lib/nethackdir.
 226 If DLB was defined during the compile, the data files and special levels
 227 will be inside a larger file, normally nhdat, instead of being separate
 228 files.
 229 .br
 230 .DT
 231 .ta \w'cmdhelp, opthelp, wizhelp\ \ \ 'u
 232 nethack         The program itself.
 233 .br
 234 data, oracles, rumors   Data files used by NetHack.
 235 .br
 236 options, quest.dat      More data files.
 237 .br
 238 help, hh        Help data files.
 239 .br
 240 cmdhelp, opthelp, wizhelp       More help data files.
 241 .br
 242 *.lev   Predefined special levels.
 243 .br
 244 dungeon Control file for special levels.
 245 .br
 246 history A short history of NetHack.
 247 .br
 248 license Rules governing redistribution.
 249 .br
 250 record  The list of top scorers.
 251 .br
 252 logfile An extended list of games
 253 .br
 254         played.
 255 .br
 256 xlock.nnn       Description of a dungeon level.
 257 .br
 258 perm    Lock file for xlock.dd.
 259 .br
 260 bonesDD.nn      Descriptions of the ghost and
 261 .br
 262         belongings of a deceased
 263 .br
 264         adventurer.
 265 .br
 266 save    A subdirectory containing the
 267 .br
 268         saved games.
 269 .SH ENVIRONMENT
 270 .DT
 271 .ta \w'HACKPAGER or PAGER\ \ \ 'u
 272 USER or LOGNAME Your login name.
 273 .br
 274 HOME            Your home directory.
 275 .br
 276 SHELL           Your shell.
 277 .br
 278 TERM            The type of your terminal.
 279 .br
 280 HACKPAGER or PAGER      Replacement for default pager.
 281 .br
 282 MAIL    Mailbox file.
 283 .br
 284 MAILREADER      Replacement for default reader
 285 .br
 286         (probably /bin/mail or /usr/ucb/mail).
 287 .br
 288 NETHACKDIR      Playground.
 289 .br
 290 NETHACKOPTIONS  String predefining several NetHack
 291 .br
 292         options.
 293 .br
 294
 295 In addition, SHOPTYPE is used in debugging (wizard) mode.
 296 .SH "SEE ALSO"
 297 .PP
 298 dgn_comp(6), lev_comp(6), recover(6)
 299 .SH BUGS
 300 .PP
 301 Probably infinite.
 302
 303
 304 .PP
 305 Dungeons & Dragons is a Trademark of Wizards of the Coast, Inc.