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.)
This commit is contained in:
PatR
2022-03-04 06:51:40 -08:00
parent 2cdd8f8dcb
commit 80e7fbe8ec
2 changed files with 26 additions and 24 deletions
+20 -16
View File
@@ -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 (used identification number) checking for save files (to verify that the
user who is restoring is the same one who saved). user who is restoring is the same one who saved).
.pg .pg
The following options affect the score file: The following four options affect the score file:
.pg .pg
.lp .lp
PERSMAX\ =\ Maximum number of entries for one person. 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 MAX_STATUENAME_RANK\ =\ Maximum number of score file entries to use for
random statue names (default is 10). random statue names (default is 10).
.lp .lp
ACCESSIBILITY\ =\ 0 or 1 to disable or enable, respectively, the ability for players ACCESSIBILITY\ =\ 0 or 1 to disable or enable, respectively, the ability
to set S_pet_override and S_hero_override symbols in their configuration file. for players to set S_pet_override and S_hero_override symbols in their
configuration file.
.lp .lp
PORTABLE_DEVICE_PATHS\ =\ 0 or 1 Windows OS only, the game will look 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 for all of its external files, and write to all of its output files in
rather than at the standard locations. one place rather than at the standard locations.
.lp .lp
DUMPLOGFILE\ =\ A filename where the end-of-game dumplog is saved. DUMPLOGFILE\ =\ A filename where the end-of-game dumplog is saved.
Not defining this will prevent dumplog from being created. Only available Not defining this will prevent dumplog from being created.
if your game is compiled with DUMPLOG. Allows the following placeholders: 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 .\" note: %M is not an entry in the table, but 'M' is the widest letter
.PS %M .PS %M
.\" \f(CR = set font to constant-width Roman; approximation of {\tt ...} in TeX .\" \f(CR = set font to constant-width Roman; approximation of {\tt ...} in TeX
.PL %% .PL \f(CR%%\fP
literal \(oq\f(CR%\fP\(cq literal \(oq\f(CR%\fP\(cq
.PL %v .PL \f(CR%v\fP
version (eg. \(lq\f(CR3.7.0\-0\fP\(rq) version (eg. \(lq\f(CR3.7.0\-0\fP\(rq)
.PL %u .PL \f(CR%u\fP
game UID game UID
.PL %t .PL \f(CR%t\fP
game start time, UNIX timestamp format game start time, UNIX timestamp format
.PL %T .PL \f(CR%T\fP
current time, UNIX timestamp format current time, UNIX timestamp format
.PL %d .PL \f(CR%d\fP
game start time, YYYYMMDDhhmmss format game start time, YYYYMMDDhhmmss format
.PL %D .PL \f(CR%D\fP
current time, YYYYMMDDhhmmss format current time, YYYYMMDDhhmmss format
.PL %n .PL \f(CR%n\fP
player name player name
.PL %N .PL \f(CR%N\fP
first character of player name first character of player name
.PE .PE
.in -4n
.lp .lp
LIVELOG\ =\ A bit-mask of types of events that should be written to LIVELOG\ =\ A bit-mask of types of events that should be written to
the \fIlivelog\fP file if one is present. the \fIlivelog\fP file if one is present.
+6 -8
View File
@@ -6146,7 +6146,7 @@ user who is restoring is the same one who saved).
\elist \elist
%.pg %.pg
The following options affect the score file: The following four options affect the score file:
\blist {} \blist {}
%.pg %.pg
%.lp %.lp
@@ -6179,10 +6179,10 @@ rather than at the standard locations.
%.lp %.lp
\item[\ib{DUMPLOGFILE}] \item[\ib{DUMPLOGFILE}]
A filename where the end-of-game dumplog is saved. A filename where the end-of-game dumplog is saved.
Not defining this will prevent dumplog from being created. Only available Not defining this will prevent dumplog from being created.
if your game is compiled with DUMPLOG. Allows the following placeholders: Only available if your game is compiled with DUMPLOG.
%.sd Allows the following placeholders:
%.si % FIXME: this should be changed to a nested list or else be forcibly indented
{\tt \%\%} --- literal `{\tt \%}'\\ {\tt \%\%} --- literal `{\tt \%}'\\
{\tt \%v} --- version (eg. ``{\tt 3.7.0-0}'')\\ {\tt \%v} --- version (eg. ``{\tt 3.7.0-0}'')\\
{\tt \%u} --- game UID\\ {\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 \%D} --- current time, YYYYMMDDhhmmss format\\
{\tt \%n} --- player name\\ {\tt \%n} --- player name\\
{\tt \%N} --- first character of player name {\tt \%N} --- first character of player name
%.ei
%.ed
\elist
%.lp %.lp
\item[\ib{LIVELOG}] \item[\ib{LIVELOG}]
A bit-mask of types of events that should be written to 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 When available, it should be left commented out on single player
installations because over time the file could grow to be extremely installations because over time the file could grow to be extremely
large unless it is actively maintained. large unless it is actively maintained.
\elist
%.hn 1 %.hn 1
\section{Scoring} \section{Scoring}