Source:NetHack 5.0.0/dat/opthelp
Jump to navigation
Jump to search
Below is the full text to opthelp from the source code of NetHack 5.0.0. To link to a particular line, write [[Source:NetHack 5.0.0/dat/opthelp#line12]], for example.
The NetHack General Public License applies to screenshots, source code and other content from NetHack.
This content was modified from the original NetHack source code distribution (by splitting up NetHack content between wiki pages, and possibly further editing). See the page history for a list of who changed it, and on what dates.
1. Boolean options not under specific compile flags (with default values in []): 2. (You can learn which options exist in your version by checking your current 3. option setting, which is reached via the 'O' command.) 4. 5. acoustics can your character hear anything [True] 6. armorstatus show extra status field summarizing worn armor [False] 7. autodescribe describe the terrain under cursor [False] 8. autodig dig if moving and wielding digging tool [False] 9. autoopen walking into a door attempts to open it [True] 10. autopickup automatically pick up objects you move over [True] 11. autoquiver when firing with an empty quiver, select some [False] 12. suitable inventory weapon to fill the quiver 13. BIOS allow the use of IBM ROM BIOS calls [False] 14. blind your character is permanently blind [False] 15. bones allow loading bones files [True] 16. clicklook look at map by clicking right mouse button [False] 17. cmdassist give help for errors on direction & other commands [True] 18. color use different colors for objects on screen [True for micros] 19. confirm ask before hitting tame or peaceful monsters [True] 20. dark_room show floor not in sight in different color [True] 21. dropped_nopick exclude dropped objects from autopickup [True] 22. eight_bit_tty send 8-bit characters straight to terminal [False] 23. extmenu tty, curses: use menu for # (extended commands) [False] 24. X11: menu has all commands (T) or traditional subset (F) 25. female deprecated; use compound option gender:female [False] 26. fixinv try to retain the same letter for the same object [True] 27. force_invmenu commands asking for inventory item show a menu [False] 28. goldX when filtering objects by bless/curse state, [False] 29. whether to classify gold as X (unknown) or U (uncursed) 30. help print all available info when using the / command [True] 31. herecmd_menu show menu of some possible commands when clicking 32. on yourself or next to you with mouse [False] 33. hilite_pet display pets in a highlighted manner [False] 34. hilite_pile display item piles in a highlighted manner [False] 35. ignintr ignore interrupt signal, including breaks [False] 36. implicit_uncursed omit "uncursed" from inventory, if possible [True] 37. legacy print introductory message [True] 38. lit_corridor show a dark corridor as lit if in sight [False] 39. lootabc use a/b/c rather than o/i/b when looting [False] 40. mail enable the mail daemon [True] 41. mention_decor give feedback when walking across stairs, altars, [False] 42. fountains, and such even when not obscured by objects 43. mention_walls give feedback when walking against a wall [False] 44. menu_overlay overlay menus on the screen and align to right [True] 45. menucolors enable MENUCOLOR pattern matching to highlight [False] 46. lines in object menus like inventory; might highlight with 47. bold, inverse, &c even when color is unavailable or toggled off 48. nudist start your character without armor [False] 49. null allow nulls to be sent to your terminal [True] 50. try turning this option off (forcing NetHack to use its own 51. delay code) if moving objects seem to teleport across rooms 52. pauper start your character with no possessions [False] 53. perm_invent keep inventory in a permanent window [False] 54. pickup_stolen override pickup_types for stolen objects [True] 55. pickup_thrown override pickup_types for thrown objects [True] 56. price_quotes show remembered price quotes for unIDed items [False] 57. pushweapon when wielding a new weapon, put your previously [False] 58. wielded weapon into the secondary weapon slot 59. quick_farsight usually skip the chance to browse the map when [False] 60. randomly triggered clairvoyance takes place 61. rawio allow the use of raw I/O [False] 62. reroll allow rerolling of starting inventory [False] 63. rest_on_space count the space bar as a rest character [False] 64. safe_pet prevent you from (knowingly) attacking your pet(s) [True] 65. safe_wait require use of 'm' prefix before '.' or 's' to [True] 66. wait or search when adjacent to a hostile monster 67. sanity_check perform data sanity checks [False] 68. showexp display your accumulated experience points [False] 69. showrace show yourself by your race rather than by role [False] 70. showvers show version number on status lines [False] 71. silent don't use your terminal's bell sound [True] 72. sortpack group similar kinds of objects in inventory [True] 73. sparkle display sparkly effect for resisted magical [True] 74. attacks (e.g. fire attack on fire-resistant monster) 75. standout use standout mode for --More-- on messages [False] 76. status_updates update the status lines [True] 77. terrainstatus show extra status field describing current location [False] 78. time display elapsed game time, in moves [False] 79. tips show some helpful tips during gameplay [True] 80. tombstone print tombstone when you die [True] 81. toptenwin print topten in a window rather than stdout [False] 82. travel enables travelling via mouse click if supported; [True] 83. can be toggled off to prevent mouse clicks on the map from 84. attempting to move the hero; does not affect travel via '_' 85. use_darkgray use bold black instead of blue for black glyphs. [True] 86. use_inverse display detected monsters in highlighted manner [False] 87. verbose print more commentary during the game [True] 88. weaponstatus show extra status field listing wielded weapon(s) [False] 89. whatis_menu show menu when getting a map location [False] 90. whatis_moveskip skip same glyphs when getting a map location [False] 91. 92. 93. There are further boolean options controlled by compilation flags. 94. 95. Boolean option if INSURANCE was set at compile time: 96. checkpoint save game state after each level change, for [True] 97. possible recovery after program crash 98. 99. Boolean option if NEWS was set at compile time: 100. news print any news from game administrator on startup [True] 101. 102. Boolean option if SCORE_ON_BOTL was set at compile time: 103. showscore display your approximate accumulated score [False] 104. 105. Boolean option if TIMED_DELAY was set at compile time (tty or curses only): 106. timed_delay on unix and VMS, use a timer instead of sending [True] 107. extra screen output when attempting to pause for 108. display effect. on MSDOS without the termcap 109. lib, whether or not to pause for visual effect. 110. 111. Boolean option if ALTMETA was set at compile time: 112. altmeta For unix and VMS, treat two character sequence 113. "ESC c" as M-c (Meta+c, 8th bit set) when nethack [False] 114. obtains a command from player's keyboard. 115. 116. Boolean option if TILES_IN_GLYPHMAP set at compile time (MSDOS): 117. preload_tiles control whether tiles get pre-loaded into RAM at [True] 118. the start of the game. Doing so enhances performance 119. of the tile graphics, but uses more memory. 120. 121. Boolean option if TTY_TILES_ESCCODES was set at compile time (tty only): 122. vt_tiledata insert extra data escape code markers into output [False] 123. 124. Boolean option if TTY_SOUND_ESCCODES was set at compile time (tty only): 125. vt_sounddata insert sound data escape code markers into output [False] 126. 127. Boolean options which may be available depending upon which interfaces 128. the program has been built to support. If it supports multiple such, 129. some of these may show as available for setting but not do anything if 130. you happen to be using a different interface than the one(s) they're for: 131. ascii_map show map as text, forces tiles_map Off; Qt, X11 132. guicolor curses 133. hitpointbar curses, tty, Windows GUI if statushilites enabled; 134. Qt without statushilites; X11 if 'fancy_status' disabled 135. (via X application defaults) and statushilities enabled 136. popup_dialog curses, Qt, Windows GUI 137. selectsaved tty (Qt and Windows GUI do this unconditionally) 138. splash_screen curses, Qt, Windows GUI 139. tiled_map show map as tiles, forces ascii_map Off; Qt, X11 140. 141. Boolean options available when running in debug mode (aka wizard mode): 142. menu_tab_sep menu formatting--do not touch 143. monpolycontrol have player choose shape-changing monsters' new shapes 144. montelecontrol let player choose destination for teleported monsters 145. travel_debug show state of travel pathfinding algorithm on the map 146. wizweight include item weights in inventory display 147. 148. Any Boolean option can be set to True by including it among options being 149. set, or negated (set to False) by prefixing its name with a '!' or 'no'. 150. Alternatively, the compound option syntax can be used: 'optname:true' and 151. 'optname:false'. 152. 153. - - - - - 154. 155. Compound options are written as option_name:option_value. 156. 157. Compound options which can be set during the game are: 158. 159. autounlock when attempting to open a locked door or loot [Apply-Key] 160. a locked container, specifies an action to take: can be 161. None, or one or more of Untrap + Apply-Key + Kick + Force; 162. if Untrap is included, it will be handled first; the 163. others apply if you answer "no" to "check for traps?"; 164. for "yes", it won't necessary find anything even when a 165. trap happens to be present and will use up the rest of 166. the current move regardless of whether it finds anything; 167. Kick is only useful for doors and Force is only useful for 168. containers; either will only be attempted if Untrap is 169. omitted or skipped and Apply-Key is omitted or you aren't 170. carrying an unlocking tool or you decline to use one 171. boulder override the default boulder symbol [`] 172. crash_email email address to use when filling in crash reports [] 173. crash_name name to use when filling in crash reports [] 174. crash_urlmax length of longest url we can generate for a crash report [] 175. disclose the types of information you want [ni na nv ng nc no] 176. offered at the end of the game 177. (space separated list of two-character values; 178. prefix: '+' always disclose, '-' never disclose, 179. 'n' prompt with default "no", 'y' prompt with default "yes", 180. 'a' prompt to select sorting order (for suffix 'v' only); 181. suffix: 'i' inventory, 'a' attributes, 'v' vanquished 182. monsters, 'g' genocided and extinct monsters, 'c' conduct 183. and achievements, 'o' dungeon overview) 184. fruit the name of a fruit you enjoy eating [slime mold] 185. (basically a whimsy which NetHack uses from time to time). 186. hilite_status specifies a rule for highlighting a status field [] 187. (multiple instances are allowed) 188. menustyle user interface for selection of multiple objects: [Full] 189. Traditional -- prompt for classes of interest, then 190. prompt item-by-item for those classes; 191. Combination -- prompt for classes of interest, then 192. use a menu for choosing items; 193. Full -- menu for classes of interest, then item menu; 194. Partial -- skip class filtering, use menu of all items; 195. only the first letter ('T','C','F','P') matters 196. (With Traditional, many actions allow pseudo-class 'm' to 197. request a menu for choosing items: one-shot Combination.) 198. menu_objsyms whether to include object class symbols in menus: [4] 199. 0 - none -- don't add object symbols to menus; 200. 1 - headers -- append object class symbol to menu header lines; 201. 2 - entries -- show object glyphs (same as class symbol 202. for ASCII interfaces) on each menu entry line; 203. 3 - both -- 1 and 2 combined; 204. 4 - conditional -- as 2 but only if no headers are present; 205. 5 - one-or-other -- 1 and 4 combined; 206. choices 0 and 1 should work with any interface; 2 through 5 207. are supported by tty and curses 208. msg_window behavior of ^P message recall for tty interface: [s] 209. single -- one message at a time 210. full -- full window with all saved top line messages 211. reverse -- full with messages printed most-recent-first 212. combination -- first two of consecutive ^P commands show 213. single messages, third yields full set 214. msg_window behavior of ^P message recall for curses interface: [r] 215. reverse -- full window, most recent first 216. full -- full with messages printed least recent first, 217. initially positioned on last page to start 218. with most recent messages in view 219. number_pad alphabetic versus numeric control over movement: [0] 220. 0 -- traditional hjkl + yubn movement (default); 221. 1 -- digits control movement, for use with numeric keypad; 222. 2 -- same as 1, but '5' works as 'g' prefix rather than 'G'; 223. 3 -- numeric for phone keypad (1,2,3 above, 7,8,9 below); 224. 4 -- phone keypad (3) combined with '5' preference (2); 225. -1 -- "qwertz"; alphabetic movement but 'z' swapped with 'y'. 226. Setting number_pad (to a positive value) affects how all 227. digit keys are handled, not just those on numeric keypad. 228. packorder a list of default symbols for kinds of [")[%?+!=/(*`0_] 229. objects that gives the order in which your inventory (and 230. some other things) gets shown if the 'sortpack' option is on 231. (If you specify only some kinds of items, the others from the 232. default order will be appended to the end.) 233. paranoid_confirmation space separated list [paranoid_confirm:pray swim] 234. of situations where alternate prompting is desired 235. Confirm -- when requiring "yes", also require "no" to reject; 236. also requires yes rather than y for pray, trap, Autoall 237. quit -- yes vs y to confirm quitting or to enter explore mode 238. die -- yes vs y to confirm dying (for explore or debug mode) 239. bones -- yes vs y to confirm saving bones data in debug mode 240. attack -- yes vs y to confirm attacking a peaceful monster 241. wand-break -- yes vs y to confirm breaking a wand 242. eating -- yes vs y to confirm whether to continue eating 243. Were-change -- yes vs y to confirm changing form due to 244. lycanthropy when hero has polymorph control; 245. pray -- y to confirm an attempt to pray; on by default 246. trap -- y to enter a known trap unless it is harmless; 247. swim -- require m prefix to move into water or lava when 248. hero has seen it and isn't impaired; on by default; 249. AutoAll -- y to confirm if using menustyle:Full and choice 'A' 250. in the object class filtering menu is selected; 251. Remove -- always pick from inventory for 'R' and 'T' even when 252. wearing just one applicable item to remove or take off 253. perminv_mode if the interface supports a persistent inventory window [a] 254. and the perm_invent option is true, this controls what 255. will be shown: 256. none/off -- behave as if perm_invent is false 257. all/on -- show inventory except for gold (default) 258. full -- show inventory including gold 259. in-use -- only show worn and wielded items 260. (the tty interface's optional perm_invent support includes 261. a couple of additional choices that vary all and full) 262. pickup_burden when you pick up an item that exceeds this encumbrance [S] 263. level (Unencumbered, Burdened, streSsed, straiNed, overTaxed, 264. or overLoaded), you will be asked if you want to continue. 265. pickup_types a list of default symbols for kinds of objects to [] 266. autopickup when that option is on; empty list means "all" 267. pile_limit for feedback when walking across floor objects, [5] 268. threshold at which "there are objects here" is displayed 269. instead of listing them. (0 means "always list objects.") 270. runmode controls how often the map window is updated for [run] 271. multi-step movement (various running modes or travel command): 272. teleport -- don't update map until movement stops; 273. run -- periodically update map (interval is seven steps); 274. walk -- update map after every step; 275. crawl -- like walk, but delay after making each step. 276. (This only affects screen display, not actual movement.) 277. scores the parts of the score list you wish [!own/3 top/2 around] 278. to see when the game ends. You choose a combination of 279. top scores, scores around the top scores, and all of your 280. own scores. 281. sortdiscoveries preferred order when viewing list of discovered objects [o] 282. o -- in order of discovery within each class 283. s -- sortloot's "loot" order 284. c -- alphabetized within each class 285. a -- alphabetized across all classes 286. sortloot preferred order when examining a set of objects [n] 287. none -- no sorting 288. loot -- sort piles of objects on floor and in containers 289. full -- 'loot' plus objects in inventory 290. sortvanquished preferred order when viewing vanquished monsters list [t] 291. t -- traditional, order by monster level 292. d -- order by monster difficulty rating 293. a -- alphabetical, first any unique monsters then others 294. c -- order by class, low to high level within each class 295. n -- order by count, high to low 296. z -- order by count, low to high 297. statushilites whether to display status highlights (when non-zero) and [0] 298. also how many turns to display temporary highlights (for 299. 'up', 'down', and 'changed' hilite_status rules) 300. statuslines whether to use expanded (3) or condensed (2) status [2] 301. (for tty and curses; 2 is traditional, 3 is recommended; 302. also for Qt, where 3 is traditional and 2 is recommended) 303. suppress_alert disable various version-specific warnings about changes [] 304. in game play or the user interface, such as notification given 305. for the 'Q' command that quitting is now done via #quit 306. (e.g., use suppress_alert:3.3.1 to stop that and any other 307. notifications added in that version or earlier) 308. versinfo selects what information is displayed when showvers [1 or 4] 309. is true (default depends on program development status) 310. whatis_coord controls whether to include map coordinates when [n] 311. autodescribe is active for the '/' and ';' commands. 312. Value is the first letter of one of 313. compass -- (relative to you; 'east' or '3s' or '2n,4w') 314. full compass -- ('east' or '3south' or '2north,4west') 315. map -- <x,y> (map column x=0 is not used) 316. screen -- [row,column] (row is offset to match tty usage) 317. none -- no coordinates shown. 318. whatis_filter controls how to filter eligible map coordinates when [n] 319. getting a map location for eg. the travel command. 320. Value is the one of 321. n - no filtering 322. v - locations in view only 323. a - locations in same area (room, corridor, etc) 324. 325. Compound options which may be set only on startup are: 326. 327. align Your starting alignment (lawful, neutral, chaotic, [random] 328. or random). Many roles restrict the choice to a subset. 329. You may specify just the first letter. 330. catname name of your starting pet if it is a kitten [none] 331. dogname name of your starting pet if it is a little dog [none] 332. Several roles who start with a dog have one whose name is 333. pre-set (for example, "Hachi" for Samurai), but that name 334. will be overridden if you specify dogname. 335. gender Your starting gender (male, female, or random). [random] 336. You may specify just the first letter. Although you can 337. still denote your gender using the old "male" and "female" 338. boolean options, the "gender" option will take precedence. 339. horsename name of your starting pet if it is a pony [none] 340. menu_* specify single character accelerators for menu commands. 341. Here is a list of all commands with their default keystroke 342. followed by a list of window-ports that implement them: 343. (t is tty, c is curses, w is Windows GUI, x is X11, q is Qt) 344. menu_first_page jump to the first page in a menu [^](tcwxq) 345. menu_last_page jump to the last page in a menu [|](tcwxq) 346. menu_next_page advance to the next menu page [>](tcwxq) 347. menu_previous_page back up to the previous menu page [<](tcwxq) 348. menu_shift_left pan view to left (perm_invent only) [{](cx) 349. menu_shift_right pan view to right (perm_invent only) [}](cx) 350. menu_select_all select all items in a menu [.](tcwxq) 351. menu_select_page select all items on this menu page [,](tcwq) 352. menu_deselect_all deselect all items in a menu [-](tcwxq) 353. menu_deselect_page deselect all items on this menu page [\](tcwq) 354. menu_invert_all invert all items in a menu [@](tcwxq) 355. menu_invert_page invert all items on this menu page [~](tcwq) 356. menu_search prompt for target text and invert [:](tcwxq) 357. items which match that 358. msghistory number of top line messages to save [20] 359. name the name of your character [defaults to username on multi- 360. user systems, asks "who are you?" on single-user systems or if 361. the username is classified as generic like "games"] 362. MS Windows is treated as single-user even though it supports 363. usernames. If character name is specified on the command 364. line (typically via 'nethack -u myname' depending upon type 365. of system and method of access to it), that name overrides 366. 'name' from your options. 367. pettype your preferred type of pet (cat, dog, horse, random, [random] 368. or none), if your role allows more than one type (or if you 369. want to avoid a starting pet). Most roles allow dog or cat 370. but not horse. For roles which force a particular type, 371. pettype is ignored unless it specifies 'none'. 372. playmode normal play or non-scoring explore mode or debug mode [normal] 373. race Your starting race (e.g., race:Human, race:Elf). [random] 374. Most roles restrict race choice to a subset. 375. role Your starting role (e.g., role:Barbarian, role:Valk). [random] 376. Although you can specify just the first letter(s), it will 377. choose only the first role it finds that matches; thus, it 378. is recommended that you spell out as much of the role name 379. as possible. You can also still denote your role by 380. appending it to the "name" option (e.g., name:Vic-V), but 381. the "role" option will take precedence. 382. windowtype windowing system to be used [depends on operating system and 383. compile-time setup] if more than one choice is available. 384. Some instances of the program support only one window-type; 385. when that is the case, you don't need to specify anything. 386. The list of supported window-types in your program can be 387. seen while the program is running by using the #version 388. command or from outside the program by examining the text file 389. named 'options' which is generated when building it. 390. 391. Some sample options lists are: 392. !autopickup,!tombstone,name:Gandalf,scores:own/3 top/2 around 393. female,nonews,dogname:Rover,rest_on_space,!verbose,menustyle:traditional