]> granicus.if.org Git - nethack/commitdiff
options help
authorPatR <rankin@nethack.org>
Thu, 26 Nov 2020 20:00:00 +0000 (12:00 -0800)
committerPatR <rankin@nethack.org>
Thu, 26 Nov 2020 20:00:00 +0000 (12:00 -0800)
Add a few missing options to dat/opthelp (without worrying about
"if FOO was set at compile time").  No doubt there are lots of
others still missing.

Reword a few options in dat/opthelp and also in the dynamic help
derived from optlist.h, particuarly catname, dogname, horsename
whose descriptions have always been confusing or maybe confused.

dat/opthelp
include/optlist.h

index 1bcf574740e917254368bc6e91614e647c5c7f87..9ca82f9be645e9e87f16badcc1928bdee8065249 100644 (file)
@@ -135,6 +135,8 @@ disclose      the types of information you want         [ni na nv ng nc no]
               'o' dungeon overview)
 fruit         the name of a fruit you enjoy eating             [slime mold]
               (basically a whimsy which NetHack uses from time to time).
+hilite_status specifies a rule for highlighting a status field           []
+              (multiple instances are allowed)
 menustyle     user interface for selection of multiple objects:      [Full]
               Traditional -- prompt for classes of interest, then
                              prompt item-by-item for those classes;
@@ -145,13 +147,24 @@ menustyle     user interface for selection of multiple objects:      [Full]
               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.)
+msg_window    behavior of ^P message recall for tty interface:          [s]
+              single      -- one message at a time
+              full        -- full window with all saved top line messages
+              reverse     -- full with messages printed most-recent-first
+              combination -- first two of consecutive ^P commands show
+                             single messages, third yields full set
+msg_window    behavior of ^P message recall for curses interface:       [r]
+              reverse     -- full window, most recent first
+              full        -- full with messages printed least recent first,
+                             initially positioned on last page to start
+                             with most recent messages in view
 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 '5' preference (2);
-              -1 -- alphabetic movement but 'z' swapped with 'y'.
+              -1 -- "qwertz"; 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_]
@@ -192,6 +205,11 @@ 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.
+statushilites whether to display status highlights (when non-zero) and  [0]
+              also how many turns to display temporary highlights (for
+              'up', 'down', and 'changed' hilite_status rules)
+statuslines   whether to use expanded (3) or condensed (2) status       [2]
+              (for tty and curses; 2 is traditional, 3 is recommended)
 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
@@ -217,8 +235,8 @@ Compound options which may be set only on startup are:
 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]
+catname    name of your starting pet when it is a kitten             [none]
+dogname    name of your starting pet when it is a little 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.
@@ -226,7 +244,7 @@ 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 old "male" and "female"
            boolean options, the "gender" option will take precedence.
