1 | .\" roard.1: |
---|
2 | |
---|
3 | .TH "ROARD" "1" "October 2010" "RoarAudio" "System Manager's Manual: roard" |
---|
4 | |
---|
5 | .SH NAME |
---|
6 | |
---|
7 | roard \- RoarAudio sound server |
---|
8 | |
---|
9 | .SH SYNOPSIS |
---|
10 | |
---|
11 | \fBroard\fR [OPTIONS]... |
---|
12 | |
---|
13 | .SH "DESCRIPTION" |
---|
14 | |
---|
15 | \fBroard\fR is the most common RoarAudio sound server. |
---|
16 | The RoarAudio sound server is the central component in a RoarAudio setup. |
---|
17 | It mixes up diffrent audio streams from it's clients to send them |
---|
18 | to it's outputs. Such outputs include soundcards, monitoring clients, |
---|
19 | streaming servers and more. |
---|
20 | |
---|
21 | .SH "GENERAL OPTIONS" |
---|
22 | \fBNOTE: This list is incomplete!\fR |
---|
23 | |
---|
24 | .TP |
---|
25 | \fB--help\fR |
---|
26 | Print some help text. |
---|
27 | |
---|
28 | .TP |
---|
29 | \fB--daemon\fR |
---|
30 | Go into background after startup. |
---|
31 | |
---|
32 | .TP |
---|
33 | \fB--realtime\fR |
---|
34 | Ask for higher priority. May be used multiple times. |
---|
35 | |
---|
36 | .TP |
---|
37 | \fB--memlock LEVEL\fR |
---|
38 | Sets default memory locking level to LEVEL. |
---|
39 | |
---|
40 | .TP |
---|
41 | \fB--pidfile PIDFILE\fR |
---|
42 | Asks the server to use the given pidfile. This is recommended. |
---|
43 | |
---|
44 | .TP |
---|
45 | \fB--sysclocksync\fR |
---|
46 | Messure exact audio clock frequency based on system time. obsolete. |
---|
47 | |
---|
48 | .SH "SERVER INFO" |
---|
49 | .TP |
---|
50 | \fB--location LOC\fR |
---|
51 | Sets lion-readable location of server. |
---|
52 | Examples: livingroom, room 32 |
---|
53 | |
---|
54 | .TP |
---|
55 | \fB--description DESC\fR |
---|
56 | Sets lion-readable description of server. |
---|
57 | Examples: Stereo, UKW Transmitter |
---|
58 | |
---|
59 | .SH "STARTUP AND SHUTDOWN" |
---|
60 | .TP |
---|
61 | \fB--start\fR |
---|
62 | Start a new server. |
---|
63 | |
---|
64 | .TP |
---|
65 | \fB--stop\fR |
---|
66 | Stop the currently running server. |
---|
67 | See also \fB--shutdown\fR. |
---|
68 | |
---|
69 | .TP |
---|
70 | \fB--restart\fR |
---|
71 | Stop the currently running server and start up a new server. |
---|
72 | |
---|
73 | .TP |
---|
74 | \fB--shutdown\fR |
---|
75 | Terminates the currently running server after last client has quit. |
---|
76 | This is the most clean way to shutdown a running server as it does not kick |
---|
77 | any clients. |
---|
78 | This option must not be confused with \fB--terminate\fR. |
---|
79 | |
---|
80 | .TP |
---|
81 | \fB--terminate\fR |
---|
82 | Auto terminates the new server after last client has quit. |
---|
83 | This option must not be confused with \fB--shutdown\fR. |
---|
84 | |
---|
85 | .TP |
---|
86 | \fB--script-postdown S\fR |
---|
87 | Run script S after server shutdown. |
---|
88 | The script is passed to a shell. |
---|
89 | Any shell feature can be used within the string. |
---|
90 | |
---|
91 | .SH "STANDBY MODE" |
---|
92 | .TP |
---|
93 | \fB--standby\fR |
---|
94 | Start in standby mode. |
---|
95 | |
---|
96 | .TP |
---|
97 | \fB--auto-standby\fR |
---|
98 | Go into standby mode if no streams are active. |
---|
99 | |
---|
100 | .SH "LOGGING" |
---|
101 | .TP |
---|
102 | \fB--verbose\fR |
---|
103 | Increment the verbosity level. Can be used multiple times. |
---|
104 | |
---|
105 | .TP |
---|
106 | \fB--log-syslog\fR |
---|
107 | Log to syslog. |
---|
108 | |
---|
109 | .SH "PLUGINS" |
---|
110 | .TP |
---|
111 | \fB--plugin-load\fR |
---|
112 | Load the given plugin. |
---|
113 | |
---|
114 | .SH "SECURITY" |
---|
115 | |
---|
116 | .TP |
---|
117 | \fB--chroot DIR\fR |
---|
118 | Chroots to the given directory. This improves the security. This normally needs root privileg's. |
---|
119 | |
---|
120 | .SH "USER AND GROUPS" |
---|
121 | .TP |
---|
122 | \fB--setgid\fR |
---|
123 | Sets GroupID to the audio group as specified via \fB-G\fR. |
---|
124 | |
---|
125 | .TP |
---|
126 | \fB--setuid\fR |
---|
127 | Sets UserID to the audio user as specified via \fB-U\fR. |
---|
128 | |
---|
129 | .TP |
---|
130 | \fB-G GROUP\fR |
---|
131 | Sets the group for the UNIX Domain Socket, (default: audio) |
---|
132 | You need the permittions to change the GID. |
---|
133 | |
---|
134 | .TP |
---|
135 | \fB-U USER\fR |
---|
136 | Sets the user for the UNIX Domain Socket, (default: do not set) |
---|
137 | You need the permittions to change the UID (normaly only root has). |
---|
138 | |
---|
139 | .SH "AUTH OPTIONS" |
---|
140 | .TP |
---|
141 | \fB--guest-acclev\fR |
---|
142 | Sets the access level for guest connections. |
---|
143 | |
---|
144 | .TP |
---|
145 | \fB--trust-acclev\fR |
---|
146 | Sets the access level for clients authenticated by trust auth. |
---|
147 | |
---|
148 | .TP |
---|
149 | \fB--trust-root\fR |
---|
150 | Trust root user. |
---|
151 | |
---|
152 | .TP |
---|
153 | \fB--no-trust-root\fR |
---|
154 | Do not trust root user. |
---|
155 | |
---|
156 | .TP |
---|
157 | \fB--authfile-gen FILE\fR |
---|
158 | Generate a new authfile with a fresh cookie. |
---|
159 | |
---|
160 | .TP |
---|
161 | \fB--authfile-load FILE\fR |
---|
162 | Load all keys from a given authfile. |
---|
163 | |
---|
164 | .TP |
---|
165 | \fB--authfile-type TYPE\fR |
---|
166 | Sets the type for the authfile. |
---|
167 | |
---|
168 | .TP |
---|
169 | \fB--authfile-acclev ACCLEV\fR |
---|
170 | Sets the access level for the given authfile. |
---|
171 | |
---|
172 | .TP |
---|
173 | \fB--new-authfile\fR |
---|
174 | Add another authfile. |
---|
175 | |
---|
176 | |
---|
177 | .SH "AUDIO OPTIONS" |
---|
178 | .TP |
---|
179 | \fB--rate RATE\fR, \fB-R RATE\fR |
---|
180 | Set server sample rate. |
---|
181 | |
---|
182 | .TP |
---|
183 | \fB--bits BITS\fR, \fB-B BITS\fR |
---|
184 | Set server bits. |
---|
185 | |
---|
186 | .TP |
---|
187 | \fB--chans CHANNELS\fR, \fB-C CHANNELS\fR |
---|
188 | Set server channels. |
---|
189 | |
---|
190 | .TP |
---|
191 | \fB--aiprofile PROFILE\fR |
---|
192 | Use a existing audio profile. |
---|
193 | |
---|
194 | .SH "GENERAL STREAM OPTIONS" |
---|
195 | .TP |
---|
196 | \fB--stream-flags\fR |
---|
197 | Sets default flags for a given stream directions. |
---|
198 | Examples: play=-meta, bidir=+antiecho |
---|
199 | |
---|
200 | .SH "DRIVER OPTIONS" |
---|
201 | .TP |
---|
202 | \fB--list-driver\fR |
---|
203 | Shows a list of all available drivers. |
---|
204 | |
---|
205 | .TP |
---|
206 | \fB--driver\fR, \fB-d\fR |
---|
207 | .\"Set the output driver. To get a list of all drivers use \fB--list-driver\fR. |
---|
208 | This option is obsolete. |
---|
209 | Use \fB-o\fR instead. |
---|
210 | |
---|
211 | .TP |
---|
212 | \fB--device\fR, \fB-D\fR |
---|
213 | .\"Set the device for the output driver. Possible devices depends on the driver. |
---|
214 | .\"They may be a path to a device node or a hostname. |
---|
215 | .\"Use \fB--list-driver\fR to get a hint. |
---|
216 | .\"This option will obsolete soon. |
---|
217 | This option is obsolete. |
---|
218 | Use \fB-O\fR instead. |
---|
219 | |
---|
220 | .TP |
---|
221 | \fB--odriver\fR, \fB-o\fR |
---|
222 | Set the output driver. To get a list of all drivers use \fB--list-driver\fR. |
---|
223 | |
---|
224 | .TP |
---|
225 | \fB--odevice\fR, \fB-O\fR |
---|
226 | Set the device for the output driver. Possible devices depends on the driver. |
---|
227 | They may be a path to a device node or a hostname. |
---|
228 | Use \fB--list-driver\fR to get a hint. |
---|
229 | |
---|
230 | .TP |
---|
231 | \fB-oO\fR |
---|
232 | Sets options for the new stream. See STREAM OPTIONS. |
---|
233 | |
---|
234 | .TP |
---|
235 | \fB-oN\fR |
---|
236 | Adds another output. |
---|
237 | |
---|
238 | .TP |
---|
239 | \fB-oP\fR |
---|
240 | Marks the output primary. |
---|
241 | |
---|
242 | |
---|
243 | .SH "SOURCE OPTIONS" |
---|
244 | .TP |
---|
245 | \fB--list-sources\fR |
---|
246 | List all supported sources. |
---|
247 | |
---|
248 | .TP |
---|
249 | \fB--source\fR, \fB-s\fR |
---|
250 | Adds a source of the given type. |
---|
251 | |
---|
252 | .TP |
---|
253 | \fB-S\fR |
---|
254 | Sets the device or filename for the source. Type may depend on the source type. |
---|
255 | |
---|
256 | .TP |
---|
257 | \fB-sO\fR |
---|
258 | Sets options for the current source. |
---|
259 | |
---|
260 | .TP |
---|
261 | \fB-sN\fR |
---|
262 | Adds another source. |
---|
263 | |
---|
264 | .TP |
---|
265 | \fB-sP\fR |
---|
266 | Marks the source as primary. If the source reaches EOF roard will quit automatically. |
---|
267 | |
---|
268 | .SH "HARDWARE MIXER OPTIONS" |
---|
269 | .TP |
---|
270 | \fB--list-mixers\fR |
---|
271 | List all supported hardware mixers. |
---|
272 | |
---|
273 | .TP |
---|
274 | \fB--mixer\fR, \fB-m\fR |
---|
275 | Add a hardware mixer of given type. |
---|
276 | |
---|
277 | .TP |
---|
278 | \fB-M\fR |
---|
279 | Sets the device used for the hardware mixer. |
---|
280 | |
---|
281 | .TP |
---|
282 | \fB-mO\fR |
---|
283 | Sets options for the hardware mixer. |
---|
284 | See MIXER OPTIONS. |
---|
285 | |
---|
286 | .TP |
---|
287 | \fB-mN\fR |
---|
288 | Adds another hardware mixer. |
---|
289 | |
---|
290 | .TP |
---|
291 | \fB-mP\fR |
---|
292 | Marks the mixer primary. |
---|
293 | |
---|
294 | .SH "CODEC FILTER" |
---|
295 | .TP |
---|
296 | \fB--list-cf\fR |
---|
297 | List all supported codecfilters and codecs. |
---|
298 | |
---|
299 | .SH "MIDI OPTIONS" |
---|
300 | .TP |
---|
301 | \fB--midi-no-console\fR |
---|
302 | Disable console based MIDI synth. |
---|
303 | |
---|
304 | .TP |
---|
305 | \fB--midi-console-enable\fR |
---|
306 | Enables console based MIDI synth. |
---|
307 | |
---|
308 | .TP |
---|
309 | \fB--midi-console\fR |
---|
310 | Sets device for MIDI console. |
---|
311 | Example: /dev/console |
---|
312 | |
---|
313 | .TP |
---|
314 | \fB--ssynth-enable\fR |
---|
315 | Enables simple software synth. |
---|
316 | |
---|
317 | .TP |
---|
318 | \fB--ssynth-disable\fR |
---|
319 | Disables simple software synth. |
---|
320 | |
---|
321 | .SH "LIGHT CONTROL OPTIONS" |
---|
322 | .TP |
---|
323 | \fB--light-channels\fR |
---|
324 | Sets the number of light channels. |
---|
325 | Examples: 512, 1024 |
---|
326 | |
---|
327 | .SH "RADIO DATA SYSTEM OPTIONS" |
---|
328 | .TP |
---|
329 | \fB--rds-pi\fR |
---|
330 | Sets the Programme Identification (PI). |
---|
331 | |
---|
332 | .TP |
---|
333 | \fB--rds-ps\fR |
---|
334 | Sets the Programme Service Name (PS). |
---|
335 | |
---|
336 | .TP |
---|
337 | \fB--rds-pty\fR |
---|
338 | Sets the Programme Type (PTY). |
---|
339 | |
---|
340 | .TP |
---|
341 | \fB--rds-tp\fR |
---|
342 | Sets the Traffic Programme (TP) flag |
---|
343 | |
---|
344 | .TP |
---|
345 | \fB--rds-ct\fR |
---|
346 | Enables sending of RDS Clock Time (CT). |
---|
347 | |
---|
348 | .SH "X11 OPTIONS" |
---|
349 | .TP |
---|
350 | \fB--x11-display\fR, \fB--display\fR |
---|
351 | Sets the display to use. |
---|
352 | |
---|
353 | .TP |
---|
354 | \fB--x11\fR |
---|
355 | Enable X11 support. |
---|
356 | |
---|
357 | .SH "NETWORK OPTIONS" |
---|
358 | .TP |
---|
359 | \fB--tcp\fR, \fB-t\fR |
---|
360 | Sets defaults for TCP/IP Socket. |
---|
361 | |
---|
362 | .TP |
---|
363 | \fB-4\fR, \fB-6\fR |
---|
364 | Use IPv4 or IPv6 mode. |
---|
365 | |
---|
366 | .TP |
---|
367 | \fB-64\fR |
---|
368 | Try to downgrade IPv6 sockets into IPv4 sockets. |
---|
369 | |
---|
370 | .TP |
---|
371 | \fB--unix\fR, \fB-u\fR |
---|
372 | Sets defaults for UNIX Domain Socket. |
---|
373 | |
---|
374 | .TP |
---|
375 | \fB--decnet\fR, \fB-n\fR |
---|
376 | Sets defaults for DECnet Socket. |
---|
377 | |
---|
378 | .TP |
---|
379 | \fB--port\fR, \fB-p\fR |
---|
380 | Sets the port the server should listen on. |
---|
381 | |
---|
382 | .TP |
---|
383 | \fB--bind\fR, \fB-b\fR, \fB--sock\fR |
---|
384 | Sets the hostname or path the server should listen on. |
---|
385 | |
---|
386 | .TP |
---|
387 | \fB--list-proto\fR |
---|
388 | List supported protocols. |
---|
389 | |
---|
390 | .TP |
---|
391 | \fB--proto\fR |
---|
392 | Sets the protocol used for the listening socket. |
---|
393 | |
---|
394 | .TP |
---|
395 | \fB--proto-dir\fR, \fB--proto-rate\fR, \fB--proto-bits\fR, \fB--proto-codec\fR, \fB--proto-chans\fR, \fB--proto-aiprofile\fR |
---|
396 | Set stream parameters for protocols needing stream options. |
---|
397 | Defaults to server defaults. |
---|
398 | |
---|
399 | .TP |
---|
400 | \fB--list-profiles\fR |
---|
401 | List supported profiles. |
---|
402 | |
---|
403 | \fB--proto-profile\fR |
---|
404 | Use the given profile for the listening socket. |
---|
405 | |
---|
406 | .TP |
---|
407 | \fB--new-sock\fR |
---|
408 | Adds a new listening socket. |
---|
409 | |
---|
410 | .TP |
---|
411 | \fB--no-listen\fR |
---|
412 | Do not listen for new clients (only useful for relaing, impleys \-\-terminate). |
---|
413 | |
---|
414 | .TP |
---|
415 | \fB--client-fh FH\fR |
---|
416 | Expects a client on the given FH. This may be useful with \fB--no-listen\fR. |
---|
417 | |
---|
418 | .TP |
---|
419 | \fB--close-fh FH\fR |
---|
420 | Close the given FH. This is not useful for endusers but used internaly. |
---|
421 | |
---|
422 | .TP |
---|
423 | \fB--jumbo-mtu\fR |
---|
424 | Sets the MTU for Jambo Packets. |
---|
425 | |
---|
426 | .SH "OPENSLP OPTIONS" |
---|
427 | .TP |
---|
428 | \fB--slp\fR |
---|
429 | Enable OpenSLP support. |
---|
430 | |
---|
431 | .SH "STREAM OPTIONS" |
---|
432 | .TP |
---|
433 | \fBrate\fR |
---|
434 | Sets the sample rate. |
---|
435 | |
---|
436 | .TP |
---|
437 | \fBchannels\fR |
---|
438 | Sets the number of channels. |
---|
439 | |
---|
440 | .TP |
---|
441 | \fBbits\fR |
---|
442 | Sets the number of bits per sample. |
---|
443 | |
---|
444 | .TP |
---|
445 | \fBcodec\fR |
---|
446 | Sets the codec. |
---|
447 | |
---|
448 | .TP |
---|
449 | \fBblocks\fR |
---|
450 | Sets the number of memory blocks that sould be used by the devices. |
---|
451 | Most devices only support a few values or don't support this option at all. |
---|
452 | If this option or the specifyed value is not supported by the device this is not |
---|
453 | handled as fatal error. |
---|
454 | |
---|
455 | .TP |
---|
456 | \fBblocksize\fR |
---|
457 | Sets the size of the memory blocks used by the device. |
---|
458 | Most devices only support a few values or don't support this option at all. |
---|
459 | If this option or the specifyed value is not supported by the device this is not |
---|
460 | handled as fatal error. |
---|
461 | |
---|
462 | .TP |
---|
463 | \fBmeta\fR |
---|
464 | Sets the meta flag. |
---|
465 | |
---|
466 | .TP |
---|
467 | \fBsync\fR |
---|
468 | Sets the sync flag. |
---|
469 | |
---|
470 | .TP |
---|
471 | \fBprimary\fR |
---|
472 | Marks this stream as primary. |
---|
473 | |
---|
474 | .TP |
---|
475 | \fBcleanmeta\fR |
---|
476 | Sets the cleanmeta flag. |
---|
477 | |
---|
478 | .TP |
---|
479 | \fBautoconf\fR |
---|
480 | Sets the autoconf flag. |
---|
481 | This flag is not supported by all drivers. |
---|
482 | If the flag is set and the devices does not support this there is no |
---|
483 | fatal error if the device could be opend with defaults. |
---|
484 | |
---|
485 | .TP |
---|
486 | Example: |
---|
487 | rate=44100,bits=16,channels=2,codec=pcm,sync |
---|
488 | |
---|
489 | .SH "MIXER OPTIONS" |
---|
490 | .TP |
---|
491 | \fRprimary\fR |
---|
492 | Makes this stream as primary. |
---|
493 | |
---|
494 | .TP |
---|
495 | \fBautoconf\fR |
---|
496 | Sets the autoconf flag. |
---|
497 | |
---|
498 | .TP |
---|
499 | \fBpassmixer\fR |
---|
500 | Sets the passmixer flag. |
---|
501 | |
---|
502 | .TP |
---|
503 | \fBname\fR |
---|
504 | Sets the name for the device. |
---|
505 | |
---|
506 | .TP |
---|
507 | \fBsubs\fR |
---|
508 | Sets list of subdevices. This is driver specific. |
---|
509 | |
---|
510 | .SH "ENVIRONMENT VARIABLES" |
---|
511 | .TP |
---|
512 | \fBHOME\fR |
---|
513 | The users home directory. |
---|
514 | |
---|
515 | .TP |
---|
516 | \fBROAR_SERVER\fR |
---|
517 | The address of the listening server. This may be in form of host:port for TCP/IP connections |
---|
518 | and /path/to/sock for UNIX Domain Sockets. |
---|
519 | |
---|
520 | .TP |
---|
521 | \fBROAR_DRIVER\fR |
---|
522 | The driver to select. Same as \fB-d\fR. |
---|
523 | |
---|
524 | .TP |
---|
525 | \fBROAR_DEVICE\fR |
---|
526 | The device to select. Same as \fB-D\fR. |
---|
527 | |
---|
528 | .SH "BUGS" |
---|
529 | There are lots of bugs... |
---|
530 | |
---|
531 | .SH "SEE ALSO" |
---|
532 | \fBroar-config\fR(1), |
---|
533 | \fBroarcat\fR(1), |
---|
534 | \fBroarcat2sock\fR(1), |
---|
535 | \fBroarcatad\fR(1), |
---|
536 | \fBroarctl\fR(1), |
---|
537 | \fBroarfilt\fR(1), |
---|
538 | \fBroarfish\fR(1), |
---|
539 | \fBroarmon\fR(1), |
---|
540 | \fBroarsockconnect\fR(1), |
---|
541 | \fBroartypes\fR(1), |
---|
542 | \fBroarvorbis\fR(1), |
---|
543 | \fBRoarAudio\fR(7). |
---|
544 | |
---|
545 | .SH "HISTORY" |
---|
546 | |
---|
547 | For history information see \fBRoarAudio\fR(7). |
---|
548 | |
---|
549 | .\" ll |
---|