From: Pasi Kallinen <paxed@alt.org>
Date: Mon, 28 Dec 2015 17:56:20 +0000 (+0200)
Subject: Add config file examples to Guidebook
X-Git-Tag: NetHack-3.6.1_RC01~1101
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=ff30a56e3eb96089dd2d56e1cc4dc7264c1add84;p=nethack

Add config file examples to Guidebook
---

diff --git a/doc/Guidebook.mn b/doc/Guidebook.mn
index e20efeb9c..0656e2f63 100644
--- a/doc/Guidebook.mn
+++ b/doc/Guidebook.mn
@@ -1947,8 +1947,27 @@ option.
 There is a section of this Guidebook that discusses that.
 .pg
 The default name of the configuration file varies on different
-operating systems, but NETHACKOPTIONS can also be set to
-the full name of a file you want to use (possibly preceded by an `@').
+operating systems. On DOS and Windows, it is ``defaults.nh''
+in the same folder as nethack.exe or nethackW.exe. On Unix, linux
+and Mac OS X it is ``.nethackrc'' in the user's home directory.
+NETHACKOPTIONS can also be set to the full name of a file you
+want to use (possibly preceded by an `@').
+.pg
+Here is a short example of config file contents:
+.sd
+\fB# Set your character's role, race, gender, and alignment.\fP
+\fBOPTIONS=role:Valkyrie, race:Human, gender:female, align:lawful\fP
+
+\fB# Turn on autopickup, and set automatically picked up object types\fP
+\fBOPTIONS=autopickup,pickup_types:$"=/!?+\fP
+\fB# Show colored text if possible\fP
+\fBOPTIONS=color\fP
+\fB# Show lit corridors differently\fP
+\fBOPTIONS=lit_corridor\fP
+
+\fB# No startup splash screen. Windows GUI only.\fP
+\fBOPTIONS=!splash_screen\fP
+.ed
 .hn 2
 Customization options
 .pg
diff --git a/doc/Guidebook.tex b/doc/Guidebook.tex
index a2e3e0a55..5ccc9bdef 100644
--- a/doc/Guidebook.tex
+++ b/doc/Guidebook.tex
@@ -2346,8 +2346,30 @@ There is a section of this Guidebook that discusses that.
 
 %.pg
 The default name of the configuration file varies on different
-operating systems, but NETHACKOPTIONS can also be set to
-the full name of a file you want to use (possibly preceded by an `{\tt @}').
+operating systems. On DOS and Windows, it is ``{\tt defaults.nh}''
+in the same folder as nethack.exe or nethackW.exe. On Unix, linux
+and Mac OS X it is ``{\tt.nethackrc}'' in the user's home directory.
+NETHACKOPTIONS can also be set to the full name of a file you
+want to use (possibly preceded by an `{\tt @}').
+
+%.pg
+Here is a short example of config file contents:
+%.sd
+\begin{verbatim}
+    # Set your character's role, race, gender, and alignment.
+    OPTIONS=role:Valkyrie, race:Human, gender:female, align:lawful
+
+    # Turn on autopickup, and set automatically picked up object types
+    OPTIONS=autopickup,pickup_types:$"=/!?+
+    # Show colored text if possible
+    OPTIONS=color
+    # Show lit corridors differently
+    OPTIONS=lit_corridor
+
+    # No startup splash screen. Windows GUI only.
+    OPTIONS=!splash_screen
+\end{verbatim}
+%.ed
 
 %.hn 2
 \subsection*{Customization options}