From: PatR Date: Fri, 19 Mar 2021 08:59:38 +0000 (-0700) Subject: Guidebook update for #perminv X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f751905e16a9c37802202f71f2e386096af2b2e1;p=nethack Guidebook update for #perminv Interaction with persistent inventory window was documented for the '|' key a week ago but nothing was specified for '#perminv'. menu_shift_left and menu_shift_right for X11 are now explicitly for the perm_invent menu only. --- diff --git a/doc/Guidebook.mn b/doc/Guidebook.mn index 7bafb7c0c..b308a5a68 100644 --- a/doc/Guidebook.mn +++ b/doc/Guidebook.mn @@ -35,7 +35,7 @@ .ds vr "NetHack 3.7 .ds f0 "\*(vr .ds f1 -.ds f2 "March 12, 2021 +.ds f2 "March 18, 2021 . .\" A note on some special characters: .\" \(lq = left double quote @@ -1362,6 +1362,14 @@ option to require a response of \f(CRyes\fP instead. .lp "#pay " Pay your shopping bill. Default key is \(oqp\(cq. +.lp "#perminv " +If persistent inventory display is supported and enabled (with the +.op perm_invent +option), interact with it instead of with the map. +You'll be prompted for menu scrolling keystrokes such +as \(oq\f(CR>\fP\(cq and \(oq\f(CR<\fP\(cq. +Press \f(CRReturn\fP or \f(CREscape\fP to resume normal play. +Default key is \(oq|\(cq. .lp "#pickup " Pick up things at the current location. Default key is \(oq,\(cq. @@ -3787,15 +3795,15 @@ objects for selection. Partial skips the object class filtering and immediately displays a menu of all objects. .lp menu_deselect_all -Menu character accelerator to deselect all items in a menu. +Key to deselect all items in a menu. Implemented by the Amiga, Gem, X11 and tty ports. Default \(oq\-\(cq. .lp menu_deselect_page -Menu character accelerator to deselect all items on this page of a menu. +Key to deselect all items on this page of a menu. Implemented by the Amiga, Gem and tty ports. Default \(oq\\\(cq. .lp menu_first_page -Menu character accelerator to jump to the first page in a menu. +Key to jump to the first page in a menu. Implemented by the Amiga, Gem and tty ports. Default \(oq\(ha\(cq. .lp menu_headings @@ -3804,19 +3812,19 @@ Values are \(lqnone\(rq, \(lqbold\(rq, \(lqdim\(rq, \(lqunderline\(rq, \(lqblink\(rq, or \(lqinverse\(rq. Not all ports can actually display all types. .lp menu_invert_all -Menu character accelerator to invert all items in a menu. +Key to invert all items in a menu. Implemented by the Amiga, Gem, X11 and tty ports. Default \(oq@\(cq. .lp menu_invert_page -Menu character accelerator to invert all items on this page of a menu. +Key to invert all items on this page of a menu. Implemented by the Amiga, Gem and tty ports. Default \(oq\(ti\(cq. \" ~ .lp menu_last_page -Menu character accelerator to jump to the last page in a menu. +Key to jump to the last page in a menu. Implemented by the Amiga, Gem and tty ports. Default \(oq|\(cq. .lp menu_next_page -Menu character accelerator to goto the next menu page. +Key to go to the next menu page. Implemented by the Amiga, Gem and tty ports. Default \(oq>\(cq. .lp menu_objsyms @@ -3827,34 +3835,34 @@ Do not clear the screen before drawing menus, and align menus to the right edge of the screen. Only for the tty port. (default on) .lp menu_previous_page -Menu character accelerator to goto the previous menu page. +Key to go to the previous menu page. Implemented by the Amiga, Gem and tty ports. Default \(oq<\(cq. .lp menu_search -Menu character accelerator to search for a menu item. +Key to search for a menu item. Implemented by the Amiga, Gem, X11 and tty ports. Default \(oq:\(cq. .lp menu_select_all -Menu character accelerator to select all items in a menu. +Key to select all items in a menu. Implemented by the Amiga, Gem, X11 and tty ports. Default \(oq.\(cq. .lp menu_select_page -Menu character accelerator to select all items on this page of a menu. +Key to select all items on this page of a menu. Implemented by the Amiga, Gem and tty ports. Default \(oq,\(cq. .lp menu_shift_left -Menu character accelerator to scroll a menu\(emone which has been +Key to scroll a menu\(emone which has been scrolled right\(emback to the left. -Implemented by curses for +Implemented for .op perm_invent -only and by X11. +only by curses and X11. Default \(oq{\(cq. .lp menu_shift_right -Menu character accelerator to scroll a menu which has text beyond the +Key to scroll a menu which has text beyond the right edge to the right. -Implemented by curses for +Implemented for .op perm_invent -only and by X11. +only by curses and X11. Default \(oq}\(cq. ." .lp menu_tab_sep ." Format menu entries using TAB to separate columns (default off). diff --git a/doc/Guidebook.tex b/doc/Guidebook.tex index e2ed921ae..7dd25b6d8 100644 --- a/doc/Guidebook.tex +++ b/doc/Guidebook.tex @@ -45,7 +45,7 @@ %.au \author{Original version - Eric S. Raymond\\ (Edited and expanded for 3.7 by Mike Stephenson and others)} -\date{March 12, 2021} +\date{March 18, 2021} \maketitle @@ -1185,7 +1185,7 @@ option), interact with it instead of with the map. Allows scrolling with the menu\verb+_+first\verb+_+page, menu\verb+_+previous\verb+_+page, menu\verb+_+next\verb+_+page, and menu\verb+_+last\verb+_+page -keys (`{\tt \^{}}', `{\tt <}', `{\tt >}', `{\tt |}' by default). +keys (`{\tt \^{}}', `{\tt <}', `{\tt >}', `{\tt \verb+|+}' by default). Some interfaces also support menu_shift_left and menu_shift_right keys (`{\tt \verb+{+}' and `{\tt \verb+}+}' by default). Use the {\it Return\/} (aka {\it Enter\/}) or {\it Escape\/} key to @@ -1457,6 +1457,14 @@ option to require a response of ``{\tt yes}'' instead. \item[\tb{\#pay}] Pay your shopping bill. Default key is `{\tt p}'. %.lp +\item[\tb{\#perminv}] +If persistent inventory display is supported and enabled (with the +{\it perm\verb+_+invent\/} option), interact with it instead of with the map. +You'll be prompted for menu scrolling keystrokes such +as `{\tt >}' and `\{\tt <}'. +Press {\tt RReturn} or {\tt Escape} to resume normal play. +Default key is {\tt \verb+|+}. +%.lp \item[\tb{\#pickup}] Pick up things at the current location. Default key is `{\tt ,}'. The `{\tt m}' prefix forces use of a menu. @@ -4099,15 +4107,15 @@ objects for selection. Partial skips the object class filtering and immediately displays a menu of all objects. \item[\ib{menu\verb+_+deselect\verb+_+all}] -Menu character accelerator to deselect all items in a menu. +Key to deselect all items in a menu. Implemented by the Amiga, Gem, X11 and tty ports. Default `-'. \item[\ib{menu\verb+_+deselect\verb+_+page}] -Menu character accelerator to deselect all items on this page of a menu. +Key to deselect all items on this page of a menu. Implemented by the Amiga, Gem and tty ports. Default `\verb+\+'. \item[\ib{menu\verb+_+first\verb+_+page}] -Menu character accelerator to jump to the first page in a menu. +Key to jump to the first page in a menu. Implemented by the Amiga, Gem and tty ports. Default `\verb+^+'. \item[\ib{menu\verb+_+headings}] @@ -4116,19 +4124,19 @@ Values are ``{\tt none}'', ``{\tt bold}'', ``{\tt dim}'', ``{\tt underline}'', ``{\tt blink}'', or ``{\tt inverse}''. Not all ports can actually display all types. \item[\ib{menu\verb+_+invert\verb+_+all}] -Menu character accelerator to invert all items in a menu. +Key to invert all items in a menu. Implemented by the Amiga, Gem, X11 and tty ports. Default `@'. \item[\ib{menu\verb+_+invert\verb+_+page}] -Menu character accelerator to invert all items on this page of a menu. +Key to invert all items on this page of a menu. Implemented by the Amiga, Gem and tty ports. Default `\verb+~+'. \item[\ib{menu\verb+_+last\verb+_+page}] -Menu character accelerator to jump to the last page in a menu. +Key to jump to the last page in a menu. Implemented by the Amiga, Gem and tty ports. Default `\verb+|+'. \item[\ib{menu\verb+_+next\verb+_+page}] -Menu character accelerator to goto the next menu page. +Key to go to the next menu page. Implemented by the Amiga, Gem and tty ports. Default `\verb+>+'. \item[\ib{menu\verb+_+objsyms}] @@ -4139,36 +4147,35 @@ Do not clear the screen before drawing menus, and align menus to the right edge of the screen. Only for the tty port. (default on) \item[\ib{menu\verb+_+previous\verb+_+page}] -Menu character accelerator to goto the previous menu page. +Key to go to the previous menu page. Implemented by the Amiga, Gem and tty ports. Default `\verb+<+'. \item[\ib{menu\verb+_+search}] -Menu character accelerator to search for a menu item. +Key to search for a menu item. Implemented by the Amiga, Gem, X11 and tty ports. Default `:'. \item[\ib{menu\verb+_+select\verb+_+all}] -Menu character accelerator to select all items in a menu. +Key to select all items in a menu. Implemented by the Amiga, Gem, X11 and tty ports. Default `.'. \item[\ib{menu\verb+_+select\verb+_+page}] -Menu character accelerator to select all items on this page of a menu. +Key to select all items on this page of a menu. Implemented by the Amiga, Gem and tty ports. Default `,'. %.lp \item[\ib{menu\verb+_+shift\verb+_+left}] -Menu character accelerator to scroll a menu---one which has been +Key to scroll a menu---one which has been scrolled right---back to the left. -Implemented by curses for {\it perm\verb+_+invent\/} only and by X11. +Implemented for {\it perm\verb+_+invent\/} only by curses and X11. Default `{\tt \verb+{+}'. %.lp \item[\ib{menu\verb+_+shift\verb+_+right}] -Menu character accelerator to scroll a menu which has text beyond the +Key to scroll a menu which has text beyond the right edge to the right. -Implemented by curses for {\it perm\verb+_+invent\/} only and by X11. +Implemented for {\it perm\verb+_+invent\/} only by curses by X11. Default `{\tt \verb+}+}'. -Default \(oq}\(cq. % %.lp % \item[\ib{menu\verb+_+tab\verb+_+sep}] % Format menu entries using TAB to separate columns (default off). @@ -5173,7 +5180,7 @@ the ``{\tt }'', ``{\tt }'', and ``{\tt }'' keys. \item[\tb{Menu accelerator keys}] The menu control or accelerator keys can also be rebound via OPTIONS lines in the configuration file. -You cannot bind object symbols into menu accelerators. +You cannot bind object symbols or selection letters into menu accelerators. %.lp "Special command keys" \item[\tb{Special command keys}]