| 1 | .\" roard.1: |
|---|
| 2 | |
|---|
| 3 | .TH "ROARD" "1" "July 2008" "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 RoarAudio central demon. It mixes up diffrent audio streams from it's clients to send them |
|---|
| 16 | as a single stream to the soundcard. |
|---|
| 17 | |
|---|
| 18 | .SH "GENERAL OPTIONS" |
|---|
| 19 | \fBNOTE: This list is incomplete!\fR |
|---|
| 20 | |
|---|
| 21 | .TP |
|---|
| 22 | \fB--help\fR |
|---|
| 23 | Print some help text. |
|---|
| 24 | |
|---|
| 25 | .TP |
|---|
| 26 | \fB--demon\fR |
|---|
| 27 | Go into background after startup. |
|---|
| 28 | |
|---|
| 29 | .TP |
|---|
| 30 | \fB--realtime\fR |
|---|
| 31 | Ask for higher priority. |
|---|
| 32 | |
|---|
| 33 | .SH "AUDIO OPTIONS" |
|---|
| 34 | .TP |
|---|
| 35 | \fB--rate RATE\fR, \fB-R RATE\fR |
|---|
| 36 | Set server sample rate. |
|---|
| 37 | |
|---|
| 38 | .TP |
|---|
| 39 | \fB--bits BITS\fR, \fB-B BITS\fR |
|---|
| 40 | Set server bits. |
|---|
| 41 | |
|---|
| 42 | .TP |
|---|
| 43 | \fB--chans CHANNELS\fR, \fB-C CHANNELS\fR |
|---|
| 44 | Set server channels. |
|---|
| 45 | |
|---|
| 46 | .SH "DRIVER OPTIONS" |
|---|
| 47 | |
|---|
| 48 | .TP |
|---|
| 49 | \fB--driver\fR, \fB-d\fR |
|---|
| 50 | Set the output driver. To get a list of all drivers use \fB-d list\fR. |
|---|
| 51 | |
|---|
| 52 | .TP |
|---|
| 53 | \fB--device\fR, \fB-D\fR |
|---|
| 54 | Set the device for the output driver. Possible devices depends on the driver. |
|---|
| 55 | They may be a path to a device node or a hostname. |
|---|
| 56 | Use \fB-d list\fR to get a hint. |
|---|
| 57 | |
|---|
| 58 | .SH "NETWORK OPTIONS" |
|---|
| 59 | .TP |
|---|
| 60 | \fB--tcp\fR, \fB-t\fR |
|---|
| 61 | Sets defaults for TCP/IP Socket. |
|---|
| 62 | |
|---|
| 63 | .TP |
|---|
| 64 | \fB--unix\fR, \fB-u\fR |
|---|
| 65 | Sets defaults for UNIX Domain Socket. |
|---|
| 66 | |
|---|
| 67 | .TP |
|---|
| 68 | \fB--port\fR, \fB-p\fR |
|---|
| 69 | Sets the port the server should listen on. |
|---|
| 70 | |
|---|
| 71 | .TP |
|---|
| 72 | \fB--bind\fR, \fB-b\fR, \fB--sock\fR |
|---|
| 73 | Sets the hostname or path the server should listen on. |
|---|
| 74 | |
|---|
| 75 | .TP |
|---|
| 76 | \fB-G GROUP\fR |
|---|
| 77 | Sets the group the UNIX Domain Socket should be \fBchgrp\fR(1)ed if UNIX Domain Socket is used. |
|---|
| 78 | Default group is "audio". |
|---|
| 79 | |
|---|
| 80 | |
|---|
| 81 | .SH "ENVIRONMENT VARIABLES" |
|---|
| 82 | .TP |
|---|
| 83 | \fBHOME\fR |
|---|
| 84 | The users home directory. |
|---|
| 85 | |
|---|
| 86 | .TP |
|---|
| 87 | \fBROAR_SERVER\fR |
|---|
| 88 | The address of the listening server. This may be in form of host:port for TCP/IP connections |
|---|
| 89 | and /path/to/sock for UNIX Domain Sockets. |
|---|
| 90 | |
|---|
| 91 | .TP |
|---|
| 92 | \fBROAR_DRIVER\fR |
|---|
| 93 | The driver to select. Same as \fB-d\fR. |
|---|
| 94 | |
|---|
| 95 | .TP |
|---|
| 96 | \fBROAR_DEVICE\fR |
|---|
| 97 | The device to select. Same as \fB-D\fR. |
|---|
| 98 | |
|---|
| 99 | .SH "BUGS" |
|---|
| 100 | There are a lot of bugs... |
|---|
| 101 | |
|---|
| 102 | .SH "SEE ALSO" |
|---|
| 103 | \fBroar-config\fR(1), |
|---|
| 104 | \fBroarcat\fR(1), |
|---|
| 105 | \fBroarcat2sock\fR(1), |
|---|
| 106 | \fBroarcatad\fR(1), |
|---|
| 107 | \fBroarctl\fR(1), |
|---|
| 108 | \fBroarfilt\fR(1), |
|---|
| 109 | \fBroarfish\fR(1), |
|---|
| 110 | \fBroarmon\fR(1), |
|---|
| 111 | \fBroarsockconnect\fR(1), |
|---|
| 112 | \fBroartypes\fR(1), |
|---|
| 113 | \fBroarvorbis\fR(1), |
|---|
| 114 | \fBRoarAudio\fR(7). |
|---|
| 115 | |
|---|
| 116 | .SH "HISTORY" |
|---|
| 117 | |
|---|
| 118 | For history information see \fBRoarAudio\fR(7). |
|---|
| 119 | |
|---|
| 120 | .\" ll |
|---|
