# HG changeset patch
# User Gerd Moellmann <gerd@gnu.org>
# Date 947765204 0
# Node ID e17a1c6d3d693f0268cd591c11858ad3cff8face
# Parent  556645e6675eabdfd9d92fa09dc78bcb6ab4e4aa
(Fplay_sound): Improve doc string.

diff -r 556645e6675e -r e17a1c6d3d69 src/sound.c
--- a/src/sound.c	Thu Jan 13 11:48:47 2000 +0000
+++ b/src/sound.c	Thu Jan 13 12:06:44 2000 +0000
@@ -355,7 +355,23 @@
 
 
 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;
 {