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

catch Guidebook.tex up with Guidebook.mn

Browse Source 
Only with the past couple of changes, not a complete reconciliation.

Not tested.
This commit is contained in:
PatR
2019-10-31 05:31:39 -07:00
parent ded40818f1
commit eb825a2da5
2 changed files with 51 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/Guidebook.mn
View File

@@ -1,4 +1,4 @@
.\" $NHDT-Branch: NetHack-3.6 $:$NHDT-Revision: 1.318 $ $NHDT-Date: 1572482202 2019/10/31 00:36:42 $ .\" $NHDT-Branch: NetHack-3.6 $:$NHDT-Revision: 1.319 $ $NHDT-Date: 1572525093 2019/10/31 12:31:33 $
.\" .\"
.\" 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.
@@ -2683,7 +2683,9 @@ HACKDIR, must be writable.
.lp TROUBLEDIR .lp TROUBLEDIR
The location that a record of game aborts and self-diagnosed game problems The location that a record of game aborts and self-diagnosed game problems
is kept. Defaults to HACKDIR, must be writable. is kept. Defaults to HACKDIR, must be writable.
.\"
.\" config file entries beyond this point are shown alphabetically .\" config file entries beyond this point are shown alphabetically
.\"
.lp AUTOCOMPLETE .lp AUTOCOMPLETE
Enable or disable an extended command autocompletion. Enable or disable an extended command autocompletion.
Autocompletion has no effect for the X11 windowport. Autocompletion has no effect for the X11 windowport.

78
doc/Guidebook.tex
View File

