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-v\fR |
---|
24 | Be verbose. May be used multiple times. |
---|
25 | |
---|
26 | .SH "NETWORK OPTIONS" |
---|
27 | .TP |
---|
28 | \fB--server SERVER\fR |
---|
29 | The server to connect to |
---|
30 | |
---|
31 | .SH "BASIC COMMANDS" |
---|
32 | .TP |
---|
33 | \fBhelp\fR |
---|
34 | Same as \fB--help\fR. |
---|
35 | |
---|
36 | .TP |
---|
37 | \fBstandby\fR, \fBoff\fR, \fBresume\fR, \fBon\fR |
---|
38 | Brings the server into standby mode or back into achtive (operating mode). |
---|
39 | |
---|
40 | .TP |
---|
41 | \fBstandbymode\fR |
---|
42 | Tells if the server is in standby mode or not. |
---|
43 | |
---|
44 | .TP |
---|
45 | \fBexit\fR |
---|
46 | Quits the server. |
---|
47 | |
---|
48 | .TP |
---|
49 | \fBterminate\fR |
---|
50 | Terminates the server as soon as all clients disconnected and all streams reaches EOF. |
---|
51 | |
---|
52 | |
---|
53 | .SH "STREAM COMMANDS" |
---|
54 | .TP |
---|
55 | \fBvolume STREAMID CHANNELS VOL0 VOL1 VOL2...\fR |
---|
56 | Sets the mixing level for a stream with id \fISTREAMID\fR. |
---|
57 | |
---|
58 | \fICHANNELS\fR is the nummber of channels to set volume. |
---|
59 | This should be the number of channels of the stream or a symbolic name. |
---|
60 | Currently the symbolic names \fBmono\fR and \fBstereo\fR are allowed. |
---|
61 | If you use \fBmono\fR all channels will get the level you give as |
---|
62 | \fIVOL0\fR. If you use \fBstereo\fR it will try to set the mixing levels |
---|
63 | as you are used from stereo setups even if the setup is not in stereo. |
---|
64 | |
---|
65 | The parameters \fIVOL0\fR ... \fIVOLn\fR and the number of them depends |
---|
66 | on what you gave as \fICHANNELS\fR. You have to give exactly \fICHANNELS\fR |
---|
67 | parameters. |
---|
68 | |
---|
69 | If you give a numerical (not symbolic) value for \fICHANNELS\fR and |
---|
70 | the stream does have a diffrent number of channels the behavor is undefined. |
---|
71 | In the current implementation only the first \fICHANNELS\fR channels will be updated. |
---|
72 | This behavor may change in the future. |
---|
73 | |
---|
74 | .TP |
---|
75 | \fBkick TYPE ID\fR |
---|
76 | Kicks an object of \fITYPE\fR with id \fIID\fR. |
---|
77 | Possible types are: \fBclient stream sample source\fR |
---|
78 | |
---|
79 | You can get the \fIID\fR via \fBlist*\fR (see bellow). |
---|
80 | |
---|
81 | .TP |
---|
82 | \fBflag ID FLAGS\fR, \fBunflag ID FLAGS\fR |
---|
83 | Sets or removes flags from a stream. ID is the stream id. |
---|
84 | FLAGS is a comma seperated list of flags. |
---|
85 | |
---|
86 | It is not possible to set all kinds of flags at runtime. |
---|
87 | |
---|
88 | .SH "META DATA COMMANDS" |
---|
89 | .TP |
---|
90 | \fBmetasave ID FILE\fR |
---|
91 | Saves the meta data of stream ID to file FILE. |
---|
92 | The Format is one KEY=Value pair per line. |
---|
93 | The same format is used by Xiph's tools. |
---|
94 | |
---|
95 | .TP |
---|
96 | \fBmetaload ID FILE\fR |
---|
97 | Load meta data from file FILE into stream ID. The format is the same |
---|
98 | as for \fBmetasave\fR. |
---|
99 | |
---|
100 | .SH "LISTING COMMANDS" |
---|
101 | .TP |
---|
102 | \fBserveroinfo\fR |
---|
103 | Gets Informations about server output. |
---|
104 | |
---|
105 | .TP |
---|
106 | \fBlistclients\fR |
---|
107 | Gets Informations about clients. |
---|
108 | |
---|
109 | .TP |
---|
110 | \fBliststreams\fR |
---|
111 | Gets Informations about streams. |
---|
112 | |
---|
113 | .TP |
---|
114 | \fBallinfo\fR |
---|
115 | Same as "\fBserveroinfo\fR \fBlistclients\fR \fBliststreams\fR". |
---|
116 | |
---|
117 | .SH "ENVIRONMENT VARIABLES" |
---|
118 | Bellow only the basic environment varibales are listend. |
---|
119 | For a complete list see \fBlibroar\fR(7). |
---|
120 | |
---|
121 | .TP |
---|
122 | \fBHOME\fR |
---|
123 | The users home directory. |
---|
124 | |
---|
125 | .TP |
---|
126 | \fBROAR_SERVER\fR |
---|
127 | The address of the listening server. This may be in form of host:port for TCP/IP connections |
---|
128 | and /path/to/sock for UNIX Domain Sockets. |
---|
129 | This is the same as the \fB--server\fR option. |
---|
130 | |
---|
131 | .SH "BUGS" |
---|
132 | 1) Make the meta data commands api-fixed and list them here. |
---|
133 | |
---|
134 | 2) more often check if the user gave us enough arguments. |
---|
135 | |
---|
136 | .SH "SEE ALSO" |
---|
137 | \fBroarvorbis\fR(1), |
---|
138 | \fBroarfish\fR(1), |
---|
139 | \fBroarbaseclients\fR(1), |
---|
140 | \fBroartestclients\fR(1), |
---|
141 | \fBlibroar\fR(7), |
---|
142 | \fBRoarAudio\fR(7). |
---|
143 | |
---|
144 | .SH "HISTORY" |
---|
145 | |
---|
146 | For history information see \fBRoarAudio\fR(7). |
---|
147 | |
---|
148 | .\" ll |
---|