summaryrefslogtreecommitdiff
path: root/src/sound.c
diff options
context:
space:
mode:
authorGerd Moellmann <gerd@gnu.org>2000-01-13 12:06:44 +0000
committerGerd Moellmann <gerd@gnu.org>2000-01-13 12:06:44 +0000
commit2542139e1cc39dba5160431233a26d7ac8f61651 (patch)
tree2f95daa374eee981685ee6d9ea4cd55e4fb27466 /src/sound.c
parent20ed8664fd98b56b03bd543d8c0a5a068c1f6318 (diff)
downloademacs-2542139e1cc39dba5160431233a26d7ac8f61651.tar.gz
(Fplay_sound): Improve doc string.
Diffstat (limited to 'src/sound.c')
-rw-r--r--src/sound.c18
1 files changed, 17 insertions, 1 deletions
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;
{