another Guidebook update - mostly NETHACKOPTIONS

Move some 'roff macros from Guidebook.mn to new file tmac.nh.

Header for tmac.nh is not being updated, even after explicitly adding
it to .gitattributes.  I'm not sure what I've done wrong.  (I'm using
'git nhadd doc/' here rather than explicit 'git nhadd doc/tmac.nh'.)

In Guidebook.mn, change the ``setenv NETHACKOPTIONS'' example so that
it fits within one line in Guidebook.txt.  (I looked at 3.4.3's
edition of that file and the example went not just beyond the margin
of the formatted text but beyond 80 columns, so wrapped in an ugly
fashion.)  I had previously changed 'autoquiver' to 'color' to shorten
it, now have changed '!autopickup' to '!leg' to show an example of
truncated option name as well as shorten, and also 'fruit:papaya' to
'fruit:lime' to squeeze out the last two columns needed to fit within
the text margin while retaining 'name:Blue Meanie' as requested.
Guidebook.txt shows both NETHACKOPTIONS examples with indentation
suppressed, Guidebook.ps uses normal indentation (evidently using a
narrower font, even with \f(CR (constant-width Roman) to approximate
TeX's \tt, since the indented example fits fine and looks better).

Some Guidebook.tex catchup.  I suspect that lots of bits and bobs
don't match between Guidebook.mn and Guidebook.tex these days.
Particularly quoting and variant font (italics, bold, \tt) usage.
Also the recently added box around the sample screenshot.  This
modifies the screenshot to match Guidebook.mn's, reflecting change
in status field spacing by STATUS_HILITES.
This commit is contained in:
PatR
2018-10-27 00:42:11 -07:00
parent 3f3bec8687
commit bb62ab6fc1
6 changed files with 198 additions and 107 deletions

View File

@@ -283,6 +283,7 @@ understand what {\it NetHack\/} is doing with the screen. The {\it NetHack\/}
screen replaces the ``You see \ldots'' descriptions of text adventure games.
Figure 1 is a sample of what a {\it NetHack\/} screen might look like.
The way the screen looks for you depends on your platform.
%.BR 2
\vbox{
\begin{verbatim}
@@ -297,8 +298,8 @@ The way the screen looks for you depends on your platform.
Player the Rambler St:12 Dx:7 Co:18 In:11 Wi:9 Ch:15 Neutral
Dlvl:1 $:0 HP:9(12) Pw:3(3) AC:10 Exp:1/19 T:257 Weak
Player the Rambler St:12 Dx:7 Co:18 In:11 Wi:9 Ch:15 Neutral
Dlvl:1 $:0 HP:9(12) Pw:3(3) AC:10 Exp:1/19 T:257 Weak
\end{verbatim}
\begin{center}
Figure 1
@@ -1620,7 +1621,7 @@ bit), you can invoke many extended commands by meta-ing the first
letter of the command.
In {\it NT, OS/2, PC\/ {\rm and} ST NetHack},
the `Alt' key can be used in this fashion;
on the {\it Amiga\/}, set the {\it altmeta\/} option to get this behavior.
on the {\it Amiga}, set the {\it altmeta\/} option to get this behavior.
On other systems, if typing `Alt' plus another key transmits a
two character sequence consisting of an {\tt Escape}
followed by the other key, you may set the {\it altmeta\/}
@@ -2040,7 +2041,7 @@ location ordinarily wouldn't be seen any more.
%.pg
When you find something in the dungeon, it is common to want to pick
it up. In {\it NetHack\/}, this is accomplished automatically by walking over
it up. In {\it NetHack}, this is accomplished automatically by walking over
the object (unless you turn off the {\it autopickup\/}
option (see below), or move with the `{\tt m}' prefix (see above)), or
manually by using the `{\tt ,}' command.
@@ -2791,7 +2792,7 @@ fire, and kick weapons; use a wand, spell, or other type of item;
or fight with your hands and feet.
%.pg
In {\it NetHack\/}, a pacifist refuses to cause the death of any other monster
In {\it NetHack}, a pacifist refuses to cause the death of any other monster
(i.e. if you would get experience for the death). This is a particularly
difficult challenge, although it is still possible to gain experience
by other means.
@@ -3032,6 +3033,7 @@ Here is a short example of config file contents:
OPTIONS=!splash_screen
\end{verbatim}
%.ed
%.BR 2
%.hn 2
\subsection*{Using the NETHACKOPTIONS environment variable}
@@ -3047,25 +3049,29 @@ the option name, a colon or equals sign, and then the value of the string.
The value is terminated by the next comma or the end of string.
%.pg
For example, to set up an environment variable so that {\it color\/}
is on, {\it autopickup\/} is off, the {\it name\/} is set to ``Blue Meanie'',
and the {\it fruit\/} is set to ``papaya'', you would enter the command
%.sd
For example, to set up an environment variable so that
{\it color\/} is {\tt on},
{\it legacy\/} is {\tt off},
character {\it name\/} is set to ``{\tt Blue Meanie}'',
and named {\it fruit\/} is set to ``{\tt lime}'',
you would enter the command
%.SD i
\begin{verbatim}
setenv NETHACKOPTIONS "color,\!autopickup,name:Blue Meanie,fruit:papaya"
setenv NETHACKOPTIONS "color,\!leg,name:Blue Meanie,fruit:lime"
\end{verbatim}
%.ed
%.ED
\nd in {\it csh}
(note the need to escape the `!' since it's special to the shell), or
%.sd
(note the need to escape the `!' since it's special
to that shell), or the pair of commands
%.SD i
\begin{verbatim}
NETHACKOPTIONS="color,!autopickup,name:Blue Meanie,fruit:papaya"
NETHACKOPTIONS="color,!leg,name:Blue Meanie,fruit:lime"
export NETHACKOPTIONS
\end{verbatim}
%.ed
%.ED
\nd in {\it sh\/}, {\it ksh}, or {\it bash}.
\nd in {\it sh}, {\it ksh}, or {\it bash}.
%.pg
Instead of a comma-separated list of options,