nethack-gwaa-kiwi/nethack
1
0
Fork 0
Code Pull Requests Activity

Guidebook update

Browse Source 
number_pad got removed from Guidebook.tex when mouse_support was added
by cc0e7a8750fd4e07d3a44592c38f5912d4e603de; put it back.  Evidently
a cut-and-paste mishap when copy-and-paste was intended, probably
provoked by '\numbox{}'.

Remove \numbox{} from mouse_support; it isn't needed there since the
choices aren't trying to line up with '-1'.

Both Guidebook.mn and Guidebook.tex:

Remove number_pad's "for backward compatibility" from mouse_support
since the latter is brand new.

New petattr list of uppercase letters seemed intrusive when rendered
with a bold font, so switch to lowercase.  (Option processing already
supports either case.)

Mention the '=' prefix for hilite_status 'absolute' threshold.

[As usual, the Guidebook.tex changes haven't been tested.]
This commit is contained in:
PatR
2019-03-01 17:09:54 -08:00
parent 7664d604da
commit 23ea5b07fe
2 changed files with 76 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
doc/Guidebook.mn
View File

@@ -1,4 +1,4 @@
.\" $NHDT-Branch: NetHack-3.6.2-beta01 $:$NHDT-Revision: 1.298 $ $NHDT-Date: 1551312285 2019/02/28 00:04:45 $ .\" $NHDT-Branch: NetHack-3.6.2-beta01 $:$NHDT-Revision: 1.299 $ $NHDT-Date: 1551488947 2019/03/02 01:09:07 $
.\" .\"
.\" This is an excerpt from the 'roff' man page from the 'groff' package. .\" This is an excerpt from the 'roff' man page from the 'groff' package.
.\" NetHack's Guidebook.mn currently does *not* adhere to these guidelines. .\" NetHack's Guidebook.mn currently does *not* adhere to these guidelines.
@@ -1713,7 +1713,7 @@ outside the shop.
While the shopkeeper watches you like a hawk, he will generally ignore While the shopkeeper watches you like a hawk, he will generally ignore
any other customers. any other customers.
.lp * 2 .lp * 2
If a shop is \(lqclosed for inventory\(rq, it will not open of its own accord. If a shop is \(lqclosed for inventory,\(rq it will not open of its own accord.
.lp * 2 .lp * 2
Shops do not get restocked with new items, regardless of inventory depletion. Shops do not get restocked with new items, regardless of inventory depletion.
. .
@@ -3158,15 +3158,14 @@ Debug mode only.
.lp mouse_support .lp mouse_support
Allow use of the mouse for input and travel. Allow use of the mouse for input and travel.
Valid settings are: Valid settings are:
.PS -1 .sd
.PL "\ 0" .si
disabled .CC 0 "disabled"
.PL "\ 1" .CC 1 "enabled and make OS adjustments to support mouse use in the game"
enabled and make OS adjustments to support mouse use in the game. .CC 2 "like 1 but does not make any OS adjustments"
.PL "\ 2" .ei
like 1 but does not make any OS adjustments .ed
.PE Omitting a value is the same as specifying 1
For backward compatibility, omitting a value is the same as specifying 1
and negating and negating
.op mouse_support .op mouse_support
is the same as specifying 0. is the same as specifying 0.
@@ -3291,23 +3290,23 @@ boolean option.
Curses interface only; value is one or more of the following letters. Curses interface only; value is one or more of the following letters.
.sd .sd
.si .si
.CC N "Normal text (no highlighting)" .CC n "Normal text (no highlighting)"
.CC I "Inverse video (default)" .CC i "Inverse video (default)"
.CC B "Bold text" .CC b "Bold text"
.CC U "Underlined text" .CC u "Underlined text"
.CC K "blinKing text" .CC k "blinKing text"
.CC D "Dim text" .CC d "Dim text"
.CC T "iTalic text" .CC t "iTalic text"
.CC L "Left line indicator" .CC l "Left line indicator"
.CC R "Right line indicator" .CC r "Right line indicator"
.ei .ei
.ed .ed
Some of those choices might not work, particularly the final three, Some of those choices might not work, particularly the final three,
depending upon terminal hardware or terminal emulation software. depending upon terminal hardware or terminal emulation software.
.lp "" .lp ""
Currently multiple highlight-style letters can be combined by simply Currently multiple highlight-style letters can be combined by simply
stringing them together (for example, \(lqBK\(rq), but in the future stringing them together (for example, \(lqbk\(rq), but in the future
they might require being separated by plus signs (such as \(lqB+K\(rq, they might require being separated by plus signs (such as \(lqb+k\(rq,
which works already). which works already).
When using the \(oqN\(cq choice, it should be specified on its own, When using the \(oqN\(cq choice, it should be specified on its own,
not in combination with any of the other letters. not in combination with any of the other letters.
@@ -4234,13 +4233,13 @@ it also matches when value is below or above the percentage.
Use prefix \(oq<\(cq or \(oq>\(cq to match when strictly below or above. Use prefix \(oq<\(cq or \(oq>\(cq to match when strictly below or above.
(The numeric limit is relaxed slightly for those: \f(CR>-1%\fP (The numeric limit is relaxed slightly for those: \f(CR>-1%\fP
and \f(CR<101%\fP are allowed.) and \f(CR<101%\fP are allowed.)
Only valid for \(lqpower\(rq and \(lqhitpoints\(rq fields. Only valid for \(lqhitpoints\(rq and \(lqpower\(rq fields.
.lp "*" .lp "*"
absolute value sets the attribute when the field value matches absolute value sets the attribute when the field value matches
that number. that number.
The number must be 0 or higher, except for \(lqarmor-class\(cq which The number must be 0 or higher, except for \(lqarmor-class\(cq which
allows negative values. allows negative values, and may optionally be preceded by \(oq=\(cq.
If the number is prefixed with \(oq<=\(cq or \(oq>=\(cq, If the number is preceded by \(oq<=\(cq or \(oq>=\(cq instead,
it also matches when value is below or above. it also matches when value is below or above.
If the prefix is \(oq<\(cq or \(oq>\(cq, only match when strictly If the prefix is \(oq<\(cq or \(oq>\(cq, only match when strictly
above or below. above or below.

75
doc/Guidebook.tex
View File

@@ -1892,7 +1892,7 @@ While the shopkeeper watches you like a hawk, he will generally ignore
any other customers. any other customers.
%.lp \(bu 2 %.lp \(bu 2
\item[$\bullet$] \item[$\bullet$]
If a shop is ``closed for inventory'', it will not open of its own accord. If a shop is ``closed for inventory,'' it will not open of its own accord.
%.lp \(bu 2 %.lp \(bu 2
\item[$\bullet$] \item[$\bullet$]
Shops do not get restocked with new items, regardless of inventory depletion. Shops do not get restocked with new items, regardless of inventory depletion.
@@ -3471,16 +3471,13 @@ Valid settings are:
%.sd %.sd
%.si %.si
\newlength{\mwidth} {\tt 0} --- disabled\\
\settowidth{\mwidth}{\tt -0} {\tt 1} --- enabled and make OS adjustment to support mouse use in the game\\
\newcommand{\numbox}[1]{\makebox[\mwidth][r]{{\tt #1}}} {\tt 2} --- enabled like {\tt 1}, but does not make any OS adjustments\\
\numbox{0} --- disabled\\
\numbox{1} --- enabled and make OS adjustment to support mouse use in the game\\
\numbox{2} --- enabled like {\tt 1}, but does not make any OS adjustments\\
%.ei %.ei
%.ed %.ed
For backward compatibility, omitting a value is the same as specifying {\tt 1} Omitting a value is the same as specifying {\tt 1}
and negating and negating
{\it mouse\verb+_+support\/} {\it mouse\verb+_+support\/}
is the same as specifying {\tt 0}. is the same as specifying {\tt 0}.
@@ -3527,6 +3524,37 @@ Start the character with no armor (default false). Persistent.
\item[\ib{null}] \item[\ib{null}]
Send padding nulls to the terminal (default on). Persistent. Send padding nulls to the terminal (default on). Persistent.
%.lp %.lp
\item[\ib{number\verb+_+pad}]
Use digit keys instead of letters to move (default 0 or off).\\
Valid settings are:
%.sd
%.si
\newlength{\mwidth}
\settowidth{\mwidth}{\tt -0}
\newcommand{\numbox}[1]{\makebox[\mwidth][r]{{\tt #1}}}
\numbox{0} --- move by letters; `{\tt yuhjklbn}'\\
\numbox{1} --- move by numbers; digit `{\tt 5}' acts as `{\tt G}' movement prefix\\
\numbox{2} --- like {\tt 1} but `{\tt 5}' works as `{\tt g}' prefix instead of as `{\tt G}'\\
\numbox{3} --- by numbers using phone key layout; {\tt 123} above, {\tt 789} below\\
\numbox{4} --- combines {\tt 3} with {\tt 2}; phone layout plus MS-DOS compatibility\\
\numbox{-1} --- by letters but use `{\tt z}' to go northwest, `{\tt y}' to zap wands
%.ei
%.ed
For backward compatibility, omitting a value is the same as specifying {\tt 1}
and negating
{\it number\verb+_+pad\/}
is the same as specifying {\tt 0}.
(Settings {\tt 2} and {\tt 4} are for compatibility with MS-DOS or old PC Hack;
in addition to the different behavior for `{\tt 5}', `{\tt Alt-5}' acts as `{\tt G}'
and `{\tt Alt-0}' acts as `{\tt I}'.
Setting {\tt -1} is to accommodate some QWERTZ keyboards which have the
location of the `{\tt y}' and `{\tt z}' keys swapped.)
When moving by numbers, to enter a count prefix for those commands
which accept one (such as ``{\tt 12s}'' to search twelve times), precede it
with the letter `{\tt n}' (``{\tt n12s}'').
%.lp
\item[\ib{packorder}] \item[\ib{packorder}]
Specify the order to list object types in (default Specify the order to list object types in (default
``\verb&")[%?+!=/(*`0_&''). The value of this option should be a string ``\verb&")[%?+!=/(*`0_&''). The value of this option should be a string
@@ -3594,15 +3622,15 @@ Curses interface only; value is one or more of the following letters.
%.sd %.sd
%.si %.si
{\tt N} --- Normal text (no highlighting)\\ {\tt n} --- Normal text (no highlighting)\\
{\tt I} --- Inverse video (default)\\ {\tt i} --- Inverse video (default)\\
{\tt B} --- Bold text\\ {\tt b} --- Bold text\\
{\tt U} --- Underlined text\\ {\tt u} --- Underlined text\\
{\tt K} --- blinKing text\\ {\tt k} --- blinKing text\\
{\tt D} --- Dim text\\ {\tt d} --- Dim text\\
{\tt T} --- iTalic text\\ {\tt t} --- iTalic text\\
{\tt L} --- Left line indicator\\ {\tt l} --- Left line indicator\\
{\tt R} --- Right line indicator\\ {\tt r} --- Right line indicator\\
%.ei %.ei
%.ed %.ed
@@ -3611,8 +3639,8 @@ depending upon terminal hardware or terminal emulation software.
%.lp "" %.lp ""
Currently multiple highlight-style letters can be combined by simply Currently multiple highlight-style letters can be combined by simply
stringing them together (for example, ``BK''), but in the future stringing them together (for example, ``bk''), but in the future
they might require being separated by plus signs (such as ``B\verb&+&K'', they might require being separated by plus signs (such as ``b\verb&+&k'',
which works already). which works already).
When using the `N' choice, it should be specified on its own, When using the `N' choice, it should be specified on its own,
not in combination with any of the other letters. not in combination with any of the other letters.
@@ -4651,7 +4679,8 @@ depending upon your other option settings.
Instead of a behavior, `condition' takes the following condition flags: Instead of a behavior, `condition' takes the following condition flags:
{\it stone}, {\it slime}, {\it strngl}, {\it foodpois}, {\it termill}, {\it stone}, {\it slime}, {\it strngl}, {\it foodpois}, {\it termill},
{\it blind}, {\it deaf}, {\it stun}, {\it conf}, {\it hallu}, {\it blind}, {\it deaf}, {\it stun}, {\it conf}, {\it hallu},
{\it lev}, {\it fly}, and {\it ride}. You can use `major\_troubles' as an alias {\it lev}, {\it fly}, and {\it ride}.
You can use `major\_troubles' as an alias
for stone through termill, `minor\_troubles' for blind through hallu, for stone through termill, `minor\_troubles' for blind through hallu,
`movement' for lev, fly, and ride, and `all' for every condition. `movement' for lev, fly, and ride, and `all' for every condition.
@@ -4686,14 +4715,14 @@ it also matches when value is below or above the percentage.
Use prefix `{\tt <}' or `{\tt >}' to match when strictly below or above. Use prefix `{\tt <}' or `{\tt >}' to match when strictly below or above.
(The numeric limit is relaxed slightly for those: {\tt >-1\%} (The numeric limit is relaxed slightly for those: {\tt >-1\%}
and {\tt <101\%} are allowed.) and {\tt <101\%} are allowed.)
Only valid for ``{\it power\/}'' and ``{\it hitpoints\/}'' fields. Only valid for ``{\it hitpoints\/}'' and ``{\it power\/}'' fields.
%.lp "*" %.lp "*"
\item{\bb{}} \item{\bb{}}
absolute value sets the attribute when the field value absolute value sets the attribute when the field value
matches that number. matches that number.
The number must be 0 or higher, except for ``{\it armor-class\/} which The number must be 0 or higher, except for ``{\it armor-class\/} which
allows negative values. allows negative values, and may optionally be preceded by `{\tt =}'.
If the number is prefixed with `{\tt <=}' or `{\tt >=}', If the number is preceded by `{\tt <=}' or `{\tt >=}' instead,
it also matches when value is below or above. it also matches when value is below or above.
If the prefix is `{\tt <}' or `{\tt >}', only match when strictly If the prefix is `{\tt <}' or `{\tt >}', only match when strictly
above or below. above or below.