Improve doxygen description of mood.c.

[paraslash.git] / audiod.cmd

diff --git a/audiod.cmd b/audiod.cmd
index 94f3ca041a2c626154d4073f8defa1fd2c9e0582..18c802de8857788449cb6dfbfa53823c7ef0da0e 100644 (file)
--- a/audiod.cmd
+++ b/audiod.cmd
@@ -1,9 +1,5 @@
-OF: audiod_command_list
+BN: audiod
 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
@@ -14,36 +10,28 @@ H: on -> standby -> off -> on
 N: grab
 D: grab the audio stream
 L:
-U: -- grab -[n=<num>] [-m[{s|p|a}]] [-i] [-o] [-f=<format>]
+U: -- grab [-m[{s|p|a}]] [-p=PARENT] [-n=NAME] [-o]
 H:
-H: grab ('splice') the audio stream at any position in the filter
-H: chain and send that data back to the client.
+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: -n  Point of the filter chain to grab. Filters count from zero.
-H:
 H: -m  Change grab mode. Defaults to sloppy grab if not given.
 H:
-H:             -ms: sloppy grab
-H:
-H:             -mp: pedantic grab
+H:    -ms: sloppy grab
+H:    -mp: pedantic grab
+H:    -ma: aggressive grab
 H:
-H:             -ma: aggressive grab
+H: The various grab modes only differ in what happens if an attempt to
+H: write the grabbed audio data would block. Sloppy mode ignores the
+H: write, pedantic mode aborts and aggressive mode tries to write anyway.
 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: -p  Grab output of node PARENT of the buffer tree.
 H:
-H: -i  Grab the filter input instead of its output.
+H: -n  Name of the new buffer tree node. Defaults to 'grab'.
 H:
 H: -o  One-shot mode: Stop grabbing if audio file changes.
-H:
-H: -f  Only grab streams of this format (mp3, ogg, aac). The default is to
-H:     grab any stream.
-H:
 ---
 N: help
 D: display command list or help for given command
@@ -53,11 +41,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: Simulate an error condition for the given task(s)
----
 N: off
 D: deactivate para_audiod
 U: off
@@ -83,9 +66,14 @@ H: parser-friendly mode.
 N: tasks
 D: list current tasks
 U: tasks
-H: print the list of task ids together with the status of each task
+H: Print the list of task ids together with the status of each task.
 ---
 N: term
 D: terminate audiod
 U: term
 H: Stop all decoders, shut down connection to para_server and exit.
+---
+N: version
+D: print the version of para_audiod
+U: version [-v]
+H: If the -v option is given, a more detailed version text is printed.