]> granicus.if.org Git - nethack/commitdiff
dat/opthelp formatting (mostly)
authorPatR <rankin@nethack.org>
Wed, 14 Jun 2017 22:12:31 +0000 (15:12 -0700)
committerPatR <rankin@nethack.org>
Wed, 14 Jun 2017 22:12:31 +0000 (15:12 -0700)
Make the formatting of 'opthelp' be more consistent.  When entries
span multiple lines, sometimes the default value was shown on the
first line, sometimes on the last.  This puts it on the first line
which is more useful for quick looks with 'grep'.

This also adds an explanation for the value of 'disclose', adds
missing choice "full compass" to 'whatis_coord', and expands upon
the explanation for several other compound options.

As mentioned at least once before, menu_* is missing win32 in the
list of interfaces that support the various menu accelerators.

dat/opthelp

index cfa7692b2b3ffddb36798877df1f2260bd2c07c1..783e9ed5784992726ed073101b741ee1d0737ab5 100644 (file)
@@ -6,8 +6,8 @@ autodescribe   describe the terrain under cursor                  [FALSE]
 autodig        dig if moving and wielding digging tool            [FALSE]
 autoopen       walking into a door attempts to open it            [TRUE]
 autopickup     automatically pick up objects you move over        [TRUE]
-autoquiver     when firing with an empty quiver, select some
-               suitable inventory weapon to fill the quiver       [FALSE]
+autoquiver     when firing with an empty quiver, select some      [FALSE]
+               suitable inventory weapon to fill the quiver
 BIOS           allow the use of IBM ROM BIOS calls                [FALSE]
 cmdassist      give help for errors on direction & other commands [TRUE]
 confirm        ask before hitting tame or peaceful monsters       [TRUE]
@@ -29,8 +29,8 @@ null           allow nulls to be sent to your terminal            [TRUE]
                delay code) if moving objects seem to teleport across rooms
 perm_invent    keep inventory in a permanent window               [FALSE]
 pickup_thrown  override pickup_types for thrown objects           [TRUE]
-pushweapon     when wielding a new weapon, put your previously
-               wielded weapon into the secondary weapon slot      [FALSE]
+pushweapon     when wielding a new weapon, put your previously    [FALSE]
+               wielded weapon into the secondary weapon slot
 rawio          allow the use of raw I/O                           [FALSE]
 rest_on_space  count the space bar as a rest character            [FALSE]
 safe_pet       prevent you from (knowingly) attacking your pet(s) [TRUE]
@@ -54,43 +54,41 @@ use_inverse    display detected monsters in highlighted manner    [FALSE]
 verbose        print more commentary during the game              [TRUE]
 
 
-
 There are further boolean options controlled by compilation flags.
 
 Boolean option if INSURANCE was set at compile time:
-checkpoint save game state after each level change, for possible  [TRUE]
-           recovery after program crash
+checkpoint     save game state after each level change, for       [TRUE]
+               possible recovery after program crash
 
 Boolean option if NEWS was set at compile time:
-news       print any news from game administrator on startup      [TRUE]
+news           print any news from game administrator on startup  [TRUE]
 
 Boolean option if MFLOPPY was set at compile time:
-checkspace check free disk space before writing files to disk     [TRUE]
-
+checkspace     check free disk space before writing files to disk [TRUE]
 
 Boolean option if SCORE_ON_BOTL was set at compile time:
-showscore  display your approximate accumulated score             [FALSE]
+showscore      display your approximate accumulated score         [FALSE]
 
 Boolean options if TEXTCOLOR was set at compile time:
-color      use different colors for objects on screen   [TRUE for micros]
-hilite_pet display pets in a highlighted manner                   [FALSE]
+color          use different colors for objects on screen [TRUE for micros]
+hilite_pet     display pets in a highlighted manner               [FALSE]
 
 Boolean option if TIMED_DELAY was set at compile time (tty interface only):
-timed_delay    on unix and VMS, use a timer instead of sending
+timed_delay    on unix and VMS, use a timer instead of sending    [TRUE]
                extra screen output when attempting to pause for
                display effect.  on MSDOS without the termcap
-               lib, whether or not to pause for visual effect.    [TRUE]
+               lib, whether or not to pause for visual effect.
 
 Boolean option for Amiga, or for others if ALTMETA was set at compile time:
 altmeta        For Amiga, treat Alt+key as Meta+key.              [TRUE]
 altmeta        For unix and VMS, treat two character sequence
