Merge branch 'no_colon_separators'
[paraslash.git] / audiod.ggo
1 section "general options"
2 option "user" u "run as user 'name'. Read the output of 'para_server -h' for a detailed information on this option." string typestr="name" no
3 option "loglevel" l "set loglevel (0-6)" int typestr="level" default="4" no
4 option "daemon" d "run as background daemon" flag off
5 option "force" F "force startup even if socket exits" flag off
6 option "logfile" L "(default=stdout/stderr)" string typestr="filename" no
7 option "mode" m "mode to use on startup (on/off/sb)" string typestr="mode" default="on" no
8 option "socket" s "well-known socket to listen on (default=/var/paraslash/audiod_sock.<host_name>)" string typestr="filename" no
9
10 option "user_allow" -
11
12 "allow this user to connect to para_audiod.
13 May be specified multiple times. If not
14 specified at all, allow all users to
15 connect."
16
17 int typestr="uid" default="-1" no multiple
18
19 section "stream i/o options."
20
21 #################
22
23 option "receiver" r "Select receiver.
24
25 May be given multiple times, once for each
26 supported audio format. receiver_spec
27 consists of an audio format and the receiver
28 name, separated by a colon, and any options
29 for that receiver, seperated by whitespace.
30 If any receiver options are present, the
31 whole receiver argument must be quoted.
32
33 Example:
34
35 -r 'mp3:http -i www.paraslash.org -p 8009'
36 "
37
38 string typestr="receiver_spec" default="http" no multiple
39
40 #################
41 option "no_default_filters" D "Configure filters manually.
42
43 If (and only if) this option is set, the
44 --filter options take effect. Otherwise, the
45 compiled-in default filters mp3dec (oggdec)
46 and wav are activated for mp3 (ogg) streams."
47
48 flag off
49 #################
50
51 option "filter" f "Select filter(s) manually.
52
53 May be given multiple times. filter_spec
54 consists of an audio format, the name of the
55 filter, and any options for that filter.
56
57 Examples:
58 -f mp3:mp3dec
59 -f 'mp3:compress --anticlip --volume 2'
60
61 Note that these options are ignored by default,
62 see --no_default_filters."
63
64 string typestr="filter_spec" no multiple
65
66 #################
67
68 option "stream_write_cmd" w
69
70 "Specify stream writer.
71
72 May be given multiple times, once for each
73 supported audio format. Default value is
74 'para_play' for both mp3 and ogg. You can use
75 the START_TIME() macro for these commands.
76 Each occurence of START_TIME() gets replaced
77 at runtime by the stream start time announced
78 by para_server, plus any offsets."
79
80 string typestr="format:command" no multiple
81
82 #################
83
84 option "stream_delay" -
85
86 "Time to add to para_server's start_time.
87
88 Amount of time to be added to the server
89 stream start time for stream_write_cmd if
90 START_TIME() was given. Useful for
91 syncronizing the audio output of clients."
92
93 int typestr="milliseconds" default="200" no
94
95 #################
96
97 option "stream_timeout" -
98
99 "Deactivate slot if idle for that many seconds"
100
101 int typestr="seconds" default="30" no