sound option in Guidebook

E-mail report from <Someone>.  "sound" option wasn't document.  I also
noticed that the SOUND and SOUNDDIR config file entries were incorrectly
named in lower case, and documented as "options", which they aren't.
The Guidebook calls SOUND an entry later on, so call them that earlier as well.

diff --git a/doc/Guidebook.mn b/doc/Guidebook.mn
index ade098ac7f008e545b33cd3946cc55c9449daab7..e0c338eb263304ac287cec7e548071b5660db9e1 100644 (file)
--- a/doc/Guidebook.mn
+++ b/doc/Guidebook.mn
@@ -2025,6 +2025,9 @@ Show your approximate accumulated score on bottom line (default off).
 Suppress terminal beeps (default on).
 .lp sortpack
 Sort the pack contents by type when displaying inventory (default on).
+.lp sound
+Enable messages about what your character hears (default on).
+Note that this has nothing to do with your computer's audio capabilities.
 .lp sparkle
 Display a sparkly effect when a monster (including yourself) is hit by an
 attack to which it is resistant (default on).
@@ -2225,11 +2228,11 @@ that matches a user-defined pattern is delivered to the message window.
 At this time the Qt port and the win32tty and win32gui ports support the
 use of user sounds.
 .pg
-The following config file options are relevant to mapping user sounds
+The following config file entries are relevant to mapping user sounds
 to messages:
-.lp soundir
+.lp SOUNDDIR
 The directory that houses the sound files to be played.
-.lp sound
+.lp SOUND
 An entry that maps a sound file to a user-specified message pattern.
 Each SOUND entry is broken down into the following parts:
 .sd

diff --git a/doc/Guidebook.tex b/doc/Guidebook.tex
index 30bf61f976b1fe39cf093e61a527ae1dc42ec603..c0d6becc2c8bf20851d45e5d6d24c777e7fd6940 100644 (file)
--- a/doc/Guidebook.tex
+++ b/doc/Guidebook.tex
@@ -27,7 +27,7 @@
 \begin{document}
 %
 % input file: guidebook.mn
-% $Revision: 1.54 $ $Date: 2002/09/24 09:42:53 $
+% $Revision: 1.55 $ $Date: 2002/09/26 07:37:12 $
 %
 %.ds h0 "
 %.ds h1 %.ds h2 \%
@@ -2488,6 +2488,10 @@ Suppress terminal beeps (default on).
 \item[\ib{sortpack}]
 Sort the pack contents by type when displaying inventory (default on).
 %.lp
+\item[\ib{sound}]
+Enable messages about what your character hears (default on).
+Note that this has nothing to do with your computer's audio capabilities.
+%.lp
 \item[\ib{standout}]
 Boldface monsters and ``{\tt --More--}'' (default off).
 %.lp
@@ -2750,15 +2754,15 @@ At this time the Qt port and the win32tty and win32gui ports support the
 use of user sounds.
 
 %.pg
-The following config file options are relevant to mapping user sounds
+The following config file entries are relevant to mapping user sounds
 to messages:
 
 \blist{}
 %.lp
-\item[\ib{soundir}]
+\item[\ib{SOUNDDIR}]
 The directory that houses the sound files to be played.
 %.lp
-\item[\ib{sound}]
+\item[\ib{SOUND}]
 An entry that maps a sound file to a user-specified message pattern.
 Each SOUND entry is broken down into the following parts:
 

diff --git a/doc/fixes34.1 b/doc/fixes34.1
index 088bbefda431a5783cb405f49a4fd7bd22189c5a..e9cae5d6180414ebce824691a151235eb29fa70b 100644 (file)
--- a/doc/fixes34.1
+++ b/doc/fixes34.1
@@ -276,6 +276,7 @@ when summoning nasty monsters, use new monster's type to decide if they can
        be placed on boulders, et al, not the summoning monster's type
 don't display the "intones:" prefix when !soundok since the message suffix
        won't be displayed in this case
+document "sound" option in Guidebook
 
 
 Platform- and/or Interface-Specific Fixes