[147] | 1 | .\" roard.1: |
---|
| 2 | |
---|
[4570] | 3 | .TH "ROARD" "1" "October 2010" "RoarAudio" "System Manager's Manual: roard" |
---|
[147] | 4 | |
---|
| 5 | .SH NAME |
---|
| 6 | |
---|
| 7 | roard \- RoarAudio sound server |
---|
| 8 | |
---|
| 9 | .SH SYNOPSIS |
---|
| 10 | |
---|
| 11 | \fBroard\fR [OPTIONS]... |
---|
| 12 | |
---|
| 13 | .SH "DESCRIPTION" |
---|
| 14 | |
---|
[4570] | 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. |
---|
[147] | 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 |
---|
[775] | 29 | \fB--daemon\fR |
---|
[147] | 30 | Go into background after startup. |
---|
| 31 | |
---|
| 32 | .TP |
---|
| 33 | \fB--realtime\fR |
---|
[1113] | 34 | Ask for higher priority. May be used multiple times. |
---|
| 35 | |
---|
| 36 | .TP |
---|
[4570] | 37 | \fB--memlock LEVEL\fR |
---|
| 38 | Sets default memory locking level to LEVEL. |
---|
| 39 | |
---|
[5159] | 40 | Valid levels are: |
---|
| 41 | .RS |
---|
| 42 | .TP |
---|
| 43 | \fBnone\fR |
---|
| 44 | No memory is locked at all. |
---|
| 45 | |
---|
| 46 | .TP |
---|
| 47 | \fBlow\fR |
---|
| 48 | Only very few (important) objects are locked in memory. |
---|
| 49 | |
---|
| 50 | .TP |
---|
| 51 | \fBmedium\fR |
---|
| 52 | Few (important) objects are locked in memory. |
---|
| 53 | |
---|
| 54 | .TP |
---|
| 55 | \fBhigh\fR |
---|
| 56 | Many objects are locked in memory. |
---|
| 57 | |
---|
| 58 | .TP |
---|
| 59 | \fBnearlyall\fR |
---|
| 60 | All known objects are locked in memory. |
---|
| 61 | |
---|
| 62 | .TP |
---|
| 63 | \fBnearlyallsys\fR |
---|
| 64 | All known objects are locked in memory but also pages provided by the system like stack and heap. |
---|
| 65 | |
---|
| 66 | .TP |
---|
| 67 | \fBallcur\fR |
---|
| 68 | All currently used pages are locked in memory. |
---|
| 69 | |
---|
| 70 | .TP |
---|
| 71 | \fBall\fR |
---|
| 72 | All pages (including future allocated pages) are locked in memory. |
---|
| 73 | |
---|
| 74 | .TP |
---|
| 75 | \fBdefault\fR |
---|
| 76 | Use defaults (the default). |
---|
| 77 | |
---|
| 78 | .RE |
---|
| 79 | |
---|
| 80 | A higher memlock level may result in memory allocations problems at runtime and even segfauls on some systems. |
---|
| 81 | (VM killed processes). Check your current system limits before altering this value. |
---|
| 82 | |
---|
[4570] | 83 | .TP |
---|
[5620] | 84 | \fB--watchdog\fR |
---|
| 85 | Enable watchdog. This will terminate the daemon if something bad happened and it halted. |
---|
| 86 | |
---|
| 87 | .TP |
---|
| 88 | \fB--watchdog-time TIME\fR |
---|
| 89 | Set watchdog time to TIME (in ms). |
---|
| 90 | |
---|
| 91 | .TP |
---|
[4570] | 92 | \fB--pidfile PIDFILE\fR |
---|
| 93 | Asks the server to use the given pidfile. This is recommended. |
---|
| 94 | |
---|
| 95 | .TP |
---|
| 96 | \fB--sysclocksync\fR |
---|
| 97 | Messure exact audio clock frequency based on system time. obsolete. |
---|
| 98 | |
---|
| 99 | .SH "SERVER INFO" |
---|
| 100 | .TP |
---|
[5642] | 101 | \fB\-\-location LOC\fR |
---|
[4570] | 102 | Sets lion-readable location of server. |
---|
| 103 | Examples: livingroom, room 32 |
---|
| 104 | |
---|
| 105 | .TP |
---|
[5642] | 106 | \fB\-\-description DESC\fR |
---|
[4570] | 107 | Sets lion-readable description of server. |
---|
| 108 | Examples: Stereo, UKW Transmitter |
---|
| 109 | |
---|
[5642] | 110 | .TP |
---|
| 111 | \fB\-\-contact CONTACT\fR |
---|
| 112 | Sets contact information for the server. |
---|
| 113 | |
---|
| 114 | .TP |
---|
| 115 | \fB\-\-serial SERIAL\fR |
---|
| 116 | Sets the serial number for this device or server. |
---|
| 117 | This is normally only used by embedded systems. |
---|
| 118 | |
---|
| 119 | .TP |
---|
| 120 | \fB\-\-uiurl UIURL\fR |
---|
| 121 | Sets the URL of the user interface for this device or server. |
---|
| 122 | This is normally only used by embedded systems. |
---|
| 123 | It is common to set this to a URL of type HTTP but all protocols are |
---|
| 124 | considered valid. This includes ssh, telnet and others. |
---|
| 125 | |
---|
[4570] | 126 | .SH "STARTUP AND SHUTDOWN" |
---|
| 127 | .TP |
---|
| 128 | \fB--start\fR |
---|
| 129 | Start a new server. |
---|
| 130 | |
---|
| 131 | .TP |
---|
| 132 | \fB--stop\fR |
---|
| 133 | Stop the currently running server. |
---|
| 134 | See also \fB--shutdown\fR. |
---|
| 135 | |
---|
| 136 | .TP |
---|
| 137 | \fB--restart\fR |
---|
| 138 | Stop the currently running server and start up a new server. |
---|
| 139 | |
---|
| 140 | .TP |
---|
| 141 | \fB--shutdown\fR |
---|
| 142 | Terminates the currently running server after last client has quit. |
---|
| 143 | This is the most clean way to shutdown a running server as it does not kick |
---|
| 144 | any clients. |
---|
| 145 | This option must not be confused with \fB--terminate\fR. |
---|
| 146 | |
---|
| 147 | .TP |
---|
| 148 | \fB--terminate\fR |
---|
| 149 | Auto terminates the new server after last client has quit. |
---|
| 150 | This option must not be confused with \fB--shutdown\fR. |
---|
| 151 | |
---|
[4860] | 152 | .TP |
---|
| 153 | \fB--script-postdown S\fR |
---|
| 154 | Run script S after server shutdown. |
---|
| 155 | The script is passed to a shell. |
---|
| 156 | Any shell feature can be used within the string. |
---|
| 157 | |
---|
[4570] | 158 | .SH "STANDBY MODE" |
---|
| 159 | .TP |
---|
| 160 | \fB--standby\fR |
---|
| 161 | Start in standby mode. |
---|
| 162 | |
---|
| 163 | .TP |
---|
| 164 | \fB--auto-standby\fR |
---|
| 165 | Go into standby mode if no streams are active. |
---|
| 166 | |
---|
| 167 | .SH "LOGGING" |
---|
| 168 | .TP |
---|
| 169 | \fB--verbose\fR |
---|
| 170 | Increment the verbosity level. Can be used multiple times. |
---|
| 171 | |
---|
| 172 | .TP |
---|
| 173 | \fB--log-syslog\fR |
---|
| 174 | Log to syslog. |
---|
| 175 | |
---|
| 176 | .SH "PLUGINS" |
---|
| 177 | .TP |
---|
[5275] | 178 | \fB--plugin-load FILENAME\fR |
---|
[4570] | 179 | Load the given plugin. |
---|
| 180 | |
---|
[5275] | 181 | .TP |
---|
| 182 | \fB--plugin-args ARGS\fR |
---|
| 183 | Arguments for the plugin. |
---|
[5399] | 184 | (must be given before the \-\-plugin-load). |
---|
[5275] | 185 | |
---|
[5592] | 186 | .TP |
---|
| 187 | \fB--list-plugins\fR |
---|
| 188 | List loaded plugins. |
---|
| 189 | |
---|
[4570] | 190 | .SH "SECURITY" |
---|
| 191 | |
---|
| 192 | .TP |
---|
[1113] | 193 | \fB--chroot DIR\fR |
---|
| 194 | Chroots to the given directory. This improves the security. This normally needs root privileg's. |
---|
| 195 | |
---|
| 196 | .SH "USER AND GROUPS" |
---|
| 197 | .TP |
---|
| 198 | \fB--setgid\fR |
---|
| 199 | Sets GroupID to the audio group as specified via \fB-G\fR. |
---|
| 200 | |
---|
| 201 | .TP |
---|
| 202 | \fB--setuid\fR |
---|
| 203 | Sets UserID to the audio user as specified via \fB-U\fR. |
---|
| 204 | |
---|
| 205 | .TP |
---|
| 206 | \fB-G GROUP\fR |
---|
| 207 | Sets the group for the UNIX Domain Socket, (default: audio) |
---|
| 208 | You need the permittions to change the GID. |
---|
| 209 | |
---|
| 210 | .TP |
---|
| 211 | \fB-U USER\fR |
---|
| 212 | Sets the user for the UNIX Domain Socket, (default: do not set) |
---|
| 213 | You need the permittions to change the UID (normaly only root has). |
---|
| 214 | |
---|
[4570] | 215 | .SH "AUTH OPTIONS" |
---|
[5159] | 216 | The following options control the access rights of connections. |
---|
| 217 | Some of them take an access level. The access level is one from the following list: |
---|
| 218 | .RS |
---|
[4570] | 219 | .TP |
---|
[5159] | 220 | \fBnone\fR |
---|
| 221 | This is used to disable an authentication method. |
---|
| 222 | |
---|
| 223 | .TP |
---|
| 224 | \fBidented\fR |
---|
| 225 | Used internally. Should not be used. |
---|
| 226 | |
---|
| 227 | .TP |
---|
| 228 | \fBconctl\fR |
---|
| 229 | The client is only allowed to do some basic operations only affecting it's own connection. |
---|
| 230 | |
---|
| 231 | .TP |
---|
| 232 | \fBguest\fR |
---|
| 233 | Guest access (read only). The client may list resources but not alter them. |
---|
| 234 | |
---|
| 235 | .TP |
---|
| 236 | \fBuser\fR |
---|
| 237 | Normal user. The client may create and alter most resources. |
---|
| 238 | |
---|
| 239 | .TP |
---|
| 240 | \fBpwruser\fR |
---|
| 241 | Power User. The client can create and alter all resources and do all operation but operations |
---|
| 242 | which would break the POSIX right system. The user is not allowed to control the server itself |
---|
| 243 | like terminating it or alter (system) resources with the rights of the user runnung roard. |
---|
| 244 | |
---|
| 245 | This is the access level a fully trusted user in a multi user setup should have. |
---|
| 246 | |
---|
| 247 | .TP |
---|
| 248 | \fBall\fR |
---|
| 249 | The client can do everything. This includes operations which may alter system resources (like files) |
---|
| 250 | with the rights of the user running roard. |
---|
| 251 | |
---|
| 252 | This accesslevel should be given to the user in case of a single user setup or root or some administrator |
---|
| 253 | in a multi user setup. |
---|
| 254 | .RE |
---|
| 255 | |
---|
| 256 | .TP |
---|
| 257 | \fB--guest-acclev ACCESSLEVEL\fR |
---|
[5146] | 258 | Sets the access level for guest connections. Set to "none" to disable guest access. |
---|
[4570] | 259 | |
---|
| 260 | .TP |
---|
[5159] | 261 | \fB--trust-acclev ACCESSLEVEL\fR |
---|
[4570] | 262 | Sets the access level for clients authenticated by trust auth. |
---|
[5146] | 263 | Set to "none" to disable trust auth. |
---|
[4570] | 264 | |
---|
| 265 | .TP |
---|
| 266 | \fB--trust-root\fR |
---|
| 267 | Trust root user. |
---|
| 268 | |
---|
| 269 | .TP |
---|
| 270 | \fB--no-trust-root\fR |
---|
| 271 | Do not trust root user. |
---|
[147] | 272 | |
---|
[4799] | 273 | .TP |
---|
| 274 | \fB--authfile-gen FILE\fR |
---|
| 275 | Generate a new authfile with a fresh cookie. |
---|
| 276 | |
---|
| 277 | .TP |
---|
| 278 | \fB--authfile-load FILE\fR |
---|
| 279 | Load all keys from a given authfile. |
---|
| 280 | |
---|
| 281 | .TP |
---|
| 282 | \fB--authfile-type TYPE\fR |
---|
| 283 | Sets the type for the authfile. |
---|
| 284 | |
---|
| 285 | .TP |
---|
| 286 | \fB--authfile-acclev ACCLEV\fR |
---|
| 287 | Sets the access level for the given authfile. |
---|
| 288 | |
---|
| 289 | .TP |
---|
| 290 | \fB--new-authfile\fR |
---|
| 291 | Add another authfile. |
---|
| 292 | |
---|
| 293 | |
---|
[147] | 294 | .SH "AUDIO OPTIONS" |
---|
| 295 | .TP |
---|
| 296 | \fB--rate RATE\fR, \fB-R RATE\fR |
---|
| 297 | Set server sample rate. |
---|
| 298 | |
---|
| 299 | .TP |
---|
| 300 | \fB--bits BITS\fR, \fB-B BITS\fR |
---|
| 301 | Set server bits. |
---|
| 302 | |
---|
| 303 | .TP |
---|
| 304 | \fB--chans CHANNELS\fR, \fB-C CHANNELS\fR |
---|
| 305 | Set server channels. |
---|
| 306 | |
---|
[4570] | 307 | .TP |
---|
| 308 | \fB--aiprofile PROFILE\fR |
---|
| 309 | Use a existing audio profile. |
---|
| 310 | |
---|
| 311 | .SH "GENERAL STREAM OPTIONS" |
---|
| 312 | .TP |
---|
| 313 | \fB--stream-flags\fR |
---|
| 314 | Sets default flags for a given stream directions. |
---|
| 315 | Examples: play=-meta, bidir=+antiecho |
---|
| 316 | |
---|
[147] | 317 | .SH "DRIVER OPTIONS" |
---|
[1113] | 318 | .TP |
---|
| 319 | \fB--list-driver\fR |
---|
| 320 | Shows a list of all available drivers. |
---|
[147] | 321 | |
---|
| 322 | .TP |
---|
| 323 | \fB--driver\fR, \fB-d\fR |
---|
[1189] | 324 | .\"Set the output driver. To get a list of all drivers use \fB--list-driver\fR. |
---|
| 325 | This option is obsolete. |
---|
| 326 | Use \fB-o\fR instead. |
---|
[147] | 327 | |
---|
| 328 | .TP |
---|
| 329 | \fB--device\fR, \fB-D\fR |
---|
[1189] | 330 | .\"Set the device for the output driver. Possible devices depends on the driver. |
---|
| 331 | .\"They may be a path to a device node or a hostname. |
---|
| 332 | .\"Use \fB--list-driver\fR to get a hint. |
---|
| 333 | .\"This option will obsolete soon. |
---|
| 334 | This option is obsolete. |
---|
| 335 | Use \fB-O\fR instead. |
---|
| 336 | |
---|
| 337 | .TP |
---|
| 338 | \fB--odriver\fR, \fB-o\fR |
---|
| 339 | Set the output driver. To get a list of all drivers use \fB--list-driver\fR. |
---|
| 340 | |
---|
| 341 | .TP |
---|
| 342 | \fB--odevice\fR, \fB-O\fR |
---|
[147] | 343 | Set the device for the output driver. Possible devices depends on the driver. |
---|
| 344 | They may be a path to a device node or a hostname. |
---|
[1113] | 345 | Use \fB--list-driver\fR to get a hint. |
---|
[1189] | 346 | |
---|
| 347 | .TP |
---|
| 348 | \fB-oO\fR |
---|
[1193] | 349 | Sets options for the new stream. See STREAM OPTIONS. |
---|
[1189] | 350 | |
---|
| 351 | .TP |
---|
| 352 | \fB-oN\fR |
---|
| 353 | Adds another output. |
---|
| 354 | |
---|
| 355 | .TP |
---|
| 356 | \fB-oP\fR |
---|
| 357 | Marks the output primary. |
---|
| 358 | |
---|
[1113] | 359 | |
---|
| 360 | .SH "SOURCE OPTIONS" |
---|
| 361 | .TP |
---|
[4570] | 362 | \fB--list-sources\fR |
---|
| 363 | List all supported sources. |
---|
| 364 | |
---|
| 365 | .TP |
---|
[1113] | 366 | \fB--source\fR, \fB-s\fR |
---|
| 367 | Adds a source of the given type. |
---|
| 368 | |
---|
| 369 | .TP |
---|
| 370 | \fB-S\fR |
---|
| 371 | Sets the device or filename for the source. Type may depend on the source type. |
---|
| 372 | |
---|
| 373 | .TP |
---|
| 374 | \fB-sO\fR |
---|
| 375 | Sets options for the current source. |
---|
| 376 | |
---|
| 377 | .TP |
---|
[1512] | 378 | \fB-sN\fR |
---|
| 379 | Adds another source. |
---|
| 380 | |
---|
| 381 | .TP |
---|
[1113] | 382 | \fB-sP\fR |
---|
| 383 | Marks the source as primary. If the source reaches EOF roard will quit automatically. |
---|
[147] | 384 | |
---|
[4570] | 385 | .SH "HARDWARE MIXER OPTIONS" |
---|
| 386 | .TP |
---|
| 387 | \fB--list-mixers\fR |
---|
| 388 | List all supported hardware mixers. |
---|
| 389 | |
---|
| 390 | .TP |
---|
| 391 | \fB--mixer\fR, \fB-m\fR |
---|
| 392 | Add a hardware mixer of given type. |
---|
| 393 | |
---|
| 394 | .TP |
---|
| 395 | \fB-M\fR |
---|
| 396 | Sets the device used for the hardware mixer. |
---|
| 397 | |
---|
| 398 | .TP |
---|
| 399 | \fB-mO\fR |
---|
| 400 | Sets options for the hardware mixer. |
---|
| 401 | See MIXER OPTIONS. |
---|
| 402 | |
---|
| 403 | .TP |
---|
| 404 | \fB-mN\fR |
---|
| 405 | Adds another hardware mixer. |
---|
| 406 | |
---|
| 407 | .TP |
---|
| 408 | \fB-mP\fR |
---|
| 409 | Marks the mixer primary. |
---|
| 410 | |
---|
| 411 | .SH "CODEC FILTER" |
---|
| 412 | .TP |
---|
| 413 | \fB--list-cf\fR |
---|
| 414 | List all supported codecfilters and codecs. |
---|
| 415 | |
---|
| 416 | .SH "MIDI OPTIONS" |
---|
| 417 | .TP |
---|
| 418 | \fB--midi-no-console\fR |
---|
| 419 | Disable console based MIDI synth. |
---|
| 420 | |
---|
| 421 | .TP |
---|
| 422 | \fB--midi-console-enable\fR |
---|
| 423 | Enables console based MIDI synth. |
---|
| 424 | |
---|
| 425 | .TP |
---|
| 426 | \fB--midi-console\fR |
---|
| 427 | Sets device for MIDI console. |
---|
| 428 | Example: /dev/console |
---|
| 429 | |
---|
| 430 | .TP |
---|
| 431 | \fB--ssynth-enable\fR |
---|
| 432 | Enables simple software synth. |
---|
| 433 | |
---|
| 434 | .TP |
---|
| 435 | \fB--ssynth-disable\fR |
---|
| 436 | Disables simple software synth. |
---|
| 437 | |
---|
| 438 | .SH "LIGHT CONTROL OPTIONS" |
---|
| 439 | .TP |
---|
| 440 | \fB--light-channels\fR |
---|
| 441 | Sets the number of light channels. |
---|
| 442 | Examples: 512, 1024 |
---|
| 443 | |
---|
| 444 | .SH "RADIO DATA SYSTEM OPTIONS" |
---|
| 445 | .TP |
---|
| 446 | \fB--rds-pi\fR |
---|
| 447 | Sets the Programme Identification (PI). |
---|
| 448 | |
---|
| 449 | .TP |
---|
| 450 | \fB--rds-ps\fR |
---|
| 451 | Sets the Programme Service Name (PS). |
---|
| 452 | |
---|
| 453 | .TP |
---|
| 454 | \fB--rds-pty\fR |
---|
| 455 | Sets the Programme Type (PTY). |
---|
| 456 | |
---|
| 457 | .TP |
---|
| 458 | \fB--rds-tp\fR |
---|
| 459 | Sets the Traffic Programme (TP) flag |
---|
| 460 | |
---|
| 461 | .TP |
---|
| 462 | \fB--rds-ct\fR |
---|
| 463 | Enables sending of RDS Clock Time (CT). |
---|
| 464 | |
---|
| 465 | .SH "X11 OPTIONS" |
---|
| 466 | .TP |
---|
| 467 | \fB--x11-display\fR, \fB--display\fR |
---|
| 468 | Sets the display to use. |
---|
| 469 | |
---|
| 470 | .TP |
---|
| 471 | \fB--x11\fR |
---|
| 472 | Enable X11 support. |
---|
| 473 | |
---|
[147] | 474 | .SH "NETWORK OPTIONS" |
---|
| 475 | .TP |
---|
| 476 | \fB--tcp\fR, \fB-t\fR |
---|
| 477 | Sets defaults for TCP/IP Socket. |
---|
| 478 | |
---|
| 479 | .TP |
---|
[4570] | 480 | \fB-4\fR, \fB-6\fR |
---|
| 481 | Use IPv4 or IPv6 mode. |
---|
| 482 | |
---|
| 483 | .TP |
---|
| 484 | \fB-64\fR |
---|
| 485 | Try to downgrade IPv6 sockets into IPv4 sockets. |
---|
| 486 | |
---|
| 487 | .TP |
---|
[147] | 488 | \fB--unix\fR, \fB-u\fR |
---|
| 489 | Sets defaults for UNIX Domain Socket. |
---|
| 490 | |
---|
| 491 | .TP |
---|
[1113] | 492 | \fB--decnet\fR, \fB-n\fR |
---|
| 493 | Sets defaults for DECnet Socket. |
---|
| 494 | |
---|
| 495 | .TP |
---|
[147] | 496 | \fB--port\fR, \fB-p\fR |
---|
| 497 | Sets the port the server should listen on. |
---|
| 498 | |
---|
| 499 | .TP |
---|
| 500 | \fB--bind\fR, \fB-b\fR, \fB--sock\fR |
---|
| 501 | Sets the hostname or path the server should listen on. |
---|
| 502 | |
---|
| 503 | .TP |
---|
[4570] | 504 | \fB--list-proto\fR |
---|
| 505 | List supported protocols. |
---|
| 506 | |
---|
| 507 | .TP |
---|
| 508 | \fB--proto\fR |
---|
| 509 | Sets the protocol used for the listening socket. |
---|
| 510 | |
---|
| 511 | .TP |
---|
| 512 | \fB--proto-dir\fR, \fB--proto-rate\fR, \fB--proto-bits\fR, \fB--proto-codec\fR, \fB--proto-chans\fR, \fB--proto-aiprofile\fR |
---|
| 513 | Set stream parameters for protocols needing stream options. |
---|
| 514 | Defaults to server defaults. |
---|
| 515 | |
---|
| 516 | .TP |
---|
| 517 | \fB--list-profiles\fR |
---|
| 518 | List supported profiles. |
---|
| 519 | |
---|
| 520 | \fB--proto-profile\fR |
---|
| 521 | Use the given profile for the listening socket. |
---|
| 522 | |
---|
| 523 | .TP |
---|
| 524 | \fB--new-sock\fR |
---|
| 525 | Adds a new listening socket. |
---|
| 526 | |
---|
| 527 | .TP |
---|
[1113] | 528 | \fB--no-listen\fR |
---|
[4013] | 529 | Do not listen for new clients (only useful for relaing, impleys \-\-terminate). |
---|
[1113] | 530 | |
---|
| 531 | .TP |
---|
| 532 | \fB--client-fh FH\fR |
---|
| 533 | Expects a client on the given FH. This may be useful with \fB--no-listen\fR. |
---|
| 534 | |
---|
| 535 | .TP |
---|
| 536 | \fB--close-fh FH\fR |
---|
| 537 | Close the given FH. This is not useful for endusers but used internaly. |
---|
[147] | 538 | |
---|
[4570] | 539 | .TP |
---|
| 540 | \fB--jumbo-mtu\fR |
---|
| 541 | Sets the MTU for Jambo Packets. |
---|
| 542 | |
---|
| 543 | .SH "OPENSLP OPTIONS" |
---|
| 544 | .TP |
---|
| 545 | \fB--slp\fR |
---|
| 546 | Enable OpenSLP support. |
---|
[147] | 547 | |
---|
[1193] | 548 | .SH "STREAM OPTIONS" |
---|
| 549 | .TP |
---|
| 550 | \fBrate\fR |
---|
| 551 | Sets the sample rate. |
---|
| 552 | |
---|
| 553 | .TP |
---|
| 554 | \fBchannels\fR |
---|
| 555 | Sets the number of channels. |
---|
| 556 | |
---|
| 557 | .TP |
---|
| 558 | \fBbits\fR |
---|
| 559 | Sets the number of bits per sample. |
---|
| 560 | |
---|
| 561 | .TP |
---|
| 562 | \fBcodec\fR |
---|
| 563 | Sets the codec. |
---|
| 564 | |
---|
| 565 | .TP |
---|
[1512] | 566 | \fBblocks\fR |
---|
| 567 | Sets the number of memory blocks that sould be used by the devices. |
---|
| 568 | Most devices only support a few values or don't support this option at all. |
---|
| 569 | If this option or the specifyed value is not supported by the device this is not |
---|
| 570 | handled as fatal error. |
---|
| 571 | |
---|
| 572 | .TP |
---|
[1525] | 573 | \fBblocksize\fR |
---|
| 574 | Sets the size of the memory blocks used by the device. |
---|
| 575 | Most devices only support a few values or don't support this option at all. |
---|
| 576 | If this option or the specifyed value is not supported by the device this is not |
---|
| 577 | handled as fatal error. |
---|
| 578 | |
---|
| 579 | .TP |
---|
[1193] | 580 | \fBmeta\fR |
---|
| 581 | Sets the meta flag. |
---|
| 582 | |
---|
| 583 | .TP |
---|
| 584 | \fBsync\fR |
---|
| 585 | Sets the sync flag. |
---|
| 586 | |
---|
| 587 | .TP |
---|
[1512] | 588 | \fBprimary\fR |
---|
| 589 | Marks this stream as primary. |
---|
| 590 | |
---|
| 591 | .TP |
---|
| 592 | \fBcleanmeta\fR |
---|
| 593 | Sets the cleanmeta flag. |
---|
| 594 | |
---|
| 595 | .TP |
---|
| 596 | \fBautoconf\fR |
---|
| 597 | Sets the autoconf flag. |
---|
| 598 | This flag is not supported by all drivers. |
---|
| 599 | If the flag is set and the devices does not support this there is no |
---|
| 600 | fatal error if the device could be opend with defaults. |
---|
| 601 | |
---|
| 602 | .TP |
---|
[1193] | 603 | Example: |
---|
| 604 | rate=44100,bits=16,channels=2,codec=pcm,sync |
---|
| 605 | |
---|
[4570] | 606 | .SH "MIXER OPTIONS" |
---|
| 607 | .TP |
---|
| 608 | \fRprimary\fR |
---|
| 609 | Makes this stream as primary. |
---|
| 610 | |
---|
| 611 | .TP |
---|
| 612 | \fBautoconf\fR |
---|
| 613 | Sets the autoconf flag. |
---|
| 614 | |
---|
| 615 | .TP |
---|
| 616 | \fBpassmixer\fR |
---|
| 617 | Sets the passmixer flag. |
---|
| 618 | |
---|
| 619 | .TP |
---|
| 620 | \fBname\fR |
---|
| 621 | Sets the name for the device. |
---|
| 622 | |
---|
| 623 | .TP |
---|
| 624 | \fBsubs\fR |
---|
| 625 | Sets list of subdevices. This is driver specific. |
---|
| 626 | |
---|
[147] | 627 | .SH "ENVIRONMENT VARIABLES" |
---|
| 628 | .TP |
---|
| 629 | \fBHOME\fR |
---|
| 630 | The users home directory. |
---|
| 631 | |
---|
| 632 | .TP |
---|
| 633 | \fBROAR_SERVER\fR |
---|
| 634 | The address of the listening server. This may be in form of host:port for TCP/IP connections |
---|
| 635 | and /path/to/sock for UNIX Domain Sockets. |
---|
| 636 | |
---|
| 637 | .TP |
---|
| 638 | \fBROAR_DRIVER\fR |
---|
| 639 | The driver to select. Same as \fB-d\fR. |
---|
| 640 | |
---|
| 641 | .TP |
---|
| 642 | \fBROAR_DEVICE\fR |
---|
| 643 | The device to select. Same as \fB-D\fR. |
---|
| 644 | |
---|
| 645 | .SH "BUGS" |
---|
[1113] | 646 | There are lots of bugs... |
---|
[147] | 647 | |
---|
| 648 | .SH "SEE ALSO" |
---|
| 649 | \fBroar-config\fR(1), |
---|
| 650 | \fBroarcat\fR(1), |
---|
| 651 | \fBroarcat2sock\fR(1), |
---|
| 652 | \fBroarcatad\fR(1), |
---|
| 653 | \fBroarctl\fR(1), |
---|
| 654 | \fBroarfilt\fR(1), |
---|
| 655 | \fBroarfish\fR(1), |
---|
| 656 | \fBroarmon\fR(1), |
---|
| 657 | \fBroarsockconnect\fR(1), |
---|
| 658 | \fBroartypes\fR(1), |
---|
| 659 | \fBroarvorbis\fR(1), |
---|
| 660 | \fBRoarAudio\fR(7). |
---|
| 661 | |
---|
| 662 | .SH "HISTORY" |
---|
| 663 | |
---|
| 664 | For history information see \fBRoarAudio\fR(7). |
---|
| 665 | |
---|
| 666 | .\" ll |
---|