-horsename  the name of your first horse                              [none]
+horsename  name of your starting pet when it is a pony               [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:
@@ -266,6 +284,9 @@ role       Your starting role (e.g., role:Barbarian, role:Valk).   [random]
            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.
+statuslines whether to use expanded (3) or condensed (2) status         [2]
+           (unlike for tty and curses, for Qt this can only be be set at
+           startup; also unlike tty and curses, 2 is recommended over 3)
 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;
@@ -275,14 +296,6 @@ windowtype windowing system to be used    [depends on operating system and
            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:                      [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
-
-
 Some sample options lists are:
 !autopickup,!tombstone,name:Gandalf,scores:own/3 top/2 around
 female,nonews,dogname:Rover,rest_on_space,!verbose,menustyle:traditional
index 06fb03f6abd7a9ca528809d422c0b631d984f3b8..0e290c1433b8a1dcb831d641f8d4707d1b6ee4cd 100644 (file)
@@ -120,7 +120,7 @@ pfx_##a,
                 "deprecated (use S_boulder in sym file instead)")
 #endif
     NHOPTC(catname, PL_PSIZ, opt_in, set_gameview, No, Yes, No, No, NoAlias,
-                "the name of your (first) cat (e.g., catname:Tabby)")
+                "name of your starting pet when it is a kitten")
 #ifdef INSURANCE
     NHOPTB(checkpoint, 0, opt_out, set_in_game, On, Yes, No, No, NoAlias,
                 &flags.ins_chkpt)
@@ -150,11 +150,11 @@ pfx_##a,
                 opt_in, set_in_game, Yes, Yes, No, Yes, NoAlias,
                 "the kinds of information to disclose at end of game")
     NHOPTC(dogname, PL_PSIZ, opt_in, set_gameview, No, Yes, No, No, NoAlias,
-                "the name of your (first) dog (e.g., dogname:Fang)")
+                "name of your starting pet when it is a little dog")
     NHOPTC(dungeon, MAXDCHARS + 1,opt_in, set_in_config, No, Yes, No, No,
-                NoAlias, "the symbols to use in drawing the dungeon map")
+                NoAlias, "list of symbols to use in drawing the dungeon map")
     NHOPTC(effects, MAXECHARS + 1, opt_in, set_in_config, No, Yes, No, No,
-                NoAlias, "the symbols to use in drawing special effects")
+                NoAlias, "list of symbols to use in drawing special effects")
     NHOPTB(eight_bit_tty, 0, opt_in, set_in_game, Off, Yes, No, No, NoAlias,
                 &iflags.wc_eight_bit_input)
     NHOPTB(extmenu, 0, opt_in, set_in_game, Off, Yes, No, No, NoAlias,
@@ -164,29 +164,29 @@ pfx_##a,
     NHOPTB(fixinv, 0, opt_out, set_in_game, On, Yes, No, No, NoAlias,
                 &flags.invlet_constant)
     NHOPTC(font_map, 40, opt_in, set_gameview, Yes, Yes, Yes, No, NoAlias,
-                "the font to use in the map window")
+                "font to use in the map window")
     NHOPTC(font_menu, 40, opt_in, set_gameview, Yes, Yes, Yes, No, NoAlias,
-                "the font to use in menus")
+                "font to use in menus")
     NHOPTC(font_message, 40, opt_in, set_gameview, Yes, Yes, Yes, No, NoAlias,
-                "the font to use in the message window")
+                "font to use in the message window")
     NHOPTC(font_size_map, 20, opt_in, set_gameview, Yes, Yes, Yes, No, NoAlias,
-                "the size of the map font")
+                "size of the map font")
     NHOPTC(font_size_menu, 20, opt_in, set_gameview, Yes, Yes, Yes, No,
-                NoAlias, "the size of the menu font")
+                NoAlias, "size of the menu font")
     NHOPTC(font_size_message, 20, opt_in, set_gameview, Yes, Yes, Yes, No,
-                NoAlias, "the size of the message font")
+                NoAlias, "size of the message font")
     NHOPTC(font_size_status, 20, opt_in, set_gameview, Yes, Yes, Yes, No,
-                NoAlias, "the size of the status font")
+                NoAlias, "size of the status font")
     NHOPTC(font_size_text, 20, opt_in, set_gameview, Yes, Yes, Yes, No,
-                NoAlias, "the size of the text font")
+                NoAlias, "size of the text font")
     NHOPTC(font_status, 40, opt_in, set_gameview, Yes, Yes, Yes, No, NoAlias,
-                "the font to use in status window")
+                "font to use in status window")
     NHOPTC(font_text, 40, opt_in, set_gameview, Yes, Yes, Yes, No, NoAlias,
-                "the font to use in text windows")
+                "font to use in text windows")
     NHOPTB(force_invmenu, 0, opt_in, set_in_game, Off, Yes, No, No, NoAlias,
                 &iflags.force_invmenu)
     NHOPTC(fruit, PL_FSIZ, opt_in, set_in_game, No, Yes, No, No, NoAlias,
-                "the name of a fruit you enjoy eating")
+                "name of a fruit you enjoy eating")
     NHOPTB(fullscreen, 0, opt_in, set_in_config, Off, Yes, No, No, NoAlias,
                 &iflags.wc2_fullscreen)
     NHOPTC(gender, 8, opt_in, set_gameview, No, Yes, No, No, NoAlias,
@@ -209,12 +209,12 @@ pfx_##a,
                 &iflags.hilite_pile)
 #ifdef STATUS_HILITES
     NHOPTC(hilite_status, 13, opt_out, set_in_game, Yes, Yes, Yes, No, NoAlias,
-                "hilite_status")
+                "a status highlighting rule (can occur multiple times)")
 #endif
     NHOPTB(hitpointbar, 0, opt_in, set_in_game, Off, Yes, No, No, NoAlias,
                 &iflags.wc2_hitpointbar)
     NHOPTC(horsename, PL_PSIZ, opt_in, set_gameview, No, Yes, No, No, NoAlias,
-                "name of your (first) horse (e.g., horsename:Silver)")
+                "name of your starting pet when it is a pony")
 #ifdef BACKWARD_COMPAT
     NHOPTC(IBMgraphics, 70, opt_in, set_in_config, Yes, Yes, No, No, NoAlias,
                 "load IBMGraphics display symbols")
