1 | .\" roard.1: |
---|
2 | |
---|
3 | .TH "roarctl" "1" "July 2008" "RoarAudio" "System Manager's Manual: roard" |
---|
4 | |
---|
5 | .SH NAME |
---|
6 | |
---|
7 | roarctl \- RoarAudio sound server controll tool |
---|
8 | |
---|
9 | .SH SYNOPSIS |
---|
10 | |
---|
11 | roarcat [OPTIONS]... COMMAND [OPTS] [COMMAND [OPTS] [COMMAND [OPTS] [...]]] |
---|
12 | |
---|
13 | .SH "DESCRIPTION" |
---|
14 | This tool controlls the RoarAudio's sound server. |
---|
15 | This is done by sending commands to the server. See \fBCOMMANDS\fR for a list. |
---|
16 | |
---|
17 | .SH "GENERAL OPTIONS" |
---|
18 | .TP |
---|
19 | \fB--help\fR |
---|
20 | Print some help text. |
---|
21 | |
---|
22 | .TP |
---|
23 | \fB--verbose\fR, \fB\-v\fR |
---|
24 | Be verbose. May be used multiple times. |
---|
25 | |
---|
26 | .TP |
---|
27 | \fB--list-libstandards\fR |
---|
28 | Similar to serverstandards, reports the list of standard libroar supports. |
---|
29 | |
---|
30 | .TP |
---|
31 | \fB--list-aiprofiles\fR |
---|
32 | Show audio info profiles and exit. |
---|
33 | |
---|
34 | .TP |
---|
35 | \fB--enum-servers\fR |
---|
36 | List servers found on the network. |
---|
37 | Depending on the build options of libroar this includes results from many tests |
---|
38 | like standard server locations, OpenSLP located servers, X11 located servers, |
---|
39 | DECnet's neighbor and IP's ARP table and other sources. |
---|
40 | |
---|
41 | .SH "NETWORK OPTIONS" |
---|
42 | .TP |
---|
43 | \fB--server SERVER\fR |
---|
44 | The server to connect to |
---|
45 | |
---|
46 | .SH "BASIC COMMANDS" |
---|
47 | .TP |
---|
48 | \fBhelp\fR |
---|
49 | Same as \fB--help\fR. |
---|
50 | |
---|
51 | .TP |
---|
52 | \fBlistaiprofiles\fR |
---|
53 | List audio info profiles. |
---|
54 | |
---|
55 | .TP |
---|
56 | \fBaiprofileget PROFILE\fR |
---|
57 | Display a the given audio info profile. |
---|
58 | |
---|
59 | .TP |
---|
60 | \fBsleep TIME\fR |
---|
61 | Sleeps for TIME seconds. |
---|
62 | |
---|
63 | .TP |
---|
64 | \fBping NUM\fR |
---|
65 | Pings the server NUM times. This is done by sending NOOP commands to the server. |
---|
66 | The response time as well as as a small statistics section is printed. |
---|
67 | |
---|
68 | This is not supported on all platforms. |
---|
69 | |
---|
70 | .TP |
---|
71 | \fBwhoami\fR |
---|
72 | Report client ID of roarctl on the current server. |
---|
73 | |
---|
74 | .TP |
---|
75 | \fBstandby\fR, \fBoff\fR, \fBresume\fR, \fBon\fR |
---|
76 | Brings the server into standby mode or back into achtive (operating mode). |
---|
77 | |
---|
78 | .TP |
---|
79 | \fBstandbymode\fR |
---|
80 | Tells if the server is in standby mode or not. |
---|
81 | |
---|
82 | .TP |
---|
83 | \fBexit\fR |
---|
84 | Quits the server. |
---|
85 | |
---|
86 | .TP |
---|
87 | \fBterminate\fR |
---|
88 | Terminates the server as soon as all clients disconnected and all streams reaches EOF. |
---|
89 | |
---|
90 | |
---|
91 | .SH "STREAM COMMANDS" |
---|
92 | .TP |
---|
93 | \fBvolume STREAMID CHANNELS VOL0 VOL1 VOL2...\fR |
---|
94 | Sets the mixing level for a stream with id \fISTREAMID\fR. |
---|
95 | |
---|
96 | \fICHANNELS\fR is the nummber of channels to set volume. |
---|
97 | This should be the number of channels of the stream or a symbolic name. |
---|
98 | Currently the symbolic names \fBmono\fR and \fBstereo\fR are allowed. |
---|
99 | If you use \fBmono\fR all channels will get the level you give as |
---|
100 | \fIVOL0\fR. If you use \fBstereo\fR it will try to set the mixing levels |
---|
101 | as you are used from stereo setups even if the setup is not in stereo. |
---|
102 | |
---|
103 | The parameters \fIVOL0\fR ... \fIVOLn\fR and the number of them depends |
---|
104 | on what you gave as \fICHANNELS\fR. You have to give exactly \fICHANNELS\fR |
---|
105 | parameters. |
---|
106 | |
---|
107 | If you give a numerical (not symbolic) value for \fICHANNELS\fR and |
---|
108 | the stream does have a diffrent number of channels the behavor is undefined. |
---|
109 | In the current implementation only the first \fICHANNELS\fR channels will be updated. |
---|
110 | This behavor may change in the future. |
---|
111 | |
---|
112 | .TP |
---|
113 | \fBkick TYPE ID\fR |
---|
114 | Kicks an object of \fITYPE\fR with id \fIID\fR. |
---|
115 | Possible types are: \fBclient stream sample source\fR |
---|
116 | |
---|
117 | You can get the \fIID\fR via \fBlist*\fR (see bellow). |
---|
118 | |
---|
119 | .TP |
---|
120 | \fBnewvirtual P D E R B C\fR |
---|
121 | Adds a new virtual (child) stream. |
---|
122 | This is used with container formats such as RAUM, Ogg and Matroska. |
---|
123 | |
---|
124 | |
---|
125 | Parameters: |
---|
126 | .RS |
---|
127 | .TP |
---|
128 | \fBP\fR |
---|
129 | Stream ID of \fBP\fRarent stream. |
---|
130 | .TP |
---|
131 | \fBD\fR |
---|
132 | Stream \fBD\fRirection. |
---|
133 | .TP |
---|
134 | \fBE\fR |
---|
135 | Stream cod\fBE\fRc. |
---|
136 | .TP |
---|
137 | \fBR\fR |
---|
138 | Sample \fBR\fRate. |
---|
139 | .TP |
---|
140 | \fBB\fR |
---|
141 | \fBB\fRits per sample. |
---|
142 | .TP |
---|
143 | \fBC\fR |
---|
144 | Number of \fBC\fRhannels. |
---|
145 | .RE |
---|
146 | |
---|
147 | .TP |
---|
148 | \fBflag ID FLAGS\fR, \fBunflag ID FLAGS\fR, \fBtoogleflag ID FLAGS\fR |
---|
149 | Sets, removes or toggles flags on a stream. ID is the stream id. |
---|
150 | FLAGS is a comma separated list of flags. |
---|
151 | |
---|
152 | It is not possible to set all kinds of flags at runtime. |
---|
153 | |
---|
154 | .TP |
---|
155 | \fBprotectflag ID FLAGS\fR |
---|
156 | Protects flags on a stream. ID is the stream id. |
---|
157 | FLAGS is a comma separated list of flags. |
---|
158 | |
---|
159 | Protected flags can not be changed anymore after the they got protected. |
---|
160 | |
---|
161 | .SH "META DATA COMMANDS" |
---|
162 | .TP |
---|
163 | \fBrole ID ROLE\fR |
---|
164 | Set stream role ROLE on stream ID. |
---|
165 | |
---|
166 | .TP |
---|
167 | \fBmetaget ID TYPE\fR |
---|
168 | Read meta date of type TYPE from stream ID. |
---|
169 | |
---|
170 | .TP |
---|
171 | \fBmetasave ID FILE\fR |
---|
172 | Saves the meta data of stream ID to file FILE. |
---|
173 | The Format is one KEY=Value pair per line. |
---|
174 | The same format is used by Xiph's tools. |
---|
175 | |
---|
176 | .TP |
---|
177 | \fBmetaload ID FILE\fR |
---|
178 | Load meta data from file FILE into stream ID. The format is the same |
---|
179 | as for \fBmetasave\fR. |
---|
180 | |
---|
181 | .SH "SERVER INFO COMMANDS" |
---|
182 | .TP |
---|
183 | \fBserverinfo\fR |
---|
184 | Gets general information about the server. |
---|
185 | This includes software vendor and version. |
---|
186 | |
---|
187 | .TP |
---|
188 | \fBservertime\fR |
---|
189 | Reports the server's system time. |
---|
190 | |
---|
191 | .TP |
---|
192 | \fBserverstandards\fR |
---|
193 | Report a list of standards the server supports. |
---|
194 | |
---|
195 | .TP |
---|
196 | \fBlibstandards\fR |
---|
197 | Similar to serverstandards, reports the list of standard libroar supports. |
---|
198 | Same as \fB--list-libstandards\fR. |
---|
199 | |
---|
200 | .TP |
---|
201 | \fBserveroinfo\fR |
---|
202 | Gets Information about server output. |
---|
203 | |
---|
204 | .TP |
---|
205 | \fBserveroinfo2 DIR\fR |
---|
206 | Gets Information about server output for a given direction. |
---|
207 | |
---|
208 | .SH "LISTING COMMANDS" |
---|
209 | .TP |
---|
210 | \fBlistclients\fR |
---|
211 | Gets Information about clients. |
---|
212 | |
---|
213 | .TP |
---|
214 | \fBclientinfo ID\fR |
---|
215 | Gets Information about client ID. |
---|
216 | |
---|
217 | .TP |
---|
218 | \fBliststreams\fR |
---|
219 | Gets Information about streams. |
---|
220 | |
---|
221 | .TP |
---|
222 | \fBstreaminfo ID\fR |
---|
223 | Gets Information about stream ID. |
---|
224 | |
---|
225 | .TP |
---|
226 | \fBallinfo\fR |
---|
227 | Same as "\fBserveroinfo\fR \fBlistclients\fR \fBliststreams\fR". |
---|
228 | |
---|
229 | .SH "ENVIRONMENT VARIABLES" |
---|
230 | Bellow only the basic environment varibales are listend. |
---|
231 | For a complete list see \fBlibroar\fR(7). |
---|
232 | |
---|
233 | .TP |
---|
234 | \fBHOME\fR |
---|
235 | The users home directory. |
---|
236 | |
---|
237 | .TP |
---|
238 | \fBROAR_SERVER\fR |
---|
239 | The address of the listening server. This may be in form of host:port for TCP/IP connections |
---|
240 | and /path/to/sock for UNIX Domain Sockets. |
---|
241 | This is the same as the \fB--server\fR option. |
---|
242 | |
---|
243 | .SH "BUGS" |
---|
244 | 1) Make the meta data commands api-fixed and list them here. |
---|
245 | |
---|
246 | 2) more often check if the user gave us enough arguments. |
---|
247 | |
---|
248 | .SH "SEE ALSO" |
---|
249 | \fBroarvorbis\fR(1), |
---|
250 | \fBroarfish\fR(1), |
---|
251 | \fBroarbaseclients\fR(1), |
---|
252 | \fBroartestclients\fR(1), |
---|
253 | \fBlibroar\fR(7), |
---|
254 | \fBRoarAudio\fR(7). |
---|
255 | |
---|
256 | .SH "HISTORY" |
---|
257 | |
---|
258 | For history information see \fBRoarAudio\fR(7). |
---|
259 | |
---|
260 | .\" ll |
---|