1 .TH NETHACK 6 "2 February 2018" NETHACK
11 .ND $NHDT-Date: 1568509458 2019/09/15 01:04:18 $
12 .NB $NHDT-Branch: NetHack-3.6 $
13 .NR $NHDT-Revision: 1.16 $
14 .ds Na Robert Patrick Rankin
16 nethack \- Exploring The Mazes of Menace
53 .BR \-\-version [ :paste ]
78 .\" Make sure path is not hyphenated below
83 is a display oriented Dungeons & Dragons(tm) - like game.
84 The standard tty display and command structure resemble rogue.
86 Other, more graphical display options exist for most platforms.
88 To get started you really only need to know two commands. The command
90 will give you a list of the available commands (as well as other information)
93 will identify the things you see on the screen.
95 To win the game (as opposed to merely playing to beat other people's high
96 scores) you must locate the Amulet of Yendor which is somewhere below
97 the 20th level of the dungeon and get it out.
98 Few people achieve this; most never do. Those who have go down
99 in history as heroes among heroes - and then they find ways of making the
100 game even harder. See the
102 section on Conduct if this game has gotten too easy for you.
104 When the game ends, whether by your dying, quitting, or escaping
107 will give you (a fragment of) the list of top scorers.
108 The scoring is based on many aspects of your behavior, but a rough estimate
109 is obtained by taking the amount of gold you've found in the cave plus four
110 times your (real) experience.
111 Precious stones may be worth a lot of gold when brought to the exit.
112 There is a 10% penalty for getting yourself killed.
114 The environment variable NETHACKOPTIONS can be used to initialize many
116 The ? command provides a description of these options and syntax.
121 command line options are equivalent to the
125 run-time options described there,
126 and are provided purely for convenience on systems
127 supporting multiple types of terminals.)
129 Because the option list can be very long (particularly when specifying
130 graphics characters), options may also be included in a configuration
132 The default is located in your home directory and
133 named .nethackrc on Unix systems. On other systems, the default may be
134 different, usually NetHack.cnf. On DOS or Windows, the name is
135 defaults.nh, while on the Macintosh or BeOS, it is NetHack Defaults.
136 The configuration file's location may be specified by setting NETHACKOPTIONS
137 to a string consisting of an @ character followed by the filename.
142 option supplies the answer to the question "Who are you?".
143 It overrides any name from the options or configuration file, USER, LOGNAME,
144 or getlogin(), which will otherwise be tried in order.
145 If none of these provides a useful name, the player will be asked for one.
146 Player names (in conjunction with uids) are used to identify save files,
147 so you can have several saved games under different names.
148 Conversely, you must use the appropriate player name to restore a saved game.
152 suffix can be used to specify the profession, race, alignment and/or gender
153 of the character. The full syntax of the playername that includes a
154 suffix is "name-ppp-rrr-aaa-ggg". "ppp" are at least the first three letters
155 of the profession (this can also be specified using a separate
158 option). "rrr" are at least the first three letters of the character's
159 race (this can also be specified using a separate
162 option). "aaa" are at least the first three letters of the character's
163 alignment, and "ggg" are at least the first three letters of the
164 character's gender. Any of the parts of the suffix may be left out.
168 can be used to determine the character profession, also known as the role.
169 You can specify either the male or female name for the character role, or
170 the first three characters of the role as an abbreviation.
172 has been retained to explicitly request that a random role be chosen.
173 It may need to be quoted with a backslash (\\@) if @
174 is the "kill" character (see "stty") for the terminal, in order
175 to prevent the current input line from being cleared.
180 can be used to explicitly request that a race be chosen.
182 Leaving out any of these characteristics will result in you being prompted
183 during the game startup for the information.
188 option alone will print out the list of your scores on the current version.
189 An immediately following
191 reports on all versions present in the score file.
194 may also be followed by arguments
198 to print the scores of particular roles and races only.
199 It may also be followed by one or more player names to print the scores of the
200 players mentioned, by 'all' to print out all scores, or by a number to print
201 that many top scores.
205 option suppresses printing of any news from the game administrator.
211 option will start the game in a special non-scoring discovery mode.
213 will, if the player is the game administrator, start in debugging (wizard)
218 option, which must be the first argument if it appears,
219 supplies a directory which is to serve as the playground.
220 It overrides the value from NETHACKDIR, HACKDIR,
221 or the directory specified by the game administrator during compilation
222 (usually /usr/games/lib/nethackdir).
223 This option is usually only useful to the game administrator.
224 The playground must contain several auxiliary files such as help files,
225 the list of top scorers, and a subdirectory
227 where games are saved.
230 can be used to cause NetHack to show where it is expecting
231 to find various configuration files.
234 can be used to cause NetHack to show the version information it
235 was compiled with, then exit. That will include the
237 commit hash if the information was available when the game was compiled.
238 On some platforms, such as windows and macosx, a variation
240 can be used to cause NetHack to show the version information, then exit,
241 while also leaving a copy of the version information in the paste buffer
242 or clipboard for potential insertion into things like bug reports.
245 Jay Fenlason (+ Kenny Woodland, Mike Thome and Jon Payne) wrote the
246 original hack, very much like rogue (but full of bugs).
248 Andries Brouwer continuously deformed their sources into an entirely
251 Mike Stephenson has continued the perversion of sources, adding various
252 warped character classes and sadistic traps with the help of many strange
253 people who reside in that place between the worlds, the Usenet Zone.
254 A number of these miscreants are immortalized in the historical
255 roll of dishonor and various other places.
257 The resulting mess is now called NetHack, to denote its
258 development by the Usenet. Andries Brouwer has made this request for the
259 distinction, as he may eventually release a new version of his own.
262 Run-time configuration options were discussed above and use a platform
263 specific name for a file in a platform specific location. For Unix, the
264 name is '.nethackrc' in the user's home directory.
267 All other files are in the playground directory,
268 normally /usr/games/lib/nethackdir.
269 If DLB was defined during the compile, the data files and special levels
270 will be inside a larger file, normally nhdat, instead of being separate
275 .ta \w'cmdhelp, opthelp, wizhelp\ \ \ 'u
276 nethack The program itself.
278 data, oracles, rumors Data files used by NetHack.
280 quest.dat, bogusmon More data files.
282 engrave, epitaph, tribute Still more data files.
284 symbols Data file holding sets of specifications
286 for how to display monsters, objects, and
290 options Data file containing a description of the
291 build-time option settings.
293 help, hh Help data files.
295 cmdhelp, opthelp, wizhelp More help data files.
297 *.lev Predefined special levels.
299 dungeon Control file for special levels.
301 history A short history of NetHack.
303 license Rules governing redistribution.
305 record The list of top scorers.
307 logfile An extended list of games played
311 xlogfile A more detailed version of 'logfile'
315 paniclog Record of exceptional conditions
317 discovered during program execution.
319 xlock.nn Description of dungeon level 'nn' of
321 active game 'x' if there's a limit on the
323 number of simultaneously active games.
325 UUcccccc.nn Alternate form for dungeon level 'nn'
327 of active game by user 'UU' playing
329 character named 'cccccc' when there's no
331 limit on number of active games.
333 perm Lock file for xlock.0 or UUcccccc.0.
335 bonesDD.nn Descriptions of the ghost and belongings
337 of a deceased adventurer who met his
339 or her demise on level 'nn'.
341 .\"following line should contain <space><tab>
344 save/ A subdirectory containing saved games.
346 .\"following line should contain <space><tab>
349 sysconf System-wide options. Required if
351 program is built with 'SYSCF' option
353 enabled, ignored if not.
356 The location of 'sysconf' is specified at build time and can't be changed
357 except by updating source file "config.h" and rebuilding the program.
360 In a perfect world, 'paniclog' would remain empty.
363 .ta \w'NETHACKDIR or HACKDIR\ \ \ 'u
364 USER or LOGNAME Your login name.
366 HOME Your home directory.
370 TERM The type of your terminal.
372 HACKPAGER or PAGER Replacement for default pager.
376 MAILREADER Replacement for default reader
378 (probably /bin/mail or /usr/ucb/mail).
380 NETHACKDIR or HACKDIR Playground.
382 NETHACKOPTIONS String predefining several NetHack
387 If the same option is specified in both NETHACKOPTIONS and .nethackrc,
388 the value assigned in NETHACKOPTIONS takes precedence.
391 SHOPTYPE and SPLEVTYPE can be used in debugging (wizard) mode.
393 DEBUGFILES can be used if the program was built with 'DEBUG' enabled.
396 dgn_comp(6), lev_comp(6), recover(6)
401 This file is Copyright (C) \*(Na and was last modified \*(Nd (version
403 NetHack may be freely redistributed. See license for details.
405 Dungeons & Dragons is a Trademark of Wizards of the Coast, Inc.