Merge branch 't/makefile_cleanups'
[paraslash.git] / audiod.cmd
index 8300e44..c589074 100644 (file)
@@ -1,4 +1,5 @@
-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
@@ -13,11 +14,32 @@ H: on -> standby -> off -> on
 N: grab
 D: grab the audio stream
 L:
-U: -- 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
@@ -27,11 +49,6 @@ 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
-U: kill task_id [task_id ...]
-H: call sched_unregister() and the event_handler of the given task(s)
----
 N: off
 D: deactivate para_audiod
 U: off
@@ -50,8 +67,9 @@ H: Stop all decoders but leave connection to para_server open.
 ---
 N: stat
 D: print status information
-U: 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