@@ -292,7 +292,7 @@ pfx_##a,
     NHOPTB(monpolycontrol, 0, opt_in, set_wizonly, Off, Yes, No, No, NoAlias,
                 &iflags.mon_polycontrol)
     NHOPTC(monsters, MAXMCLASSES, opt_in, set_in_config, No, Yes, No, No,
-                NoAlias, "the symbols to use for monsters")
+                NoAlias, "list of symbols to use for monsters")
     NHOPTC(mouse_support, 0, opt_in, set_in_game, No, Yes, No, No, NoAlias,
                 "game receives click info from mouse")
 #if defined(TTY_GRAPHICS) || defined(CURSES_GRAPHICS)
@@ -320,7 +320,7 @@ pfx_##a,
     NHOPTC(number_pad, 1, opt_in, set_in_game, No, Yes, No, Yes, NoAlias,
                 "use the number pad for movement")
     NHOPTC(objects, MAXOCLASSES, opt_in, set_in_config, No, Yes, No, No,
-                NoAlias, "the symbols to use for objects")
+                NoAlias, "list of symbols to use for objects")
     NHOPTC(packorder, MAXOCLASSES, opt_in, set_in_game, No, Yes, No, No,
                 NoAlias, "the inventory order of the items in your pack")
 #ifdef CHANGE_COLOR
@@ -422,8 +422,8 @@ pfx_##a,
     NHOPTC(statushilites, 20, opt_in, set_in_game, Yes, Yes, Yes, No, NoAlias,
                 "0=no status highlighting, N=show highlights for N turns")
 #else
-    NHOPTC(statushilites, 20, opt_in, set_in_config, Yes, Yes, Yes, No, NoAlias,
-                "highlight control")
+    NHOPTC(statushilites, 20, opt_in, set_in_config, Yes, Yes, Yes, No,
+                NoAlias, "highlight control")
 #endif
     NHOPTC(statuslines, 20, opt_in, set_in_game, No, Yes, No, No, NoAlias,
                 "2 or 3 lines for status display")
@@ -461,7 +461,7 @@ pfx_##a,
     NHOPTB(toptenwin, 0, opt_in, set_in_game, Off, Yes, No, No, NoAlias,
                 &iflags.toptenwin)
     NHOPTC(traps, MAXTCHARS + 1, opt_in, set_in_config, No, Yes, No, No,
-                NoAlias, "the symbols to use in drawing traps")
+                NoAlias, "list of symbols to use in drawing traps")
     NHOPTB(travel, 0, opt_out, set_in_game, On, Yes, No, No, NoAlias,
                 &flags.travelcmd)
 #ifdef DEBUG
@@ -528,7 +528,7 @@ pfx_##a,
     NHOPTC(windowcolors, 80, opt_in, set_gameview, No, Yes, No, No, NoAlias,
                 "the foreground/background colors of windows")
     NHOPTC(windowtype, WINTYPELEN, opt_in, set_gameview, No, Yes, No, No,
-                NoAlias, "windowing system to use")
+                NoAlias, "windowing system to use (should be specified first)")
     NHOPTB(wizweight, 0, opt_in, set_wizonly, Off, Yes, No, No, NoAlias,
                 &iflags.wizweight)
     NHOPTB(wraptext, 0, opt_in, set_in_game, Off, Yes, No, No, NoAlias,