Merge branch 'maint' into next
[paraslash.git] / audiod.cmd
index 4b03b91..94f3ca0 100644 (file)
@@ -1,27 +1,53 @@
-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
-AN: cmds
 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]
+U: -- grab -[n=<num>] [-m[{s|p|a}]] [-i] [-o] [-f=<format>]
+H:
 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.
+H: chain 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:
+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: -i  Grab the filter input instead of its output.
+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
-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.
@@ -29,36 +55,37 @@ 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)
+U: kill task_id [task_id ...]
+H: Simulate an error condition for 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.