From: PatR <rankin@nethack.org>
Date: Fri, 4 Mar 2022 14:51:40 +0000 (-0800)
Subject: Guidebook tweaks (mainly DUMPLOG)
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=80e7fbe8ec6d48162457c23687b347f48464f213;p=nethack

Guidebook tweaks (mainly DUMPLOG)

In the sysconf section, "the following options affect the score file:"
had some score options and then several non-score options.  Change to
"following four options" which reads a little strange but is precise.
Some other inserted line after those four options describing what
follows would read better but the stuff that follows is essentially
random based on the order that support for them was implemented.

Guidebook.mn:  the 'placeholders' for DUMPLOG file name substitution
had the description column line up but the proportional font for the
'%x' column looked bad.  Force fixed-width font there.  Also add some
indentation.  I wasn't sure whether '.in' should in inside .PS ... .PE
or outside.  The final result looks the same either way.

Guidebook.tex:  the new LIVELOG entry was accidentally placed after
the \elist line when it should come before that.  (Not tested.)
---

diff --git a/doc/Guidebook.mn b/doc/Guidebook.mn
index 3cd1e470b..cd20a0d29 100644
--- a/doc/Guidebook.mn
+++ b/doc/Guidebook.mn
@@ -5580,7 +5580,7 @@ CHECK_SAVE_UID\ =\ 0 or 1 to disable or enable, respectively, the UID
 (used identification number) checking for save files (to verify that the
 user who is restoring is the same one who saved).
 .pg
-The following options affect the score file:
+The following four options affect the score file:
 .pg
 .lp
 PERSMAX\ =\ Maximum number of entries for one person.
@@ -5595,38 +5595,42 @@ to identify unique people for the score file.
 MAX_STATUENAME_RANK\ =\ Maximum number of score file entries to use for
 random statue names (default is 10).
 .lp
-ACCESSIBILITY\ =\ 0 or 1 to disable or enable, respectively, the ability for players 
-to set S_pet_override and S_hero_override symbols in their configuration file.
+ACCESSIBILITY\ =\ 0 or 1 to disable or enable, respectively, the ability
+for players to set S_pet_override and S_hero_override symbols in their
+configuration file.
 .lp
 PORTABLE_DEVICE_PATHS\ =\ 0 or 1 Windows OS only, the game will look
-for all of its external files, and write to all of its output files in one place
-rather than at the standard locations.
+for all of its external files, and write to all of its output files in
+one place rather than at the standard locations.
 .lp
 DUMPLOGFILE\ =\ A filename where the end-of-game dumplog is saved.
-Not defining this will prevent dumplog from being created. Only available
-if your game is compiled with DUMPLOG. Allows the following placeholders:
+Not defining this will prevent dumplog from being created.
+Only available if your game is compiled with DUMPLOG.
+Allows the following placeholders:
+.in +4n
 .\" note: %M is not an entry in the table, but 'M' is the widest letter
 .PS %M
 .\" \f(CR = set font to constant-width Roman; approximation of {\tt ...} in TeX
-.PL %%
+.PL \f(CR%%\fP
 literal \(oq\f(CR%\fP\(cq
-.PL %v
+.PL \f(CR%v\fP
 version (eg. \(lq\f(CR3.7.0\-0\fP\(rq)
-.PL %u
+.PL \f(CR%u\fP
 game UID
-.PL %t
+.PL \f(CR%t\fP
 game start time, UNIX timestamp format
-.PL %T
+.PL \f(CR%T\fP
 current time, UNIX timestamp format
-.PL %d
+.PL \f(CR%d\fP
 game start time, YYYYMMDDhhmmss format
-.PL %D
+.PL \f(CR%D\fP
 current time, YYYYMMDDhhmmss format
-.PL %n
+.PL \f(CR%n\fP
 player name
-.PL %N
+.PL \f(CR%N\fP
 first character of player name
 .PE
+.in -4n
 .lp
 LIVELOG\ =\ A bit-mask of types of events that should be written to
 the \fIlivelog\fP file if one is present.
diff --git a/doc/Guidebook.tex b/doc/Guidebook.tex
index bf32c5d66..589674bbc 100644
--- a/doc/Guidebook.tex
+++ b/doc/Guidebook.tex
@@ -6146,7 +6146,7 @@ user who is restoring is the same one who saved).
 \elist
 
 %.pg
-The following options affect the score file:
+The following four options affect the score file:
 \blist {}
 %.pg
 %.lp
@@ -6179,10 +6179,10 @@ rather than at the standard locations.
 %.lp
 \item[\ib{DUMPLOGFILE}]
 A filename where the end-of-game dumplog is saved.
-Not defining this will prevent dumplog from being created. Only available
-if your game is compiled with DUMPLOG. Allows the following placeholders:
-%.sd
-%.si
+Not defining this will prevent dumplog from being created.
+Only available if your game is compiled with DUMPLOG.
+Allows the following placeholders:
+% FIXME: this should be changed to a nested list or else be forcibly indented
 {\tt \%\%}  --- literal `{\tt \%}'\\
 {\tt \%v}  --- version (eg. ``{\tt 3.7.0-0}'')\\
 {\tt \%u}  --- game UID\\
@@ -6192,9 +6192,6 @@ if your game is compiled with DUMPLOG. Allows the following placeholders:
 {\tt \%D}  --- current time, YYYYMMDDhhmmss format\\
 {\tt \%n}  --- player name\\
 {\tt \%N}  --- first character of player name
-%.ei
-%.ed
-\elist
 %.lp
 \item[\ib{LIVELOG}]
 A bit-mask of types of events that should be written to
@@ -6208,6 +6205,7 @@ Only relevant if the program was built with LIVELOG enabled.
 When available, it should be left commented out on single player
 installations because over time the file could grow to be extremely
 large unless it is actively maintained.
+\elist
 
 %.hn 1
 \section{Scoring}