-               "ESC c" as M-c (Meta+c, 8th bit set) when nethack
-               obtains a command from player's keyboard.          [FALSE]
+               "ESC c" as M-c (Meta+c, 8th bit set) when nethack  [FALSE]
+               obtains a command from player's keyboard.
 
 Boolean option if USE_TILES was set at compile time (MSDOS protected mode only):
-preload_tiles  control whether tiles get pre-loaded into RAM at the
-               start of the game.  Doing so enhances performance
-               of the tile graphics, but uses more memory.        [TRUE]
+preload_tiles  control whether tiles get pre-loaded into RAM at   [TRUE]
+               the start of the game.  Doing so enhances performance
+               of the tile graphics, but uses more memory.
 
 Any Boolean option can be negated by prefixing it with a '!' or 'no'.
 
@@ -99,34 +97,45 @@ Compound options are written as option_name:option_value.
 
 Compound options which can be set during the game are:
 
-boulder       override the default boulder symbol with another default: [`]
-disclose      the types of information you want offered at the end of the
-              game  [ni na nv ng nc no]
-fruit         the name of a fruit you enjoy eating  [slime mold]
+boulder       override the default boulder symbol                       [`]
+disclose      the types of information you want         [ni na nv ng nc no]
+              offered at the end of the game
+              (space separated list of two-character values;
+              prefix: '+' always disclose, '-' never disclose,
+              'n' prompt with default "no", 'y' prompt with default "yes",
+              'a' prompt to select sorting order (for suffix 'v' only);
+              suffix: 'i' inventory, 'a' attributes, 'v' vanquished
+              monsters, 'g' genocided and extinct monsters, 'c' conduct,
+              'o' dungeon overview)
+fruit         the name of a fruit you enjoy eating             [slime mold]
               (basically a whimsy which NetHack uses from time to time).
-menustyle     user interface for selection of multiple objects:
+menustyle     user interface for selection of multiple objects:      [Full]
               Traditional -- prompt for classes of interest, then
                              prompt item-by-item for those classes;
               Combination -- prompt for classes of interest, then
                              use a menu for choosing items;
               Full        -- menu for classes of interest, then item menu;
               Partial     -- skip class filtering, use menu of all items;
-              only the first letter ('T','C','P','F') matters; 'N' (None)
-              is a synonym for 'T', as is boolean style negation  [Full]
-number_pad    alphabetic versus numeric control over movement:
+              only the first letter ('T','C','F','P') matters
+              (With Traditional, many actions allow pseudo-class 'm' to
+              request a menu for choosing items: one-shot Combination.)
+number_pad    alphabetic versus numeric control over movement:          [0]
                0 -- traditional hjkl + yubn movement (default);
                1 -- digits control movement, for use with numeric keypad;
                2 -- same as 1, but '5' works as 'g' prefix rather than 'G';
                3 -- numeric for phone keypad (1,2,3 above, 7,8,9 below);
