X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=audiod.cmd;h=c58907448f12eeb44551b98d113c3ef52ba9979f;hp=598a823cd7cdfb40d06c4db09d6d86e0bb2ed1d8;hb=3150a0caa27a34d44556fb77f4a5aebc3d978580;hpb=7eb8cd4eb71610700e7a7f3fdd877c0b38a8863c

diff --git a/audiod.cmd b/audiod.cmd
index 598a823c..c5890744 100644
--- a/audiod.cmd
+++ b/audiod.cmd
@@ -1,63 +1,82 @@
-FN: audiod_command_list
+OF: audiod_command_list
+SF: audiod_command.c
 HC: prototypes for the audiod command handlers
 CC: array of audiod commands
 AT: audiod_command
 IN: list para sched audiod
+SN: list of audiod commands
 ---
 N: cycle
 D: switch to next mode
-S: cycle
+U: cycle
 H: on -> standby -> off -> on
 ---
 N: grab
 D: grab the audio stream
 L:
-S: -- grab [grab_options]
-H: grab ('splice') the audio stream at any position in the filter
-H: chain and send that data back to the client. Try
-H:	para_audioc -- grab -h
-H: for the list of available options.
+U: -- grab [-m[{s|p|a}]] [-p=PARENT] [-n=NAME] [-o]
+H:
+H: grab ('splice') the audio stream at any position in the buffer
+H: tree and send that data back to the client.
+H:
+H: Options:
+H:
+H: -m	Change grab mode. Defaults to sloppy grab if not given.
+H:
+H: 		-ms: sloppy grab
+H:
+H: 		-mp: pedantic grab
+H:
+H: 		-ma: aggressive grab
+H:
+H:	The various grab modes only differ in what happens if the
+H:	file descriptor to write the grabbed audio data to is not
+H:	ready for writing (i.e. would block). Sloppy mode ignores
+H:	the write, pedantic mode aborts and aggressive mode tries
+H:	to write anyway.
+H:
+H: -p	Grab output of node PARENT of the buffer tree.
+H:
+H: -n	Name of the new buffer tree node. Defaults to 'grab'.
+H:
+H: -o	One-shot mode: Stop grabbing if audio file changes.
 ---
 N: help
 D: display command list or help for given command
-S: help [command]
+U: help [command]
 H: When I was younger, so much younger than today, I never needed anybody's help
 H: in any way. But now these days are gone, I'm not so self assured. Now I find
 H: I've changed my mind and opened up the doors.
 H:                                                              -- Beatles: Help
 ---
-N: kill
-D: kill an active audiod task
-S: kill task_id [task_id ...]
-H: call sched_unregister() and the event_handler of the given task(s)
----
 N: off
 D: deactivate para_audiod
-S: off
+U: off
 H: Close connection to para_server and stop all decoders.
 ---
 N: on
 D: activate para_audiod
-S: on
+U: on
 H: Establish connection to para_server, retrieve para_server's current status. If
 H: playing, start corresponding decoder. Otherwise stop all decoders.
 ---
 N: sb
 D: enter standby mode
-S: sb
+U: sb
 H: Stop all decoders but leave connection to para_server open.
 ---
 N: stat
 D: print status information
-S: stat [item1 ...]
-H: Dump given status items (all if none given) to stdout.
+U: stat [-p] [item1 ...]
+H: Dump given status items (all if none given) to stdout. If -p is given, use
+H: parser-friendly mode.
 ---
 N: tasks
 D: list current tasks
-S: tasks
+U: tasks
 H: print the list of task ids together with the status of each task
 ---
 N: term
 D: terminate audiod
-S: term
+U: term
 H: Stop all decoders, shut down connection to para_server and exit.