[147] | 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 | |
---|
[775] | 15 | \fBroard\fR is the RoarAudio central daemon. It mixes up diffrent audio streams from it's clients to send them |
---|
[147] | 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 |
---|
[775] | 26 | \fB--daemon\fR |
---|
[147] | 27 | Go into background after startup. |
---|
| 28 | |
---|
| 29 | .TP |
---|
| 30 | \fB--realtime\fR |
---|
[1113] | 31 | Ask for higher priority. May be used multiple times. |
---|
| 32 | |
---|
| 33 | .TP |
---|
| 34 | \fB--chroot DIR\fR |
---|
| 35 | Chroots to the given directory. This improves the security. This normally needs root privileg's. |
---|
| 36 | |
---|
| 37 | .SH "USER AND GROUPS" |
---|
| 38 | .TP |
---|
| 39 | \fB--setgid\fR |
---|
| 40 | Sets GroupID to the audio group as specified via \fB-G\fR. |
---|
| 41 | |
---|
| 42 | .TP |
---|
| 43 | \fB--setuid\fR |
---|
| 44 | Sets UserID to the audio user as specified via \fB-U\fR. |
---|
| 45 | |
---|
| 46 | .TP |
---|
| 47 | \fB-G GROUP\fR |
---|
| 48 | Sets the group for the UNIX Domain Socket, (default: audio) |
---|
| 49 | You need the permittions to change the GID. |
---|
| 50 | |
---|
| 51 | .TP |
---|
| 52 | \fB-U USER\fR |
---|
| 53 | Sets the user for the UNIX Domain Socket, (default: do not set) |
---|
| 54 | You need the permittions to change the UID (normaly only root has). |
---|
| 55 | |
---|
[147] | 56 | |
---|
| 57 | .SH "AUDIO OPTIONS" |
---|
| 58 | .TP |
---|
| 59 | \fB--rate RATE\fR, \fB-R RATE\fR |
---|
| 60 | Set server sample rate. |
---|
| 61 | |
---|
| 62 | .TP |
---|
| 63 | \fB--bits BITS\fR, \fB-B BITS\fR |
---|
| 64 | Set server bits. |
---|
| 65 | |
---|
| 66 | .TP |
---|
| 67 | \fB--chans CHANNELS\fR, \fB-C CHANNELS\fR |
---|
| 68 | Set server channels. |
---|
| 69 | |
---|
| 70 | .SH "DRIVER OPTIONS" |
---|
[1113] | 71 | .TP |
---|
| 72 | \fB--list-driver\fR |
---|
| 73 | Shows a list of all available drivers. |
---|
[147] | 74 | |
---|
| 75 | .TP |
---|
| 76 | \fB--driver\fR, \fB-d\fR |
---|
[1189] | 77 | .\"Set the output driver. To get a list of all drivers use \fB--list-driver\fR. |
---|
| 78 | This option is obsolete. |
---|
| 79 | Use \fB-o\fR instead. |
---|
[147] | 80 | |
---|
| 81 | .TP |
---|
| 82 | \fB--device\fR, \fB-D\fR |
---|
[1189] | 83 | .\"Set the device for the output driver. Possible devices depends on the driver. |
---|
| 84 | .\"They may be a path to a device node or a hostname. |
---|
| 85 | .\"Use \fB--list-driver\fR to get a hint. |
---|
| 86 | .\"This option will obsolete soon. |
---|
| 87 | This option is obsolete. |
---|
| 88 | Use \fB-O\fR instead. |
---|
| 89 | |
---|
| 90 | .TP |
---|
| 91 | \fB--odriver\fR, \fB-o\fR |
---|
| 92 | Set the output driver. To get a list of all drivers use \fB--list-driver\fR. |
---|
| 93 | |
---|
| 94 | .TP |
---|
| 95 | \fB--odevice\fR, \fB-O\fR |
---|
[147] | 96 | Set the device for the output driver. Possible devices depends on the driver. |
---|
| 97 | They may be a path to a device node or a hostname. |
---|
[1113] | 98 | Use \fB--list-driver\fR to get a hint. |
---|
[1189] | 99 | |
---|
| 100 | .TP |
---|
| 101 | \fB-oO\fR |
---|
[1193] | 102 | Sets options for the new stream. See STREAM OPTIONS. |
---|
[1189] | 103 | |
---|
| 104 | .TP |
---|
| 105 | \fB-oN\fR |
---|
| 106 | Adds another output. |
---|
| 107 | |
---|
| 108 | .TP |
---|
| 109 | \fB-oP\fR |
---|
| 110 | Marks the output primary. |
---|
| 111 | |
---|
[1113] | 112 | |
---|
| 113 | .SH "SOURCE OPTIONS" |
---|
| 114 | .TP |
---|
| 115 | \fB--source\fR, \fB-s\fR |
---|
| 116 | Adds a source of the given type. |
---|
| 117 | |
---|
| 118 | .TP |
---|
| 119 | \fB-S\fR |
---|
| 120 | Sets the device or filename for the source. Type may depend on the source type. |
---|
| 121 | |
---|
| 122 | .TP |
---|
| 123 | \fB-sO\fR |
---|
| 124 | Sets options for the current source. |
---|
| 125 | |
---|
| 126 | .TP |
---|
[1512] | 127 | \fB-sN\fR |
---|
| 128 | Adds another source. |
---|
| 129 | |
---|
| 130 | .TP |
---|
[1113] | 131 | \fB-sP\fR |
---|
| 132 | Marks the source as primary. If the source reaches EOF roard will quit automatically. |
---|
[147] | 133 | |
---|
| 134 | .SH "NETWORK OPTIONS" |
---|
| 135 | .TP |
---|
| 136 | \fB--tcp\fR, \fB-t\fR |
---|
| 137 | Sets defaults for TCP/IP Socket. |
---|
| 138 | |
---|
| 139 | .TP |
---|
| 140 | \fB--unix\fR, \fB-u\fR |
---|
| 141 | Sets defaults for UNIX Domain Socket. |
---|
| 142 | |
---|
| 143 | .TP |
---|
[1113] | 144 | \fB--decnet\fR, \fB-n\fR |
---|
| 145 | Sets defaults for DECnet Socket. |
---|
| 146 | |
---|
| 147 | .TP |
---|
[147] | 148 | \fB--port\fR, \fB-p\fR |
---|
| 149 | Sets the port the server should listen on. |
---|
| 150 | |
---|
| 151 | .TP |
---|
| 152 | \fB--bind\fR, \fB-b\fR, \fB--sock\fR |
---|
| 153 | Sets the hostname or path the server should listen on. |
---|
| 154 | |
---|
| 155 | .TP |
---|
[1113] | 156 | \fB--no-listen\fR |
---|
| 157 | Do not listen for new clients (only usefull for relaing, impleys --terminate). |
---|
| 158 | |
---|
| 159 | .TP |
---|
| 160 | \fB--client-fh FH\fR |
---|
| 161 | Expects a client on the given FH. This may be useful with \fB--no-listen\fR. |
---|
| 162 | |
---|
| 163 | .TP |
---|
| 164 | \fB--close-fh FH\fR |
---|
| 165 | Close the given FH. This is not useful for endusers but used internaly. |
---|
[147] | 166 | |
---|
| 167 | |
---|
[1193] | 168 | .SH "STREAM OPTIONS" |
---|
| 169 | .TP |
---|
| 170 | \fBrate\fR |
---|
| 171 | Sets the sample rate. |
---|
| 172 | |
---|
| 173 | .TP |
---|
| 174 | \fBchannels\fR |
---|
| 175 | Sets the number of channels. |
---|
| 176 | |
---|
| 177 | .TP |
---|
| 178 | \fBbits\fR |
---|
| 179 | Sets the number of bits per sample. |
---|
| 180 | |
---|
| 181 | .TP |
---|
| 182 | \fBcodec\fR |
---|
| 183 | Sets the codec. |
---|
| 184 | |
---|
| 185 | .TP |
---|
[1512] | 186 | \fBblocks\fR |
---|
| 187 | Sets the number of memory blocks that sould be used by the devices. |
---|
| 188 | Most devices only support a few values or don't support this option at all. |
---|
| 189 | If this option or the specifyed value is not supported by the device this is not |
---|
| 190 | handled as fatal error. |
---|
| 191 | |
---|
| 192 | .TP |
---|
[1525] | 193 | \fBblocksize\fR |
---|
| 194 | Sets the size of the memory blocks used by the device. |
---|
| 195 | Most devices only support a few values or don't support this option at all. |
---|
| 196 | If this option or the specifyed value is not supported by the device this is not |
---|
| 197 | handled as fatal error. |
---|
| 198 | |
---|
| 199 | .TP |
---|
[1193] | 200 | \fBmeta\fR |
---|
| 201 | Sets the meta flag. |
---|
| 202 | |
---|
| 203 | .TP |
---|
| 204 | \fBsync\fR |
---|
| 205 | Sets the sync flag. |
---|
| 206 | |
---|
| 207 | .TP |
---|
[1512] | 208 | \fBprimary\fR |
---|
| 209 | Marks this stream as primary. |
---|
| 210 | |
---|
| 211 | .TP |
---|
| 212 | \fBcleanmeta\fR |
---|
| 213 | Sets the cleanmeta flag. |
---|
| 214 | |
---|
| 215 | .TP |
---|
| 216 | \fBautoconf\fR |
---|
| 217 | Sets the autoconf flag. |
---|
| 218 | This flag is not supported by all drivers. |
---|
| 219 | If the flag is set and the devices does not support this there is no |
---|
| 220 | fatal error if the device could be opend with defaults. |
---|
| 221 | |
---|
| 222 | .TP |
---|
[1193] | 223 | Example: |
---|
| 224 | rate=44100,bits=16,channels=2,codec=pcm,sync |
---|
| 225 | |
---|
[147] | 226 | .SH "ENVIRONMENT VARIABLES" |
---|
| 227 | .TP |
---|
| 228 | \fBHOME\fR |
---|
| 229 | The users home directory. |
---|
| 230 | |
---|
| 231 | .TP |
---|
| 232 | \fBROAR_SERVER\fR |
---|
| 233 | The address of the listening server. This may be in form of host:port for TCP/IP connections |
---|
| 234 | and /path/to/sock for UNIX Domain Sockets. |
---|
| 235 | |
---|
| 236 | .TP |
---|
| 237 | \fBROAR_DRIVER\fR |
---|
| 238 | The driver to select. Same as \fB-d\fR. |
---|
| 239 | |
---|
| 240 | .TP |
---|
| 241 | \fBROAR_DEVICE\fR |
---|
| 242 | The device to select. Same as \fB-D\fR. |
---|
| 243 | |
---|
| 244 | .SH "BUGS" |
---|
[1113] | 245 | There are lots of bugs... |
---|
[147] | 246 | |
---|
| 247 | .SH "SEE ALSO" |
---|
| 248 | \fBroar-config\fR(1), |
---|
| 249 | \fBroarcat\fR(1), |
---|
| 250 | \fBroarcat2sock\fR(1), |
---|
| 251 | \fBroarcatad\fR(1), |
---|
| 252 | \fBroarctl\fR(1), |
---|
| 253 | \fBroarfilt\fR(1), |
---|
| 254 | \fBroarfish\fR(1), |
---|
| 255 | \fBroarmon\fR(1), |
---|
| 256 | \fBroarsockconnect\fR(1), |
---|
| 257 | \fBroartypes\fR(1), |
---|
| 258 | \fBroarvorbis\fR(1), |
---|
| 259 | \fBRoarAudio\fR(7). |
---|
| 260 | |
---|
| 261 | .SH "HISTORY" |
---|
| 262 | |
---|
| 263 | For history information see \fBRoarAudio\fR(7). |
---|
| 264 | |
---|
| 265 | .\" ll |
---|