audiod.cmd: Improve grab client help text.
[paraslash.git] / audiod.cmd
1 BN: audiod
2 SF: audiod_command.c
3 SN: list of audiod commands
4 ---
5 N: cycle
6 D: switch to next mode
7 U: cycle
8 H: on -> standby -> off -> on
9 ---
10 N: grab
11 D: grab the audio stream
12 L:
13 U: -- grab [-m[{s|p|a}]] [-p=PARENT] [-n=NAME] [-o]
14 H:
15 H: grab ('splice') the audio stream at any position in the buffer
16 H: tree and send that data back to the client.
17 H:
18 H: Options:
19 H:
20 H: -m Change grab mode. Defaults to sloppy grab if not given.
21 H:
22 H: -ms: sloppy grab
23 H: -mp: pedantic grab
24 H: -ma: aggressive grab
25 H:
26 H: The various grab modes only differ in what happens if an attempt to
27 H: write the grabbed audio data would block. Sloppy mode ignores the
28 H: write, pedantic mode aborts and aggressive mode tries to write anyway.
29 H:
30 H: -p Grab output of node PARENT of the buffer tree.
31 H:
32 H: -n Name of the new buffer tree node. Defaults to 'grab'.
33 H:
34 H: -o One-shot mode: Stop grabbing if audio file changes.
35 ---
36 N: help
37 D: display command list or help for given command
38 U: help [command]
39 H: When I was younger, so much younger than today, I never needed anybody's help
40 H: in any way. But now these days are gone, I'm not so self assured. Now I find
41 H: I've changed my mind and opened up the doors.
42 H: -- Beatles: Help
43 ---
44 N: off
45 D: deactivate para_audiod
46 U: off
47 H: Close connection to para_server and stop all decoders.
48 ---
49 N: on
50 D: activate para_audiod
51 U: on
52 H: Establish connection to para_server, retrieve para_server's current status. If
53 H: playing, start corresponding decoder. Otherwise stop all decoders.
54 ---
55 N: sb
56 D: enter standby mode
57 U: sb
58 H: Stop all decoders but leave connection to para_server open.
59 ---
60 N: stat
61 D: print status information
62 U: stat [-p] [item1 ...]
63 H: Dump given status items (all if none given) to stdout. If -p is given, use
64 H: parser-friendly mode.
65 ---
66 N: tasks
67 D: list current tasks
68 U: tasks
69 H: print the list of task ids together with the status of each task
70 ---
71 N: term
72 D: terminate audiod
73 U: term
74 H: Stop all decoders, shut down connection to para_server and exit.