Changeset 4570:e67d768ce684 in roaraudio for doc
- Timestamp:
- 10/31/10 13:35:36 (13 years ago)
- Branch:
- default
- Phase:
- public
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/man1/roard.1
r4013 r4570 1 1 .\" roard.1: 2 2 3 .TH "ROARD" "1" " July 2008" "RoarAudio" "System Manager's Manual: roard"3 .TH "ROARD" "1" "October 2010" "RoarAudio" "System Manager's Manual: roard" 4 4 5 5 .SH NAME … … 13 13 .SH "DESCRIPTION" 14 14 15 \fBroard\fR is the RoarAudio central daemon. It mixes up diffrent audio streams from it's clients to send them 16 as a single stream to the soundcard. 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. 17 20 18 21 .SH "GENERAL OPTIONS" … … 30 33 \fB--realtime\fR 31 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 .SH "STANDBY MODE" 86 .TP 87 \fB--standby\fR 88 Start in standby mode. 89 90 .TP 91 \fB--auto-standby\fR 92 Go into standby mode if no streams are active. 93 94 .SH "LOGGING" 95 .TP 96 \fB--verbose\fR 97 Increment the verbosity level. Can be used multiple times. 98 99 .TP 100 \fB--log-syslog\fR 101 Log to syslog. 102 103 .SH "PLUGINS" 104 .TP 105 \fB--plugin-load\fR 106 Load the given plugin. 107 108 .SH "SECURITY" 32 109 33 110 .TP … … 54 131 You need the permittions to change the UID (normaly only root has). 55 132 133 .SH "AUTH OPTIONS" 134 .TP 135 \fB--guest-acclev\fR 136 Sets the access level for guest connections. 137 138 .TP 139 \fB--trust-acclev\fR 140 Sets the access level for clients authenticated by trust auth. 141 142 .TP 143 \fB--trust-root\fR 144 Trust root user. 145 146 .TP 147 \fB--no-trust-root\fR 148 Do not trust root user. 56 149 57 150 .SH "AUDIO OPTIONS" … … 67 160 \fB--chans CHANNELS\fR, \fB-C CHANNELS\fR 68 161 Set server channels. 162 163 .TP 164 \fB--aiprofile PROFILE\fR 165 Use a existing audio profile. 166 167 .SH "GENERAL STREAM OPTIONS" 168 .TP 169 \fB--stream-flags\fR 170 Sets default flags for a given stream directions. 171 Examples: play=-meta, bidir=+antiecho 69 172 70 173 .SH "DRIVER OPTIONS" … … 113 216 .SH "SOURCE OPTIONS" 114 217 .TP 218 \fB--list-sources\fR 219 List all supported sources. 220 221 .TP 115 222 \fB--source\fR, \fB-s\fR 116 223 Adds a source of the given type. … … 132 239 Marks the source as primary. If the source reaches EOF roard will quit automatically. 133 240 241 .SH "HARDWARE MIXER OPTIONS" 242 .TP 243 \fB--list-mixers\fR 244 List all supported hardware mixers. 245 246 .TP 247 \fB--mixer\fR, \fB-m\fR 248 Add a hardware mixer of given type. 249 250 .TP 251 \fB-M\fR 252 Sets the device used for the hardware mixer. 253 254 .TP 255 \fB-mO\fR 256 Sets options for the hardware mixer. 257 See MIXER OPTIONS. 258 259 .TP 260 \fB-mN\fR 261 Adds another hardware mixer. 262 263 .TP 264 \fB-mP\fR 265 Marks the mixer primary. 266 267 .SH "CODEC FILTER" 268 .TP 269 \fB--list-cf\fR 270 List all supported codecfilters and codecs. 271 272 .SH "MIDI OPTIONS" 273 .TP 274 \fB--midi-no-console\fR 275 Disable console based MIDI synth. 276 277 .TP 278 \fB--midi-console-enable\fR 279 Enables console based MIDI synth. 280 281 .TP 282 \fB--midi-console\fR 283 Sets device for MIDI console. 284 Example: /dev/console 285 286 .TP 287 \fB--ssynth-enable\fR 288 Enables simple software synth. 289 290 .TP 291 \fB--ssynth-disable\fR 292 Disables simple software synth. 293 294 .SH "LIGHT CONTROL OPTIONS" 295 .TP 296 \fB--light-channels\fR 297 Sets the number of light channels. 298 Examples: 512, 1024 299 300 .SH "RADIO DATA SYSTEM OPTIONS" 301 .TP 302 \fB--rds-pi\fR 303 Sets the Programme Identification (PI). 304 305 .TP 306 \fB--rds-ps\fR 307 Sets the Programme Service Name (PS). 308 309 .TP 310 \fB--rds-pty\fR 311 Sets the Programme Type (PTY). 312 313 .TP 314 \fB--rds-tp\fR 315 Sets the Traffic Programme (TP) flag 316 317 .TP 318 \fB--rds-ct\fR 319 Enables sending of RDS Clock Time (CT). 320 321 .SH "X11 OPTIONS" 322 .TP 323 \fB--x11-display\fR, \fB--display\fR 324 Sets the display to use. 325 326 .TP 327 \fB--x11\fR 328 Enable X11 support. 329 134 330 .SH "NETWORK OPTIONS" 135 331 .TP … … 138 334 139 335 .TP 336 \fB-4\fR, \fB-6\fR 337 Use IPv4 or IPv6 mode. 338 339 .TP 340 \fB-64\fR 341 Try to downgrade IPv6 sockets into IPv4 sockets. 342 343 .TP 140 344 \fB--unix\fR, \fB-u\fR 141 345 Sets defaults for UNIX Domain Socket. … … 154 358 155 359 .TP 360 \fB--list-proto\fR 361 List supported protocols. 362 363 .TP 364 \fB--proto\fR 365 Sets 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 369 Set stream parameters for protocols needing stream options. 370 Defaults to server defaults. 371 372 .TP 373 \fB--list-profiles\fR 374 List supported profiles. 375 376 \fB--proto-profile\fR 377 Use the given profile for the listening socket. 378 379 .TP 380 \fB--new-sock\fR 381 Adds a new listening socket. 382 383 .TP 156 384 \fB--no-listen\fR 157 385 Do not listen for new clients (only useful for relaing, impleys \-\-terminate). … … 165 393 Close the given FH. This is not useful for endusers but used internaly. 166 394 395 .TP 396 \fB--jumbo-mtu\fR 397 Sets the MTU for Jambo Packets. 398 399 .SH "OPENSLP OPTIONS" 400 .TP 401 \fB--slp\fR 402 Enable OpenSLP support. 167 403 168 404 .SH "STREAM OPTIONS" … … 223 459 Example: 224 460 rate=44100,bits=16,channels=2,codec=pcm,sync 461 462 .SH "MIXER OPTIONS" 463 .TP 464 \fRprimary\fR 465 Makes this stream as primary. 466 467 .TP 468 \fBautoconf\fR 469 Sets the autoconf flag. 470 471 .TP 472 \fBpassmixer\fR 473 Sets the passmixer flag. 474 475 .TP 476 \fBname\fR 477 Sets the name for the device. 478 479 .TP 480 \fBsubs\fR 481 Sets list of subdevices. This is driver specific. 225 482 226 483 .SH "ENVIRONMENT VARIABLES"
Note: See TracChangeset
for help on using the changeset viewer.