[sawfish] Doc improvements on sound support change.

[Christopher Bratusek <chrisb src gnome org>]

commit 67114d7c2c31dd32d03ac736bd645f678f265ce7
Author: Teika kazura <teika lavabit com>
Date:   Wed Nov 11 22:05:31 2009 +0900

    Doc improvements on sound support change.

 OPTIONS                            |    5 ++++-
 lisp/sawfish/wm/util/play-audio.jl |    5 ++++-
 man/faq.texi                       |   19 +++++++++++++++++++
 man/news.texi                      |   15 ++++++++++++---
 man/sawfish.texi                   |    4 ----
 5 files changed, 39 insertions(+), 9 deletions(-)
---
diff --git a/OPTIONS b/OPTIONS
index d58753c..c336ec5 100644
--- a/OPTIONS
+++ b/OPTIONS
@@ -342,7 +342,10 @@
 ;;    "List of directories to search for sound samples.")
 
 ;;  (define-special-variable play-sample-program "/usr/bin/paplay"
-;;    "The program used to play audio samples.")
+;;    "The program used to play audio samples. Should be capable of
+;; playing *.wav file.
+;;   You can't set any arguments to pass from this variable. If you want
+;; to give arguments or redirect output, write a wrapper program.")
 
 ;; edge flip options
 
diff --git a/lisp/sawfish/wm/util/play-audio.jl b/lisp/sawfish/wm/util/play-audio.jl
index 8c5ac73..1c9b551 100644
--- a/lisp/sawfish/wm/util/play-audio.jl
+++ b/lisp/sawfish/wm/util/play-audio.jl
@@ -39,7 +39,10 @@
     "List of directories to search for sound samples.")
 
   (defcustom play-sample-program "/usr/bin/paplay"
-    "The program used to play audio samples."
+    "The program used to play audio samples. Should be capable of
+playing *.wav file.
+  You can't set any arguments to pass from this variable. If you want
+to give arguments or redirect output, write a wrapper program."
     :type program
     :group audio)
 
diff --git a/man/faq.texi b/man/faq.texi
index 07578b6..6705da3 100644
--- a/man/faq.texi
+++ b/man/faq.texi
@@ -132,6 +132,25 @@ package preventing engine based themes working with several interpreted
 languages. Get the latest @code{gtk-engines} from
 @url{ftp://ftp.gnome.org/}
 
+ item Sound support.
+
+Here we explain sound support which can't be set via Configurator.
+
+You can add sound files under @file{~/.sawfish/sounds/}. This path can
+be changed with @code{audio-load-path} variable. See the file
+ file{OPTIONS} for the format.
+
+The program to play sounds is set by @code{play-sample-program}. If
+you want to pass arguments or redirect the output, prepare a wrapper script,
+for example something like following:
+
+ example
+#!/bin/sh
+
+# No need of backgrounding.
+mplayer -volume 30 "$1" &>/dev/null
+ end example
+
 @item What's this @code{sawfish-client} program?
 
 This allows you to connect to a window manager process and evaluate
diff --git a/man/news.texi b/man/news.texi
index 5584fd7..27ba1a8 100644
--- a/man/news.texi
+++ b/man/news.texi
@@ -56,8 +56,19 @@ workspace boundaries; to acheive the previous behavior set
 @code{viewport-boundary-mode} to @code{'dynamic}.
 
 @item In SawfishConfig the "Matched Windows" group has been renamed to "Windows Rules"
- end itemize
 
+ item Sound support has changed. [Christopher Bratusek]
+
+Sawfish used to rely on esound and libaudiofile to play sound, but we
+stopped it. If you want sound, set the variable
+ code{play-sample-program} to the path of the program capable of
+playing *.wav file. You can set the variable from the Configurator,
+too.
+
+You can't set any arguments to pass from this variable. If you want to
+give arguments or redirect output, write a wrapper
+program. (@pxref{FAQ}, ``Sound support'' section.)
+ end itemize
 @item Bugs fixed:
 @itemize @minus
 
@@ -200,8 +211,6 @@ In KDE4 WM Selector, Sawfish is added. [Christopher Bratusek]
 @item Removed Features:
 @itemize @minus
 
- item Built-in audio support has been dropped, instead we rely on an extern playbin [Christopher Bratusek]
-
 @item Built-in support for mouse-buttons 6 to 9 is dropped
 
 X.Org/XF86 Headers only include up to Button5. Our previous support for button 6 to 9 is hackish, and dropped, though technically more are possible.
diff --git a/man/sawfish.texi b/man/sawfish.texi
index 606a8f8..f9b188b 100644
--- a/man/sawfish.texi
+++ b/man/sawfish.texi
@@ -6277,10 +6277,6 @@ with the environment variable @code{SAWFISHSITELISPDIR}.
 The version number of the running Sawfish.
 @end defvar
 
- defun primitive-play-sample filename
-Plays the sound file @var{filename} (which must be a string).
- end defun
-
 @defun call-with-error-handler thunk
 Call the zero-parameter function @var{thunk}.  If an error occurs,
 trap it and pass its @code{car} and @code{cdr} to