-               4 -- phone keypad (3) combined with MSDOS compatibility (2);
-              -1 -- alphabetic movement but 'z' swapped with 'y'.  [0]
-packorder     a list of default symbols for kinds of objects that gives the
-              order in which your pack will be displayed  [")[%?+!=/(*`0_]
+               4 -- phone keypad (3) combined with '5' preference (2);
+              -1 -- alphabetic movement but 'z' swapped with 'y'.
+              Setting number_pad (to a positive value) affects how all
+              digit keys are handled, not just those on numeric keypad.
+packorder     a list of default symbols for kinds of       [")[%?+!=/(*`0_]
+              objects that gives the order in which your inventory (and
+              some other things) gets shown if the 'sortpack' option is on
               (If you specify only some kinds of items, the others from the
               default order will be appended to the end.)
-paranoid_confirmation  space separated list of situations where alternate
-              prompting is desired  [paranoid_confirmation:pray]
-              Confirm -- when requiring yes, also require no to reject
+paranoid_confirmation  space separated list    [paranoid_confirmation:pray]
+              of situations where alternate prompting is desired
+              Confirm -- when requiring "yes", also require "no" to reject
               quit    -- yes vs y to confirm quitting or to enter explore mode
               die     -- yes vs y to confirm dying (for explore or debug mode)
               bones   -- yes vs y to confirm saving bones data in debug mode
@@ -134,87 +143,109 @@ paranoid_confirmation  space separated list of situations where alternate
               pray    -- y to confirm an attempt to pray; on by default
               Remove  -- always pick from inventory for 'R' and 'T' even when
               wearing just one applicable item to remove or take off
-pickup_burden when you pick up an item that exceeds this encumberance
+pickup_burden when you pick up an item that exceeds this encumberance   [S]
               level (Unencumbered, Burdened, streSsed, straiNed, overTaxed,
-              or overLoaded), you will be asked if you want to continue. [S]
-pickup_types  a list of default symbols for kinds of objects to autopickup
-              when that option is on  [all]
-pile_limit    for feedback when walking across floor objects, threshold at
-              which "there are many objects here" is displayed instead of
-              listing the objects.  (0 means "always list objects.")  [5]
-runmode       controls how often the map window is updated when performing
+              or overLoaded), you will be asked if you want to continue.
+pickup_types  a list of default symbols for kinds of objects to          []
+              autopickup when that option is on; empty list means "all"
+pile_limit    for feedback when walking across floor objects,           [5]
+              threshold at which "there are objects here" is displayed
+              instead of listing them.  (0 means "always list objects.")
+runmode       controls how often the map window is updated for        [run]
               multi-step movement (various running modes or travel command):
               teleport -- don't update map until movement stops;
               run      -- periodically update map (interval is seven steps);
               walk     -- update map after every step;
               crawl    -- like walk, but delay after making each step.
-              (This only affects screen display, not actual movement.)  [run]
-scores        the parts of the score list you wish to see when the game ends
-              You choose a combination of top scores, scores around the top
-              scores, and all of your own scores.  [!own/3 top/2 around]
-suppress_alert disable various version-specific warnings about changes
+              (This only affects screen display, not actual movement.)
+scores        the parts of the score list you wish    [!own/3 top/2 around]
+              to see when the game ends.  You choose a combination of
+              top scores, scores around the top scores, and all of your
+              own scores.
+suppress_alert disable various version-specific warnings about changes   []
               in game play or the user interface, such as notification given
               for the 'Q' command that quitting is now done via #quit
               (e.g., use suppress_alert:3.3.1 to stop that and any other
-              notifications added in that version or earlier) default: [(none)]
-whatis_coord  controls whether to include map coordinates when autodescribe
-              is active for the '/' and ';' commands.  Value is the first
-              letter of one of
-              compass -- ('east' or '3s' or '2n,4w')
-              map     -- <x,y>        (map column x=0 is not used)
-              screen  -- [row,column] (row is offset to match tty usage)
-              none    -- no coordinates shown; default: [n]
+              notifications added in that version or earlier)
+whatis_coord  controls whether to include map coordinates when          [n]
+              autodescribe is active for the '/' and ';' commands.
+              Value is the first letter of one of
+              compass      -- (relative to you; 'east' or '3s' or '2n,4w')
+              full compass -- ('east' or '3south' or '2north,4west')
+              map          -- <x,y>        (map column x=0 is not used)
+              screen       -- [row,column] (row is offset to match tty usage)
+              none         -- no coordinates shown.
 
 Compound options which may be set only on startup are:
 
-align      Your starting alignment (align:lawful, align:neutral,
-           or align:chaotic).  You may specify just the first letter.  [RANDOM]
-catname    the name of your first cat  [NONE]
-dogname    the name of your first dog  [NONE]
-gender     Your starting gender (gender:male or gender:female).
+align      Your starting alignment (lawful, neutral, chaotic,      [random]
+           or random).  Many roles restrict the choice to a subset.
+           You may specify just the first letter.
+catname    the name of your first cat                                [none]
+dogname    the name of your first dog                                [none]
+           Several roles who start with a dog have one whose name is
+           pre-set (for example, "Hachi" for Samurai), but that name
+           will be overridden if you specify dogname.
+gender     Your starting gender (male, female, or random).         [random]
            You may specify just the first letter.  Although you can
