From: PatR <rankin@nethack.org>
Date: Fri, 4 Mar 2022 14:02:32 +0000 (-0800)
Subject: mention sysconf entry LIVELOG in Guidebook
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=013bb8a112c3f8ce7fb1b7c0075b83f615dfdb2d;p=nethack

mention sysconf entry LIVELOG in Guidebook

It's description is minimal since it isn't relevant to most people,
even ones playing on servers who have live-logging enabled.
---

diff --git a/doc/Guidebook.mn b/doc/Guidebook.mn
index 7625bb6f4..3cd1e470b 100644
--- a/doc/Guidebook.mn
+++ b/doc/Guidebook.mn
@@ -1,4 +1,4 @@
-.\" $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.450 $ $NHDT-Date: 1646146100 2022/03/01 14:48:20 $
+.\" $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.451 $ $NHDT-Date: 1646402548 2022/03/04 14:02:28 $
 .\"
 .\" This is an excerpt from the 'roff' man page from the 'groff' package.
 .\" Guidebook.mn currently does *not* fully adhere to these guidelines.
@@ -5627,6 +5627,18 @@ player name
 .PL %N
 first character of player name
 .PE
+.lp
+LIVELOG\ =\ A bit-mask of types of events that should be written to
+the \fIlivelog\fP file if one is present.
+The sample \fIsysconf\fP file accompanying the program contains a
+comment which lists the meaning of the various bits used.
+Intended for server systems supporting simultaneous play by multiple
+players (to be clear, each one running a separate single player game),
+for displaying their game progress to observers.
+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.
 .
 .hn 1
 Scoring
diff --git a/doc/Guidebook.tex b/doc/Guidebook.tex
index b85c8f852..bf32c5d66 100644
--- a/doc/Guidebook.tex
+++ b/doc/Guidebook.tex
@@ -6195,6 +6195,19 @@ if your game is compiled with DUMPLOG. Allows the following placeholders:
 %.ei
 %.ed
 \elist
+%.lp
+\item[\ib{LIVELOG}]
+A bit-mask of types of events that should be written to
+the {\it livelog\/} file if one is present.
+The sample {\it sysconf\/} file accompanying the program contains a
+comment which lists the meaning of the various bits used.
+Intended for server systems supporting simultaneous play by multiple
+players (to be clear, each one running a separate single player game),
+for displaying their game progress to observers.
+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.
 
 %.hn 1
 \section{Scoring}