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 daemon. 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--daemon\fR |
---|
27 | Go into background after startup. |
---|
28 | |
---|
29 | .TP |
---|
30 | \fB--realtime\fR |
---|
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 | |
---|
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" |
---|
71 | .TP |
---|
72 | \fB--list-driver\fR |
---|
73 | Shows a list of all available drivers. |
---|
74 | |
---|
75 | .TP |
---|
76 | \fB--driver\fR, \fB-d\fR |
---|
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. |
---|
80 | |
---|
81 | .TP |
---|
82 | \fB--device\fR, \fB-D\fR |
---|
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 |
---|
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. |
---|
98 | Use \fB--list-driver\fR to get a hint. |
---|
99 | |
---|
100 | .TP |
---|
101 | \fB-oO\fR |
---|
102 | Sets options for the new stream. See STREAM OPTIONS. |
---|
103 | |
---|
104 | .TP |
---|
105 | \fB-oN\fR |
---|
106 | Adds another output. |
---|
107 | |
---|
108 | .TP |
---|
109 | \fB-oP\fR |
---|
110 | Marks the output primary. |
---|
111 | |
---|
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 |
---|
127 | \fB-sP\fR |
---|
128 | Marks the source as primary. If the source reaches EOF roard will quit automatically. |
---|
129 | |
---|
130 | .SH "NETWORK OPTIONS" |
---|
131 | .TP |
---|
132 | \fB--tcp\fR, \fB-t\fR |
---|
133 | Sets defaults for TCP/IP Socket. |
---|
134 | |
---|
135 | .TP |
---|
136 | \fB--unix\fR, \fB-u\fR |
---|
137 | Sets defaults for UNIX Domain Socket. |
---|
138 | |
---|
139 | .TP |
---|
140 | \fB--decnet\fR, \fB-n\fR |
---|
141 | Sets defaults for DECnet Socket. |
---|
142 | |
---|
143 | .TP |
---|
144 | \fB--port\fR, \fB-p\fR |
---|
145 | Sets the port the server should listen on. |
---|
146 | |
---|
147 | .TP |
---|
148 | \fB--bind\fR, \fB-b\fR, \fB--sock\fR |
---|
149 | Sets the hostname or path the server should listen on. |
---|
150 | |
---|
151 | .TP |
---|
152 | \fB--no-listen\fR |
---|
153 | Do not listen for new clients (only usefull for relaing, impleys --terminate). |
---|
154 | |
---|
155 | .TP |
---|
156 | \fB--client-fh FH\fR |
---|
157 | Expects a client on the given FH. This may be useful with \fB--no-listen\fR. |
---|
158 | |
---|
159 | .TP |
---|
160 | \fB--close-fh FH\fR |
---|
161 | Close the given FH. This is not useful for endusers but used internaly. |
---|
162 | |
---|
163 | |
---|
164 | .SH "STREAM OPTIONS" |
---|
165 | .TP |
---|
166 | \fBrate\fR |
---|
167 | Sets the sample rate. |
---|
168 | |
---|
169 | .TP |
---|
170 | \fBchannels\fR |
---|
171 | Sets the number of channels. |
---|
172 | |
---|
173 | .TP |
---|
174 | \fBbits\fR |
---|
175 | Sets the number of bits per sample. |
---|
176 | |
---|
177 | .TP |
---|
178 | \fBcodec\fR |
---|
179 | Sets the codec. |
---|
180 | |
---|
181 | .TP |
---|
182 | \fBmeta\fR |
---|
183 | Sets the meta flag. |
---|
184 | |
---|
185 | .TP |
---|
186 | \fBsync\fR |
---|
187 | Sets the sync flag. |
---|
188 | |
---|
189 | .TP |
---|
190 | Example: |
---|
191 | rate=44100,bits=16,channels=2,codec=pcm,sync |
---|
192 | |
---|
193 | .SH "ENVIRONMENT VARIABLES" |
---|
194 | .TP |
---|
195 | \fBHOME\fR |
---|
196 | The users home directory. |
---|
197 | |
---|
198 | .TP |
---|
199 | \fBROAR_SERVER\fR |
---|
200 | The address of the listening server. This may be in form of host:port for TCP/IP connections |
---|
201 | and /path/to/sock for UNIX Domain Sockets. |
---|
202 | |
---|
203 | .TP |
---|
204 | \fBROAR_DRIVER\fR |
---|
205 | The driver to select. Same as \fB-d\fR. |
---|
206 | |
---|
207 | .TP |
---|
208 | \fBROAR_DEVICE\fR |
---|
209 | The device to select. Same as \fB-D\fR. |
---|
210 | |
---|
211 | .SH "BUGS" |
---|
212 | There are lots of bugs... |
---|
213 | |
---|
214 | .SH "SEE ALSO" |
---|
215 | \fBroar-config\fR(1), |
---|
216 | \fBroarcat\fR(1), |
---|
217 | \fBroarcat2sock\fR(1), |
---|
218 | \fBroarcatad\fR(1), |
---|
219 | \fBroarctl\fR(1), |
---|
220 | \fBroarfilt\fR(1), |
---|
221 | \fBroarfish\fR(1), |
---|
222 | \fBroarmon\fR(1), |
---|
223 | \fBroarsockconnect\fR(1), |
---|
224 | \fBroartypes\fR(1), |
---|
225 | \fBroarvorbis\fR(1), |
---|
226 | \fBRoarAudio\fR(7). |
---|
227 | |
---|
228 | .SH "HISTORY" |
---|
229 | |
---|
230 | For history information see \fBRoarAudio\fR(7). |
---|
231 | |
---|
232 | .\" ll |
---|