-           still denote your gender using the "male" and "female"
-           options, the "gender" option will take precedence.  [RANDOM]
-horsename  the name of your first horse  [NONE]
-menu_*     create single character accelerators for menu commands.  Below
-           is a list of all commands.  Each is followed by a list of window-
-           ports that implement them:  'x' is X11, 't' is tty, 'g' is Gem,
-           'a' is Amiga.
-           menu_deselect_all  deselect all items in a menu [-](gxta)
-           menu_deselect_page deselect all items on this menu page [\](gta)
-           menu_first_page    jump to the first page in a menu [^](gta)
-           menu_invert_all    invert all items in a menu [@](gxta)
-           menu_invert_page   invert all items on this menu page [~](gta)
-           menu_last_page     jump to the last page in a menu [|](gta)
-           menu_next_page     goto the next menu page [>](gta)
-           menu_previous_page goto the previous menu page [<](gta)
-           menu_search        search for a menu item [:](gxta)
-           menu_select_all    select all items in a menu [.](gxta)
-           menu_select_page   select all items on this menu page [,](gta)
-msghistory number of top line messages to save [20]
-name       the name of your character  [obtained by asking the system or
-           the player]
-pettype    your preferred type of pet (cat or dog), if your character
-           class uses both types; or none for no pet  [RANDOM]
-playmode   normal play or non-scoring explore mode or debug mode  [normal]
-race       Your starting race (e.g., race:Human, race:Elf).  [RANDOM]
-role       Your starting role (e.g., role:Barbarian, role:Valk).
+           still denote your gender using the old "male" and "female"
+           boolean options, the "gender" option will take precedence.
+horsename  the name of your first horse                              [none]
+menu_*     specify single character accelerators for menu commands.
+           Here is a list of all commands with their default keystroke
+           followed by a list of window-ports that implement them:
+           'x' is X11, 't' is tty, 'g' is Gem, 'a' is Amiga.
+           menu_deselect_all  deselect all items in a menu         [-](xtga)
+           menu_deselect_page deselect all items on this menu page [\](tga)
+           menu_first_page    jump to the first page in a menu     [^](tga)
+           menu_invert_all    invert all items in a menu           [@](xtga)
+           menu_invert_page   invert all items on this menu page   [~](tga)
+           menu_last_page     jump to the last page in a menu      [|](tga)
+           menu_next_page     goto the next menu page              [>](tga)
+           menu_previous_page goto the previous menu page          [<](tga)
+           menu_search        search for a menu item               [:](xtga)
+           menu_select_all    select all items in a menu           [.](xtga)
+           menu_select_page   select all items on this menu page   [,](tga)
+msghistory number of top line messages to save                         [20]
+name       the name of your character      [defaults to username on multi-
+           user systems, asks "who are you?" on single-user systems or if
+           the username is classified as generic like "games"]
+           MS Windows is treated as single-user even though it supports
+           usernames.  If character name is specified on the command
+           line (typically via 'nethack -u myname' depending upon type
+           of system and method of access to it), that name overrides
+           'name' from your options.
+pettype    your preferred type of pet (cat, dog, horse, random,    [random]
+           or none), if your role allows more than one type (or if you
+           want to avoid a starting pet).  Most roles allow dog or cat
+           but not horse.  For roles which force a particular type,
+           pettype is ignored unless it specifies 'none'.
+playmode   normal play or non-scoring explore mode or debug mode   [normal]
+race       Your starting race (e.g., race:Human, race:Elf).        [random]
+           Most roles restrict race choice to a subset.
+role       Your starting role (e.g., role:Barbarian, role:Valk).   [random]
            Although you can specify just the first letter(s), it will
            choose only the first role it finds that matches; thus, it
            is recommended that you spell out as much of the role name
            as possible.  You can also still denote your role by
-           appending it to the "name" option (e.g., name:Vic-V), but the
-           "role" option will take precedence.  [RANDOM]
-
-windowtype windowing system to be used  [depends on operating system]
+           appending it to the "name" option (e.g., name:Vic-V), but
+           the "role" option will take precedence.
+windowtype windowing system to be used    [depends on operating system and
+           compile-time setup]    if more than one choice is available.
+           Most instances of the program support only one window-type;
+           when that is the case, you don't need to specify anything.
+           The list of supported window-types in your program can be
+           seen while the program is running by using the #version
+           command or from outside the program by examining the text file
+           named 'options' which is generated when building it.
 
 Compound option if TTY_GRAPHICS was set at compile time:
-msg_window the type of message window to use:
+msg_window the type of message window to use:                      [single]
            single      -- One message at a time
            full        -- Full window with all saved top line messages
            reverse     -- Same as full, but messages printed most-recent-first
            combination -- Two single messages, then as full
-           default:  single
+
 
 Some sample options lists are:
 !autopickup,!tombstone,name:Gandalf,scores:own/3 top/2 around