another typo in comment
[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, the receiver
28 name and any options for that receiver,
29 seperated by colons.
30
31 Example:
32
33 -r mp3:http:-i:www.paraslash.org:-p:8009
34 "
35
36 string typestr="receiver_spec" default="http" no multiple
37
38 #################
39 option "no_default_filters" D "Configure filters manually.
40
41 If (and only if) this option is set, the
42 --filter options take effect. Otherwise, the
43 compiled-in default filters mp3dec (oggdec)
44 and wav are activated for mp3 (ogg) streams."
45
46 flag off
47 #################
48
49 option "filter" f "Select filter(s) manually.
50
51 May be given multiple times. filter_spec
52 consists of an audio format, the name of the
53 filter, and any options for that filter,
54 separated by colons.
55
56 Examples:
57 -f mp3:mp3dec
58 -f:mp3:compress:--anticlip:--volume:2
59
60 Note that these options are ignored by default,
61 see --no_default_filters."
62
63 string typestr="filter_spec" no multiple
64
65 #################
66
67 option "stream_write_cmd" w
68
69 "Specify stream writer.
70
71 May be given multiple times, once for each
72 supported audio format. Default value is
73 'para_play' for both mp3 and ogg. You can use
74 the START_TIME() macro for these commands.
75 Each occurence of START_TIME() gets replaced
76 at runtime by the stream start time announced
77 by para_server, plus any offsets."
78
79 string typestr="format:command" no multiple
80
81 #################
82
83 option "stream_delay" -
84
85 "Time to add to para_server's start_time.
86
87 Amount of time to be added to the server
88 stream start time for stream_write_cmd if
89 START_TIME() was given. Useful for
90 syncronizing the audio output of clients."
91
92 int typestr="milliseconds" default="200" no
93
94 #################
95
96 option "stream_timeout" -
97
98 "Deactivate slot if idle for that many seconds"
99
100 int typestr="seconds" default="30" no