diff --git a/doc/Guidebook.mn b/doc/Guidebook.mn index 8e18ec97d..0f9068ede 100644 --- a/doc/Guidebook.mn +++ b/doc/Guidebook.mn @@ -24,7 +24,7 @@ .ds vr "NetHack 3.6 .ds f0 "\*(vr .ds f1 -.ds f2 "October 31, 2019 +.ds f2 "November 1, 2019 . .\" A note on some special characters: .\" \(lq = left double quote @@ -2617,8 +2617,7 @@ Using a configuration file .hw .nethackrc defaults.nh nethack.exe nethackW.exe The default name of the configuration file varies on different operating systems. -On MS-DOS and Windows, it is \(lqdefaults.nh\(rq -in the same folder as nethack.exe or nethackW.exe. +.pg On .UX , 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 can be created with any text editor. .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 as a comment. Empty lines are ignored. @@ -4289,7 +4301,7 @@ text to match against. .lp "*" \(lqalways\(rq will set the default attributes for that field. .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. This attribute times out after .op statushilites diff --git a/doc/Guidebook.tex b/doc/Guidebook.tex index 87cf04452..77ce5e2e6 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.6 by Mike Stephenson and others)} -\date{October 31, 2019} +\date{November 1, 2019} \maketitle @@ -2867,27 +2867,32 @@ for system administrators. %.pg The default name and location of the configuration file varies on different -operating systems. If you manually installed on MS-DOS and Windows, -it is \mbox{``defaults.nh''} in -the same folder as \mbox{{\it nethack.exe\/}} or \mbox{{\it nethackW.exe\/}}. -If you installed using the Microsoft Store, it is \mbox{``defaults.nh''} in -the folder \mbox{{``\%USERPROFILE\%\textbackslash NetHack''}}. +operating systems.\\ + +%.lp "" 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 -can be created with any text editor. +can be created with any text editor.\\ -%.pg -If you installed using the Microsoft Store, you will find that we provide -a starting template for you to use to create your \mbox{``defaults.nh''} -configuration file. It is \mbox{``defaults.tmp''} also in the folder +%.lp "" +On Windows, if you manually installed from the zip file, +it is \mbox{``defaults.nh''} in the same folder as +\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''}}. +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. -Empty lines are ignored. - -%.pg -Any line beginning with `{\tt [}' and ending in `{\tt ]}' is considered a section +Empty lines are ignored. Any line beginning with `{\tt [}' and ending in `{\tt ]}' is considered a section marker. The text between the square brackets is the section name. Lines after a section marker belong to that section, and are 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). Curses and tty interfaces only. %.lp -\item[\ib{term\verb+_+cols}\ \ {\it and}]" +\item[\ib{term\verb+_+cols} {\normalfont and}] %.lp \item[\ib{term\verb+_+rows}] Curses interface only. @@ -4387,154 +4392,154 @@ can only be bound to a single key. \elist %.pg -\blist{\itemindent 10mm \labelwidth 15mm \rightmargin 20mm} +\blist{\itemindent 10mm \labelwidth 15mm \rightmargin 15mm} %.lp \item[{\bb{count}}] 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 \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 \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 \item[{\bb{fight.numpad}}] Prefix key to force fight a direction. With {\it number\verb+_+pad\/} only. -Default is `{\tt -}'. +Default is~`{\tt -}'. %.lp \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 \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 \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 \item[{\bb{getpos.autodescribe}}] When asked for a location, the key to toggle {\it autodescribe\/}. -Default is `{\tt \#}'. +Default is~`{\tt \#}'. %.lp \item[{\bb{getpos.all.next}}] When asked for a location, the key to go to next closest interesting thing. -Default is `{\tt a}'. +Default is~`{\tt a}'. %.lp \item[{\bb{getpos.all.prev}}] When asked for a location, the key to go to previous closest interesting thing. -Default is `{\tt A}'. +Default is~`{\tt A}'. %.lp \item[{\bb{getpos.door.next}}] When asked for a location, the key to go to next closest door or doorway. -Default is `{\tt d}'. +Default is~`{\tt d}'. %.lp \item[{\bb{getpos.door.prev}}] When asked for a location, the key to go to previous closest door or doorway. -Default is `{\tt D}'. +Default is~`{\tt D}'. %.lp \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 \item[{\bb{getpos.mon.next}}] When asked for a location, the key to go to next closest monster. -Default is `{\tt m}'. +Default is~`{\tt m}'. %.lp \item[{\bb{getpos.mon.prev}}] When asked for a location, the key to go to previous closest monster. -Default is `{\tt M}'. +Default is~`{\tt M}'. %.lp \item[{\bb{getpos.obj.next}}] When asked for a location, the key to go to next closest object. -Default is `{\tt o}'. +Default is~`{\tt o}'. %.lp \item[{\bb{getpos.obj.prev}}] When asked for a location, the key to go to previous closest object. -Default is `{\tt O}'. +Default is~`{\tt O}'. %.lp \item[{\bb{getpos.menu}}] 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 \item[{\bb{getpos.moveskip}}] 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 instead of by 8 units. -Default is `{\tt *}'. +Default is~`{\tt *}'. %.lp \item[{\bb{getpos.filter}}] 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 -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 \item[{\bb{getpos.pick}}] 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 \item[{\bb{getpos.pick.once}}] 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 \item[{\bb{getpos.pick.quick}}] 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 \item[{\bb{getpos.pick.verbose}}] 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 \item[{\bb{getpos.self}}] When asked for a location, the key to go to your location. -Default is `{\tt @}'. +Default is~`{\tt @}'. %.lp \item[{\bb{getpos.unexplored.next}}] When asked for a location, the key to go to next closest unexplored location. -Default is `{\tt x}'. +Default is~`{\tt x}'. %.lp \item[{\bb{getpos.unexplored.prev}}] When asked for a location, the key to go to previous closest unexplored -location. Default is `{\tt X}'. +location. Default is~`{\tt X}'. %.lp \item[{\bb{getpos.valid}}] When asked for a location, the key to go to show valid target locations. -Default is `{\tt \$}'. +Default is~`{\tt \$}'. %.lp \item[{\bb{getpos.valid.next}}] When asked for a location, the key to go to next closest valid location. -Default is `{\tt z}'. +Default is~`{\tt z}'. %.lp \item[{\bb{getpos.valid.prev}}] When asked for a location, the key to go to previous closest valid location. -Default is `{\tt Z}'. +Default is~`{\tt Z}'. %.lp \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 \item[{\bb{redraw}}] -Key to redraw the screen. Default is `{\tt \^{}R}'. +Key to redraw the screen. Default is~`{\tt \^{}R}'. %.lp \item[{\bb{redraw.numpad}}] Key to redraw the screen. With {\it number\verb+_+pad\/} only. -Default is `{\tt \^{}L}'. +Default is~`{\tt \^{}L}'. %.lp \item[{\bb{repeat}}] -Key to repeat previous command. Default is `{\tt \^{}A}'. +Key to repeat previous command. Default is~`{\tt \^{}A}'. %.lp \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 \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 \item[{\bb{run.nopickup}}] Prefix key to run towards a direction without picking up items on the way. -Default is `{\tt M}'. +Default is~`{\tt M}'. %.lp \item[{\bb{run.numpad}}] Prefix key to run towards a direction. With {\it number\verb+_+pad\/} only. -Default is `{\tt 5}'. +Default is~`{\tt 5}'. %.lp \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 @@ -4795,9 +4800,9 @@ percentage or absolute number threshold, or text to match against. %.lp "*" \item[{\tt always}] will set the default attributes for that field. %.lp "*" -\item[{\tt up} and ``{\tt down}''] set the field attributes for when the field -value changes upwards or downwards. This attribute times out after -{\tt statushilites} turns. +\item[{\tt up}{\normalfont, }{\tt down}] set the field attributes +for when the field value changes upwards or downwards. This attribute +times out after {\tt statushilites} turns. %.lp "*" \item[{\tt changed}] sets the field attribute for when the field value changes. This attribute times out after {\tt statushilites} turns.