source: roaraudio/doc/man1/roard.1 @ 4570:e67d768ce684

Last change on this file since 4570:e67d768ce684 was 4570:e67d768ce684, checked in by phi, 13 years ago

updated manpage

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