Fix two typos in stdin.c.
[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 option "clock_diff_count" -
89 #~~~~~~~~~~~~~~~~~~~~~~~~~~
90
91 "check the clock difference between
92 server_host (the host running para_server)
93 and the local host (running para_audiod)
94 that many times before starting any stream
95 I/0. Set this to non-zero for non-local
96 setups if the clocks of these two hosts are
97 not syncronized by ntp or similar."
98
99 int typestr="count"
100 default="0"
101 optional
102
103
104 section "stream i/o options."
105 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~
106
107 option "receiver" r
108 #~~~~~~~~~~~~~~~~~~
109
110 "Select receiver. May be given multiple
111 times, once for each supported audio format.
112 'receiver_spec' consists of an audio format and
113 the receiver name, separated by a colon, and
114 any options for that receiver, seperated by
115 whitespace. If any receiver options are
116 present, the whole receiver argument must be
117 quoted.
118
119 Example:
120
121 -r 'mp3:http -i www.paraslash.org -p 8009'
122 "
123
124 string typestr="receiver_spec"
125 default="http"
126 optional
127 multiple
128
129
130 option "no_default_filters" D
131 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~
132
133 "Configure filters manually. If (and only
134 if) this option is set, the --filter options
135 take effect. Otherwise, the compiled-in
136 default filters mp3dec, oggdec and aacdec are
137 activated for mp3, ogg, aac streams respectively."
138
139 flag off
140
141
142 option "filter" f
143 #~~~~~~~~~~~~~~~~
144
145 "Select filter(s) manually. May be given
146 multiple times. filter_spec consists of an
147 audio format, the name of the filter, and any
148 options for that filter.
149
150 Examples:
151 -f 'mp3:mp3dec'
152 -f 'mp3:compress --inertia 5 --damp 2'
153
154 Note that these options are ignored by default,
155 see --no_default_filters."
156
157 string typestr="filter_spec" optional multiple
158
159
160 option "writer" w
161 #~~~~~~~~~~~~~~~~~~~~~~~~~~
162
163 "Specify stream writer.
164
165 May be given multiple times, even multiple
166 times for the same audio format. Default
167 value is 'alsa' for all supported audio
168 formats. Example:
169
170 -w 'aac:osx'
171
172 "
173 string typestr="writer_spec"
174 optional
175 multiple
176
177
178 option "stream_delay" -
179 #~~~~~~~~~~~~~~~~~~~~~~
180
181 "Time to add to para_server's start_time.
182
183 Amount of time to be added to the server, before data is sent to
184 the writer. Useful for syncronizing the audio output of clients."
185
186 int typestr="milliseconds"
187 default="200"
188 optional
189
190 option "stream_timeout" -
191 #~~~~~~~~~~~~~~~~~~~~~~~~
192
193 "Deactivate slot if idle for that many
194 seconds"
195
196 int typestr="seconds"
197 default="30"
198 optional