doc/nethack.6

   1 .TH NETHACK 6 "7 December 2015"
   2 .\" NetHack 3.6  nethack.6      $NHDT-Date: 1449616496 2015/12/08 23:14:56 $  $NHDT-Branch: NetHack-3.6.0 $:$NHDT-Revision: 1.11 $
   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
  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
  50 ]
  51 [
  52 .B \-r
  53 .I race
  54 ]
  55 [
  56 .I playernames
  57 ]
  58 .ad
  59 .hy 14
  60 .\" Make sure path is not hyphenated below
  61 .hw nethackdir
  62 .SH DESCRIPTION
  63 .PP
  64 .I NetHack
  65 is a display oriented Dungeons & Dragons(tm) - like game.
  66 The standard tty display and command structure resemble rogue.
  67 .PP
  68 Other, more graphical display options exist for most platforms.
  69 .PP
  70 To get started you really only need to know two commands.  The command
  71 .B ?
  72 will give you a list of the available commands (as well as other information)
  73 and the command
  74 .B /
  75 will identify the things you see on the screen.
  76 .PP
  77 To win the game (as opposed to merely playing to beat other people's high
  78 scores) you must locate the Amulet of Yendor which is somewhere below
  79 the 20th level of the dungeon and get it out.
  80 Few people achieve this; most never do.  Those who have go down
  81 in history as heros among heroes - and then they find ways of making the
  82 game even harder.  See the
  83 .I Guidebook
  84 section on Conduct if this game has gotten too easy for you.
  85 .PP
  86 When the game ends, whether by your dying, quitting, or escaping
  87 from the caves,
  88 .I NetHack
  89 will give you (a fragment of) the list of top scorers.
  90 The scoring is based on many aspects of your behavior, but a rough estimate
  91 is obtained by taking the amount of gold you've found in the cave plus four
  92 times your (real) experience.
  93 Precious stones may be worth a lot of gold when brought to the exit.
  94 There is a 10% penalty for getting yourself killed.
  95 .PP
  96 The environment variable NETHACKOPTIONS can be used to initialize many
  97 run-time options.
  98 The ? command provides a description of these options and syntax.
  99 (The
 100 .B \-dec
 101 and
 102 .B \-ibm
 103 command line options are equivalent to the
 104 .B decgraphics
 105 and
 106 .B ibmgraphics
 107 run-time options described there,
 108 and are provided purely for convenience on systems
 109 supporting multiple types of terminals.)
 110 .PP
 111 Because the option list can be very long (particularly when specifying
 112 graphics characters), options may also be included in a configuration
 113 file.
 114 The default is located in your home directory and
 115 named .nethackrc on Unix systems.  On other systems, the default may be
 116 different, usually NetHack.cnf.  On DOS or Windows, the name is
 117 defaults.nh, while on the Macintosh or BeOS, it is NetHack Defaults.
 118 The configuration file's location may be specified by setting NETHACKOPTIONS
 119 to a string consisting of an @ character followed by the filename.
 120 .PP
 121 The
 122 .B \-u
 123 .I playername
 124 option supplies the answer to the question "Who are you?".
 125 It overrides any name from the options or configuration file, USER, LOGNAME,
 126 or getlogin(), which will otherwise be tried in order.
 127 If none of these provides a useful name, the player will be asked for one.
 128 Player names (in conjunction with uids) are used to identify save files,
 129 so you can have several saved games under different names.
 130 Conversely, you must use the appropriate player name to restore a saved game.
 131 .PP
 132 A
 133 .I playername
 134 suffix can be used to specify the profession, race, alignment and/or gender
 135 of the character.  The full syntax of the playername that includes a
 136 suffix is "name-ppp-rrr-aaa-ggg".  "ppp" are at least the first three letters
 137 of the profession (this can also be specified using a separate
 138 .B \-p
 139 .I profession
 140 option).  "rrr" are at least the first three letters of the character's
 141 race (this can also be specified using a separate
 142 .B \-r
 143 .I race
 144 option).  "aaa" are at last the first three letters of the character's
 145 alignment, and "ggg" are at least the first three letters of the
 146 character's gender.  Any of the parts of the suffix may be left out.
 147 .PP
 148 .B \-p
 149 .I profession
 150 can be used to determine the character profession, also known as the role.
 151 You can specify either the male or female name for the character role, or
 152 the first three characters of the role as an abbreviation.
 153 .B "\-p \@"
 154 has been retained to explicitly request that a random role be chosen.
 155 It may need to be quoted with a backslash (\\@) if @
 156 is the "kill" character (see "stty") for the terminal, in order
 157 to prevent the current input line from being cleared.
 158 .PP
 159 Likewise,
 160 .B \-r
 161 .I race
 162 can be used to explicitly request that a race be chosen.
 163 .PP
 164 Leaving out any of these characteristics will result in you being prompted
 165 during the game startup for the information.
 166 .PP
 167 .PP
 168 The
 169 .B \-s
 170 option alone will print out the list of your scores on the current version.
 171 An immediately following
 172 .B \-v
 173 reports on all versions present in the score file.
 174 The
 175 .B \-s
 176 may also be followed by arguments
 177 .B \-p
 178 and
 179 .B \-r
 180 to print the scores of particular roles and races only.
 181 It may also be followed by one or more player names to print the scores of the
 182 players mentioned, by 'all' to print out all scores, or by a number to print
 183 that many top scores.
 184 .PP
 185 The
 186 .B \-n
 187 option suppresses printing of any news from the game administrator.
 188 .PP
 189 The
 190 .B \-D
 191 or
 192 .B \-X
 193 option will start the game in a special non-scoring discovery mode.
 194 .B \-D
 195 will, if the player is the game administrator, start in debugging (wizard)
 196 mode instead.
 197 .PP
 198 The
 199 .B \-d
 200 option, which must be the first argument if it appears,
 201 supplies a directory which is to serve as the playground.
 202 It overrides the value from NETHACKDIR, HACKDIR,
 203 or the directory specified by the game administrator during compilation
 204 (usually /usr/games/lib/nethackdir).
 205 This option is usually only useful to the game administrator.
 206 The playground must contain several auxiliary files such as help files,
 207 the list of top scorers, and a subdirectory
 208 .I save
 209 where games are saved.
 210 .SH AUTHORS
 211 .PP
 212 Jay Fenlason (+ Kenny Woodland, Mike Thome and Jon Payne) wrote the
 213 original hack, very much like rogue (but full of bugs).
 214 .PP
 215 Andries Brouwer continuously deformed their sources into an entirely
 216 different game.
 217 .PP
 218 Mike Stephenson has continued the perversion of sources, adding various
 219 warped character classes and sadistic traps with the help of many strange
 220 people who reside in that place between the worlds, the Usenet Zone.
 221 A number of these miscreants are immortalized in the historical
 222 roll of dishonor and various other places.
 223 .PP
 224 The resulting mess is now called NetHack, to denote its
 225 development by the Usenet.  Andries Brouwer has made this request for the
 226 distinction, as he may eventually release a new version of his own.
 227 .SH FILES
 228 .PP
 229 Run-time configuration options were discussed above and use a platform
 230 specific name for a file in a platform specific location.  For Unix, the
 231 name is '.nethackrc' in the user's home directory.
 232
 233 .br
 234 All other files are in the playground directory,
 235 normally /usr/games/lib/nethackdir.
 236 If DLB was defined during the compile, the data files and special levels
 237 will be inside a larger file, normally nhdat, instead of being separate
 238 files.
 239
 240 .br
 241 .DT
 242 .ta \w'cmdhelp, opthelp, wizhelp\ \ \ 'u
 243 nethack         The program itself.
 244 .br
 245 data, oracles, rumors   Data files used by NetHack.
 246 .br
 247 quest.dat, bogusmon     More data files.
 248 .br
 249 engrave, epitaph, tribute       Still more data files.
 250 .br
 251 symbols Data file holding sets of specifications
 252 .br
 253         for how to display monsters, objects, and
 254 .br
 255         map features.
 256 .br
 257 options Data file containing a description of the
 258         build-time option settings.
 259 .br
 260 help, hh        Help data files.
 261 .br
 262 cmdhelp, opthelp, wizhelp       More help data files.
 263 .br
 264 *.lev   Predefined special levels.
 265 .br
 266 dungeon Control file for special levels.
 267 .br
 268 history A short history of NetHack.
 269 .br
 270 license Rules governing redistribution.
 271 .br
 272 record  The list of top scorers.
 273 .br
 274 logfile An extended list of games played
 275 .br
 276         (optional).
 277 .br
 278 xlogfile        A more detailed version of 'logfile'
 279 .br
 280         (also optional).
 281 .br
 282 paniclog        Record of exceptional conditions
 283 .br
 284         discovered during program execution.
 285 .br
 286 xlock.nn        Description of dungeon level 'nn' of
 287 .br
 288         active game 'x' if there's a limit on the
 289 .br
 290         number of simultaneously active games.
 291 .br
 292 UUcccccc.nn     Alternate form for dungeon level 'nn'
 293 .br
 294         of active game by user 'UU' playing
 295 .br
 296         character named 'cccccc' when there's no
 297 .br
 298         limit on number of active games.
 299 .br
 300 perm    Lock file for xlock.0 or UUcccccc.0.
 301 .br
 302 bonesDD.nn      Descriptions of the ghost and belongings
 303 .br
 304         of a deceased adventurer who met his
 305 .br
 306         or her demise on level 'nn'.
 307 .br
 308 .\"following line should contain <space><tab>
 309
 310 .br
 311 save/   A subdirectory containing saved games.
 312 .br
 313 .\"following line should contain <space><tab>
 314
 315 .br
 316 sysconf System-wide options.  Required if
 317 .br
 318         program is built with 'SYSCF' option
 319 .br
 320         enabled, ignored if not.
 321 .br
 322
 323 The location of 'sysconf' is specified at build time and can't be changed
 324 except by updating source file "config.h" and rebuilding the program.
 325 .br
 326
 327 In a perfect world, 'paniclog' would remain empty.
 328 .SH ENVIRONMENT
 329 .DT
 330 .ta \w'NETHACKDIR or HACKDIR\ \ \ 'u
 331 USER or LOGNAME Your login name.
 332 .br
 333 HOME            Your home directory.
 334 .br
 335 SHELL           Your shell.
 336 .br
 337 TERM            The type of your terminal.
 338 .br
 339 HACKPAGER or PAGER      Replacement for default pager.
 340 .br
 341 MAIL    Mailbox file.
 342 .br
 343 MAILREADER      Replacement for default reader
 344 .br
 345         (probably /bin/mail or /usr/ucb/mail).
 346 .br
 347 NETHACKDIR or HACKDIR   Playground.
 348 .br
 349 NETHACKOPTIONS  String predefining several NetHack
 350 .br
 351         options.
 352 .br
 353
 354 If the same option is specified in both NETHACKOPTIONS and .nethackrc,
 355 the value assigned in NETHACKOPTIONS takes precedence.
 356 .br
 357
 358 SHOPTYPE and SPLEVTYPE can be used in debugging (wizard) mode.
 359 .br
 360 DEBUGFILES can be used if the program was built with 'DEBUG' enabled.
 361 .SH "SEE ALSO"
 362 .PP
 363 dgn_comp(6), lev_comp(6), recover(6)
 364 .SH BUGS
 365 .PP
 366 Probably infinite.
 367
 368
 369 .PP
 370 Dungeons & Dragons is a Trademark of Wizards of the Coast, Inc.