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

more doc updates and tweaks

Browse Source
This commit is contained in:
nhmall
2019-11-01 12:48:09 -04:00
parent e33dfed456
commit 2f260541d9
2 changed files with 81 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/Guidebook.mn
+16 -4
View File
@@ -24,7 +24,7 @@
.ds vr "NetHack 3.6 .ds vr "NetHack 3.6
.ds f0 "\*(vr .ds f0 "\*(vr
.ds f1 .ds f1
.ds f2 "October 31, 2019 .ds f2 "November 1, 2019
. .
.\" A note on some special characters: .\" A note on some special characters:
.\" \(lq = left double quote .\" \(lq = left double quote
@@ -2617,8 +2617,7 @@ Using a configuration file
.hw .nethackrc defaults.nh nethack.exe nethackW.exe .hw .nethackrc defaults.nh nethack.exe nethackW.exe
The default name of the configuration file varies on different The default name of the configuration file varies on different
operating systems. operating systems.
On MS-DOS and Windows, it is \(lqdefaults.nh\(rq .pg
in the same folder as nethack.exe or nethackW.exe.
On On
.UX , .UX ,
Linux, Linux,
@@ -2626,6 +2625,19 @@ and Mac OS X it is \(lq.nethackrc\(rq in the user's home directory.
The file may not exist, but it is a normal ASCII text file and The file may not exist, but it is a normal ASCII text file and
can be created with any text editor. can be created with any text editor.
.pg .pg
On Windows, if you manually installed from the zip file,
it is \(lqdefaults.nh\(rq
in the same folder as nethack.exe or nethackW.exe.
If you installed using the Microsoft Store, it is
\(lqdefaults.nh\(rq in the following folder:
\(lq\\%USERPROFILE%\\NetHack\(rq. There, a starting template is
provided for you to use to create your \(lqdefaults.nh\(rq
configuration file. It is \(lqdefaults.tmp\(rq also in the following
folder:
\(lq\\%USERPROFILE%\\NetHack\(rq
.pg
On MS-DOS, it is \(lqdefaults.nh\(rq in the same folder as nethack.exe.
.pg
Any line in the configuration file starting with \(oq#\(cq is treated Any line in the configuration file starting with \(oq#\(cq is treated
as a comment. as a comment.
Empty lines are ignored. Empty lines are ignored.
@@ -4289,7 +4301,7 @@ text to match against.
.lp "*" .lp "*"
\(lqalways\(rq will set the default attributes for that field. \(lqalways\(rq will set the default attributes for that field.
.lp "*" .lp "*"
\(lqup\(rq and \(lqdown\(rq set the field attributes for when the field \(lqup\(rq, \(lqdown\(rq set the field attributes for when the field
value changes upwards or downwards. value changes upwards or downwards.
This attribute times out after This attribute times out after
.op statushilites .op statushilites
doc/Guidebook.tex
+65 -60
View File
@@ -45,7 +45,7 @@
%.au %.au
\author{Original version - Eric S. Raymond\\ \author{Original version - Eric S. Raymond\\
(Edited and expanded for 3.6 by Mike Stephenson and others)} (Edited and expanded for 3.6 by Mike Stephenson and others)}
\date{October 31, 2019} \date{November 1, 2019}
\maketitle \maketitle
@@ -2867,27 +2867,32 @@ for system administrators.
%.pg %.pg
The default name and location of the configuration file varies on different The default name and location of the configuration file varies on different
operating systems. If you manually installed on MS-DOS and Windows, operating systems.\\
it is \mbox{``defaults.nh''} in
the same folder as \mbox{{\it nethack.exe\/}} or \mbox{{\it nethackW.exe\/}}. %.lp ""
If you installed using the Microsoft Store, it is \mbox{``defaults.nh''} in
the folder \mbox{{``\%USERPROFILE\%\textbackslash NetHack''}}.
On Unix, Linux and Mac OS X it is \mbox{``.nethackrc''} in the user's home On Unix, Linux and Mac OS X it is \mbox{``.nethackrc''} in the user's home
directory. The file may not exist, but it is a normal ASCII text file and directory. The file may not exist, but it is a normal ASCII text file and
can be created with any text editor. can be created with any text editor.\\
%.pg %.lp ""
If you installed using the Microsoft Store, you will find that we provide On Windows, if you manually installed from the zip file,
a starting template for you to use to create your \mbox{``defaults.nh''} it is \mbox{``defaults.nh''} in the same folder as
configuration file. It is \mbox{``defaults.tmp''} also in the folder \mbox{{\it nethack.exe\/}} or \mbox{{\it nethackW.exe\/}}.
If you installed using the Microsoft Store, it is \mbox{``defaults.nh''} in
the following folder:
\mbox{{``\%USERPROFILE\%\textbackslash NetHack''}}. \mbox{{``\%USERPROFILE\%\textbackslash NetHack''}}.
There, a starting template is provided for you to use to create your
\mbox{``defaults.nh''} configuration file. It is \mbox{``defaults.tmp''}
also in the following folder:
\mbox{{``\%USERPROFILE\%\textbackslash NetHack''}}.\\
%.pg %.lp ""
On MS-DOS it is \mbox{``defaults.nh''} in the same folder as
\mbox{{\it nethack.exe\/}}.\\
%.lp ""
Any line in the configuration file starting with `{\tt \#}' is treated as a comment. Any line in the configuration file starting with `{\tt \#}' is treated as a comment.
Empty lines are ignored. Empty lines are ignored. Any line beginning with `{\tt [}' and ending in `{\tt ]}' is considered a section
%.pg
Any line beginning with `{\tt [}' and ending in `{\tt ]}' is considered a section
marker. The text between the square brackets is the section name. marker. The text between the square brackets is the section name.
Lines after a section marker belong to that section, and are Lines after a section marker belong to that section, and are
ignored unless a CHOOSE -statement was used to select that section. ignored unless a CHOOSE -statement was used to select that section.
@@ -4105,7 +4110,7 @@ Number of lines for traditional below-the-map status display.
Acceptable values are 2 and 3 (default is 2). Acceptable values are 2 and 3 (default is 2).
Curses and tty interfaces only. Curses and tty interfaces only.
%.lp %.lp
\item[\ib{term\verb+_+cols}\ \ {\it and}]" \item[\ib{term\verb+_+cols} {\normalfont and}]
%.lp %.lp
\item[\ib{term\verb+_+rows}] \item[\ib{term\verb+_+rows}]
Curses interface only. Curses interface only.
@@ -4387,154 +4392,154 @@ can only be bound to a single key.
\elist \elist
%.pg %.pg
\blist{\itemindent 10mm \labelwidth 15mm \rightmargin 20mm} \blist{\itemindent 10mm \labelwidth 15mm \rightmargin 15mm}
%.lp %.lp
\item[{\bb{count}}] \item[{\bb{count}}]
Prefix key to start a count, to repeat a command this many times. Prefix key to start a count, to repeat a command this many times.
With {\it number\verb+_+pad\/} only. Default is `{\tt n}'. With {\it number\verb+_+pad\/} only. Default is~`{\tt n}'.
%.lp %.lp
\item[{\bb{doinv}}] \item[{\bb{doinv}}]
Show inventory. With {\it number\verb+_+pad\/} only. Default is `{\tt 0}'. Show inventory. With {\it number\verb+_+pad\/} only. Default is~`{\tt 0}'.
%.lp %.lp
\item[{\bb{fight}}] \item[{\bb{fight}}]
Prefix key to force fight a direction. Default is `{\tt F}'. Prefix key to force fight a direction. Default is~`{\tt F}'.
%.lp %.lp
\item[{\bb{fight.numpad}}] \item[{\bb{fight.numpad}}]
Prefix key to force fight a direction. With {\it number\verb+_+pad\/} only. Prefix key to force fight a direction. With {\it number\verb+_+pad\/} only.
Default is `{\tt -}'. Default is~`{\tt -}'.
%.lp %.lp
\item[{\bb{getdir.help}}] \item[{\bb{getdir.help}}]
When asked for a direction, the key to show the help. Default is `{\tt ?}'. When asked for a direction, the key to show the help. Default is~`{\tt ?}'.
%.lp %.lp
\item[{\bb{getdir.self}}] \item[{\bb{getdir.self}}]
When asked for a direction, the key to target yourself. Default is `{\tt .}'. When asked for a direction, the key to target yourself. Default is~`{\tt .}'.
%.lp %.lp
\item[{\bb{getdir.self2}}] \item[{\bb{getdir.self2}}]
When asked for a direction, the key to target yourself. Default is `{\tt s}'. When asked for a direction, the key to target yourself. Default is~`{\tt s}'.
%.lp %.lp
\item[{\bb{getpos.autodescribe}}] \item[{\bb{getpos.autodescribe}}]
When asked for a location, the key to toggle {\it autodescribe\/}. When asked for a location, the key to toggle {\it autodescribe\/}.
Default is `{\tt \#}'. Default is~`{\tt \#}'.
%.lp %.lp
\item[{\bb{getpos.all.next}}] \item[{\bb{getpos.all.next}}]
When asked for a location, the key to go to next closest interesting thing. When asked for a location, the key to go to next closest interesting thing.
Default is `{\tt a}'. Default is~`{\tt a}'.
%.lp %.lp
\item[{\bb{getpos.all.prev}}] \item[{\bb{getpos.all.prev}}]
When asked for a location, the key to go to previous closest interesting thing. When asked for a location, the key to go to previous closest interesting thing.
Default is `{\tt A}'. Default is~`{\tt A}'.
%.lp %.lp
\item[{\bb{getpos.door.next}}] \item[{\bb{getpos.door.next}}]
When asked for a location, the key to go to next closest door or doorway. When asked for a location, the key to go to next closest door or doorway.
Default is `{\tt d}'. Default is~`{\tt d}'.
%.lp %.lp
\item[{\bb{getpos.door.prev}}] \item[{\bb{getpos.door.prev}}]
When asked for a location, the key to go to previous closest door or doorway. When asked for a location, the key to go to previous closest door or doorway.
Default is `{\tt D}'. Default is~`{\tt D}'.
%.lp %.lp
\item[{\bb{getpos.help}}] \item[{\bb{getpos.help}}]
When asked for a location, the key to show help. Default is `{\tt ?}'. When asked for a location, the key to show help. Default is~`{\tt ?}'.
%.lp %.lp
\item[{\bb{getpos.mon.next}}] \item[{\bb{getpos.mon.next}}]
When asked for a location, the key to go to next closest monster. When asked for a location, the key to go to next closest monster.
Default is `{\tt m}'. Default is~`{\tt m}'.
%.lp %.lp
\item[{\bb{getpos.mon.prev}}] \item[{\bb{getpos.mon.prev}}]
When asked for a location, the key to go to previous closest monster. When asked for a location, the key to go to previous closest monster.
Default is `{\tt M}'. Default is~`{\tt M}'.
%.lp %.lp
\item[{\bb{getpos.obj.next}}] \item[{\bb{getpos.obj.next}}]
When asked for a location, the key to go to next closest object. When asked for a location, the key to go to next closest object.
Default is `{\tt o}'. Default is~`{\tt o}'.
%.lp %.lp
\item[{\bb{getpos.obj.prev}}] \item[{\bb{getpos.obj.prev}}]
When asked for a location, the key to go to previous closest object. When asked for a location, the key to go to previous closest object.
Default is `{\tt O}'. Default is~`{\tt O}'.
%.lp %.lp
\item[{\bb{getpos.menu}}] \item[{\bb{getpos.menu}}]
When asked for a location, and using one of the next or previous keys to When asked for a location, and using one of the next or previous keys to
cycle through targets, toggle showing a menu instead. Default is `{\tt !}'. cycle through targets, toggle showing a menu instead. Default is~`{\tt !}'.
%.lp %.lp
\item[{\bb{getpos.moveskip}}] \item[{\bb{getpos.moveskip}}]
When asked for a location, and using the shifted movement keys or When asked for a location, and using the shifted movement keys or
meta-digit keys to fast-move around, move by skipping the same glyphs meta-digit keys to fast-move around, move by skipping the same glyphs
instead of by 8 units. instead of by 8 units.
Default is `{\tt *}'. Default is~`{\tt *}'.
%.lp %.lp
\item[{\bb{getpos.filter}}] \item[{\bb{getpos.filter}}]
When asked for a location, change the filtering mode when using one of When asked for a location, change the filtering mode when using one of
the next or previous keys to cycle through targets. Toggles between no the next or previous keys to cycle through targets. Toggles between no
filtering, in view only, and in the same area only. Default is `{\tt "}'. filtering, in view only, and in the same area only. Default is~`{\tt "}'.
%.lp %.lp
\item[{\bb{getpos.pick}}] \item[{\bb{getpos.pick}}]
When asked for a location, the key to choose the location, and possibly When asked for a location, the key to choose the location, and possibly
ask for more info. Default is `{\tt .}'. ask for more info. Default is~`{\tt .}'.
%.lp %.lp
\item[{\bb{getpos.pick.once}}] \item[{\bb{getpos.pick.once}}]
When asked for a location, the key to choose the location, and skip When asked for a location, the key to choose the location, and skip
asking for more info. Default is `{\tt ,}'. asking for more info. Default is~`{\tt ,}'.
%.lp %.lp
\item[{\bb{getpos.pick.quick}}] \item[{\bb{getpos.pick.quick}}]
When asked for a location, the key to choose the location, skip asking When asked for a location, the key to choose the location, skip asking
for more info, and exit the location asking loop. Default is `{\tt ;}'. for more info, and exit the location asking loop. Default is~`{\tt ;}'.
%.lp %.lp
\item[{\bb{getpos.pick.verbose}}] \item[{\bb{getpos.pick.verbose}}]
When asked for a location, the key to choose the location, and show more When asked for a location, the key to choose the location, and show more
info without asking. Default is `{\tt :}'. info without asking. Default is~`{\tt :}'.
%.lp %.lp
\item[{\bb{getpos.self}}] \item[{\bb{getpos.self}}]
When asked for a location, the key to go to your location. When asked for a location, the key to go to your location.
Default is `{\tt @}'. Default is~`{\tt @}'.
%.lp %.lp
\item[{\bb{getpos.unexplored.next}}] \item[{\bb{getpos.unexplored.next}}]
When asked for a location, the key to go to next closest unexplored location. When asked for a location, the key to go to next closest unexplored location.
Default is `{\tt x}'. Default is~`{\tt x}'.
%.lp %.lp
\item[{\bb{getpos.unexplored.prev}}] \item[{\bb{getpos.unexplored.prev}}]
When asked for a location, the key to go to previous closest unexplored When asked for a location, the key to go to previous closest unexplored
location. Default is `{\tt X}'. location. Default is~`{\tt X}'.
%.lp %.lp
\item[{\bb{getpos.valid}}] \item[{\bb{getpos.valid}}]
When asked for a location, the key to go to show valid target locations. When asked for a location, the key to go to show valid target locations.
Default is `{\tt \$}'. Default is~`{\tt \$}'.
%.lp %.lp
\item[{\bb{getpos.valid.next}}] \item[{\bb{getpos.valid.next}}]
When asked for a location, the key to go to next closest valid location. When asked for a location, the key to go to next closest valid location.
Default is `{\tt z}'. Default is~`{\tt z}'.
%.lp %.lp
\item[{\bb{getpos.valid.prev}}] \item[{\bb{getpos.valid.prev}}]
When asked for a location, the key to go to previous closest valid location. When asked for a location, the key to go to previous closest valid location.
Default is `{\tt Z}'. Default is~`{\tt Z}'.
%.lp %.lp
\item[{\bb{nopickup}}] \item[{\bb{nopickup}}]
Prefix key to move without picking up items. Default is `{\tt m}'. Prefix key to move without picking up items. Default is~`{\tt m}'.
%.lp %.lp
\item[{\bb{redraw}}] \item[{\bb{redraw}}]
Key to redraw the screen. Default is `{\tt \^{}R}'. Key to redraw the screen. Default is~`{\tt \^{}R}'.
%.lp %.lp
\item[{\bb{redraw.numpad}}] \item[{\bb{redraw.numpad}}]
Key to redraw the screen. With {\it number\verb+_+pad\/} only. Key to redraw the screen. With {\it number\verb+_+pad\/} only.
Default is `{\tt \^{}L}'. Default is~`{\tt \^{}L}'.
%.lp %.lp
\item[{\bb{repeat}}] \item[{\bb{repeat}}]
Key to repeat previous command. Default is `{\tt \^{}A}'. Key to repeat previous command. Default is~`{\tt \^{}A}'.
%.lp %.lp
\item[{\bb{reqmenu}}] \item[{\bb{reqmenu}}]
Prefix key to request menu from some commands. Default is `{\tt m}'. Prefix key to request menu from some commands. Default is~`{\tt m}'.
%.lp %.lp
\item[{\bb{run}}] \item[{\bb{run}}]
Prefix key to run towards a direction. Default is `{\tt G}'. Prefix key to run towards a direction. Default is~`{\tt G}'.
%.lp %.lp
\item[{\bb{run.nopickup}}] \item[{\bb{run.nopickup}}]
Prefix key to run towards a direction without picking up items on the way. Prefix key to run towards a direction without picking up items on the way.
Default is `{\tt M}'. Default is~`{\tt M}'.
%.lp %.lp
\item[{\bb{run.numpad}}] \item[{\bb{run.numpad}}]
Prefix key to run towards a direction. With {\it number\verb+_+pad\/} only. Prefix key to run towards a direction. With {\it number\verb+_+pad\/} only.
Default is `{\tt 5}'. Default is~`{\tt 5}'.
%.lp %.lp
\item[{\bb{rush}}] \item[{\bb{rush}}]
Prefix key to rush towards a direction. Default is `{\tt g}'. Prefix key to rush towards a direction. Default is~`{\tt g}'.
\elist \elist
@@ -4795,9 +4800,9 @@ percentage or absolute number threshold, or text to match against.
%.lp "*" %.lp "*"
\item[{\tt always}] will set the default attributes for that field. \item[{\tt always}] will set the default attributes for that field.
%.lp "*" %.lp "*"
\item[{\tt up} and ``{\tt down}''] set the field attributes for when the field \item[{\tt up}{\normalfont, }{\tt down}] set the field attributes
value changes upwards or downwards. This attribute times out after for when the field value changes upwards or downwards. This attribute
{\tt statushilites} turns. times out after {\tt statushilites} turns.
%.lp "*" %.lp "*"
\item[{\tt changed}] sets the field attribute for when the field value \item[{\tt changed}] sets the field attribute for when the field value
changes. This attribute times out after {\tt statushilites} turns. changes. This attribute times out after {\tt statushilites} turns.