From: Gerd Moellmann <gerd@gnu.org>
Date: Thu, 13 Jan 2000 12:06:44 +0000 (+0000)
Subject: (Fplay_sound): Improve doc string.
X-Git-Tag: emacs-pretest-21.0.90~5361
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=2542139e1cc39dba5160431233a26d7ac8f61651;p=emacs.git

(Fplay_sound): Improve doc string.
---

diff --git a/src/sound.c b/src/sound.c
index 6f0e6fb997e..0f0706e5db3 100644
--- a/src/sound.c
+++ b/src/sound.c
@@ -355,7 +355,23 @@ sound_cleanup (arg)
 
 
 DEFUN ("play-sound", Fplay_sound, Splay_sound, 1, 1, 0,
-  "Play sound SOUND.")
+  "Play sound SOUND.\n\
+SOUND is a list of the form `(sound KEYWORD VALUE...)'.\n\
+The following keywords are recognized:\n\
+\n\
+  :file FILE.- read sound data from FILE.  If FILE Isn't an\n\
+absolute file name, it is searched in `data-directory'.\n\
+\n\
+  :data DATA - read sound data from string DATA.\n\
+\n\
+Exactly one of :file or :data must be present.\n\
+\n\
+  :volume VOL - set volume to VOL.  VOL must an integer in the\n\
+range 0..100 or a float in the range 0..1.0.  If not specified,\n\
+don't change the volume setting of the sound device.\n\
+\n\
+  :device DEVICE - play sound on DEVICE.  If not specified,\n\
+a system-dependent default device name is used.")
   (sound)
      Lisp_Object sound;
 {