@@ -2895,9 +2895,13 @@ Section names are case insensitive.
%.pg %.pg
You can use different configuration statements in the file, some You can use different configuration statements in the file, some
of which can be used multiple times. In general, the statements are of which can be used multiple times.
In general, the statements are
written in capital letters, followed by an equals sign, followed by written in capital letters, followed by an equals sign, followed by
settings particular to that statement. Here is a list of allowed statements: settings particular to that statement.
%.pg
Here is a list of allowed statements:
%.lp %.lp
\blist{} \blist{}
@@ -2912,7 +2916,7 @@ You can specify multiple OPTIONS statements, and multiple options
separated by commas in a single OPTIONS statement. separated by commas in a single OPTIONS statement.
(Comma separated options are processed from right to left.) (Comma separated options are processed from right to left.)
%.pg %.lp ""
Example: Example:
%.sd %.sd
\begin{verbatim} \begin{verbatim}
@@ -2946,6 +2950,9 @@ HACKDIR, must be writable.
\item[\bb{TROUBLEDIR}] \item[\bb{TROUBLEDIR}]
The location that a record of game aborts and self-diagnosed game problems The location that a record of game aborts and self-diagnosed game problems
is kept. Defaults to HACKDIR, must be writable. is kept. Defaults to HACKDIR, must be writable.
%
% config file entries beyond this point are shown alphabetically
%
%.lp %.lp
\item[\bb{AUTOCOMPLETE}] \item[\bb{AUTOCOMPLETE}]
Enable or disable an extended command autocompletion. Enable or disable an extended command autocompletion.
@@ -2955,11 +2962,11 @@ autocompletion, list the extended command. Prefix the
command with ``{{\tt !}}'' to disable the autocompletion command with ``{{\tt !}}'' to disable the autocompletion
for that command. for that command.
%.pg %.lp ""
Example: Example:
%.sd %.sd
\begin{verbatim} \begin{verbatim}
AUTOCOMPLETE=zap,!annotate AUTOCOMPLETE=zap,!annotate
\end{verbatim} \end{verbatim}
%.ed %.ed
@@ -2974,7 +2981,7 @@ extended commands. You can specify multiple bindings. Format is key
followed by the command, separated by a colon. followed by the command, separated by a colon.
See the ``Changing Key Bindings`` section for more information. See the ``Changing Key Bindings`` section for more information.
%.pg %.lp ""
Example: Example:
%.sd %.sd
\begin{verbatim} \begin{verbatim}
@@ -2987,7 +2994,7 @@ Example:
Chooses at random one of the comma-separated parameters as an active Chooses at random one of the comma-separated parameters as an active
section name. Lines in other sections are ignored. section name. Lines in other sections are ignored.
%.pg %.lp ""
Example: Example:
%.sd %.sd
\begin{verbatim} \begin{verbatim}
@@ -3000,23 +3007,37 @@ Example:
\end{verbatim} \end{verbatim}
%.ed %.ed
%.lp
\item[\bb{MSGTYPE}]
Change the way messages are shown in the top status line.
See the ``Configuring Message Types`` section.
%.lp %.lp
\item[\bb{MENUCOLOR}] \item[\bb{MENUCOLOR}]
Highlight menu lines with different colors. Highlight menu lines with different colors.
See the ``Configuring Menu Colors`` section. See the ``Configuring Menu Colors`` section.
%.lp %.lp
\item[\bb{SYMBOLS},\bb{ROGUESYMBOLS}] \item[\bb{MSGTYPE}]
Override one or more symbols in the symbols files. Change the way messages are shown in the top status line.
See the ``Configuring Message Types`` section.
%.lp
\item[\bb{ROGUESYMBOLS}]
Custom symbols for for the rogue level's symbol set.
See {\it SYMBOLS} below.
%.lp
\item[\bb{SOUND}]
Define a sound mapping.
See the ``Configuring User Sounds'' section.
%.lp
\item[\bb{SOUNDDIR}]
Define the directory that contains the sound files.
See the ``Configuring User Sounds'' section.
%.lp
\item[\bb{SYMBOLS}
Override one or more symbols in the symbol set used for all dungeon
levels except for the special rogue level.
See the ``Modifying {\it NetHack\/} Symbols'' section. See the ``Modifying {\it NetHack\/} Symbols'' section.
%.pg %.pg
Example: Example:
%.sd %.sd
\begin{verbatim} \begin{verbatim}
SYMBOLS=S_boulder:0 # replace small punctuation (tick marks) with digits
SYMBOLS=S_boulder:0,S_golem:7
\end{verbatim} \end{verbatim}
%.ed %.ed
@@ -3026,22 +3047,17 @@ Debug mode only: extra items to add to initial inventory.
Value is the name of a text file containing a list of item names, Value is the name of a text file containing a list of item names,
one per line, up to a maximum of 128 lines. one per line, up to a maximum of 128 lines.
Each line is processed by the function that handles wishing. Each line is processed by the function that handles wishing.
%.pg
%.lp ""
Example: Example:
%.sd %.sd
\begin{verbatim} \begin{verbatim}
WIZKIT=~/wizkit.txt WIZKIT=~/wizkit.txt
\end{verbatim} \end{verbatim}
%.ed %.ed
%.lp
\item[\bb{SOUNDDIR}]
Define the directory that contains the sound files.
See the ``Configuring User Sounds'' section.
%.lp
\item[\bb{SOUND}]
Define a sound mapping. See the ``Configuring User Sounds'' section.
\elist \elist
%.lp ""
%.pg %.pg
Here is a short example of config file contents: Here is a short example of config file contents:
%.sd %.sd
@@ -4880,11 +4896,13 @@ on the rogue level.
\elist \elist
You can also override one or more symbols using the {\it SYMBOLS\/} and You can also override one or more symbols using the {\it SYMBOLS\/} and
{\it ROGUESYMBOLS\/} config file options. Symbols are specified as {\it ROGUESYMBOLS\/} config file options.
{\it name:value\/} pairs. Note that {\it NetHack\/} escape-processes Symbols are specified as {\it name:value\/} pairs.
the {\it value\/} string in conventional C fashion. This means that `\verb+\+' Note that {\it NetHack\/} escape-processes
is a prefix to take the following character literally. Thus `\verb+\+' needs the {\it value\/} string in conventional C fashion.
to be represented as `\verb+\\+'. This means that `\verb+\+' is a prefix to take the following character
literally.
Thus `\verb+\+' needs to be represented as `\verb+\\+'.
The special prefix The special prefix
`\verb+\m+' switches on the meta bit in the symbol value, and the `\verb+\m+' switches on the meta bit in the symbol value, and the
`{\tt \^{}}' prefix causes the following character to be treated as a control `{\tt \^{}}' prefix causes the following character to be treated as a control
@@ -5071,8 +5089,8 @@ Default & Symbol Name & Description\\
\verb@Y@ & S\verb+_+yeti & (apelike creature)\\ \verb@Y@ & S\verb+_+yeti & (apelike creature)\\
\verb@Z@ & S\verb+_+zombie & (zombie)\\ \verb@Z@ & S\verb+_+zombie & (zombie)\\
\verb@z@ & S\verb+_+zruty & (zruty)\\ \verb@z@ & S\verb+_+zruty & (zruty)\\
\verb@ @ & S\verb+_+pet\verb+_+override & (pet override if sysconf accessibility is set)\\ \verb@ @ & S\verb+_+pet\verb+_+override & (any pet if sysconf accessibility is set)\\
\verb@ @ & S\verb+_+player\verb+_+override & (player override if sysconf accessibility is set) \verb@ @ & S\verb+_+player\verb+_+override & (hero if sysconf accessibility is set)
\end{longtable}% \end{longtable}%
} }