fix serious typo
[paraslash.git] / audiod.ggo
1 section "general options"
2 #~~~~~~~~~~~~~~~~~~~~~~~~
3
4 option "user" u
5 #~~~~~~~~~~~~~~
6
7 "run as user 'name'. Read the output of
8 'para_server -h' for more information on this
9 option."
10
11 string typestr="name"
12 optional
13
14 option "group" g
15 #~~~~~~~~~~~~~~~
16
17 "set group id to 'group'. Read the output of
18 'para_server -h' for more information on this
19 option."
20
21 string typestr="group"
22 optional
23
24 option "loglevel" l
25 #~~~~~~~~~~~~~~~~~~
26
27 "set loglevel (0-6)"
28
29 int typestr="level"
30 default="4"
31 optional
32
33 option "daemon" d
34 #~~~~~~~~~~~~~~~~
35
36 "run as background daemon"
37
38 flag off
39
40
41 option "force" F
42 #~~~~~~~~~~~~~~~
43
44 "force startup even if
45 socket exists"
46
47 flag off
48
49 option "logfile" L
50 #~~~~~~~~~~~~~~~~~
51
52 "(default=stdout/stderr)"
53
54 string typestr="filename"
55 optional
56
57 option "mode" m
58 #~~~~~~~~~~~~~~
59
60 "mode to use on startup (on/off/sb)"
61
62 string typestr="mode"
63 default="on"
64 optional
65
66 option "socket" s
67
68 "well-known socket to listen on
69 (default=/var/paraslash/audiod_sock.<host_name>)"
70
71 string typestr="filename"
72 optional
73
74 option "user_allow" -
75 #~~~~~~~~~~~~~~~~~~~~
76
77 "allow this user to connect to para_audiod.
78 May be specified multiple times. If not
79 specified at all, all users are allowed to
80 connect."
81
82 int typestr="uid"
83 default="-1"
84 optional
85 multiple
86
87
88
89
90 section "stream i/o options."
91 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92
93 option "receiver" r
94 #~~~~~~~~~~~~~~~~~~
95
96 "Select receiver. May be given multiple
97 times, once for each supported audio format.
98 'receiver_spec' consists of an audio format and
99 the receiver name, separated by a colon, and
100 any options for that receiver, seperated by
101 whitespace. If any receiver options are
102 present, the whole receiver argument must be
103 quoted.
104
105 Example:
106
107 -r 'mp3:http -i www.paraslash.org -p 8009'
108 "
109
110 string typestr="receiver_spec"
111 default="http"
112 optional
113 multiple
114
115
116 option "no_default_filters" D
117 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~
118
119 "Configure filters manually. If (and only
120 if) this option is set, the --filter options
121 take effect. Otherwise, the compiled-in
122 default filters mp3dec (oggdec) and wav are
123 activated for mp3 (ogg) streams."
124
125 flag off
126
127
128 option "filter" f
129 #~~~~~~~~~~~~~~~~
130
131 "Select filter(s) manually. May be given
132 multiple times. filter_spec consists of an
133 audio format, the name of the filter, and any
134 options for that filter.
135
136 Examples:
137 -f 'mp3:mp3dec'
138 -f 'mp3:compress --inertia 5 --damp 2'
139
140 Note that these options are ignored by default,
141 see --no_default_filters."
142
143 string typestr="filter_spec" optional multiple
144
145
146 option "stream_write_cmd" w
147 #~~~~~~~~~~~~~~~~~~~~~~~~~~
148
149 "Specify stream writer.
150
151 May be given multiple times, once for each
152 supported audio format. Default value is
153 'para_write -w alsa' for both mp3 and ogg.
154 You can use the START_TIME() macro for these
155 commands. Each occurence of START_TIME()
156 gets replaced at runtime by the stream start
157 time announced by para_server, plus any
158 offsets."
159
160 string typestr="format:command"
161 optional
162 multiple
163
164
165 option "stream_delay" -
166 #~~~~~~~~~~~~~~~~~~~~~~
167
168 "Time to add to para_server's start_time.
169
170 Amount of time to be added to the server
171 stream start time for stream_write_cmd if
172 START_TIME() was given. Useful for
173 syncronizing the audio output of clients."
174
175 int typestr="milliseconds"
176 default="200"
177 optional
178
179 option "stream_timeout" -
180 #~~~~~~~~~~~~~~~~~~~~~~~~
181
182 "Deactivate slot if idle for that many
183 seconds"
184
185 int typestr="seconds"
186 default="30"
187 optional