[165] | 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 | |
---|
[1113] | 22 | .TP |
---|
[5159] | 23 | \fB--verbose\fR, \fB\-v\fR |
---|
[1113] | 24 | Be verbose. May be used multiple times. |
---|
| 25 | |
---|
[5159] | 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 | |
---|
[165] | 41 | .SH "NETWORK OPTIONS" |
---|
| 42 | .TP |
---|
| 43 | \fB--server SERVER\fR |
---|
| 44 | The server to connect to |
---|
| 45 | |
---|
[1113] | 46 | .SH "BASIC COMMANDS" |
---|
[165] | 47 | .TP |
---|
| 48 | \fBhelp\fR |
---|
| 49 | Same as \fB--help\fR. |
---|
| 50 | |
---|
| 51 | .TP |
---|
[5159] | 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 |
---|
[1204] | 60 | \fBsleep TIME\fR |
---|
| 61 | Sleeps for TIME seconds. |
---|
| 62 | |
---|
| 63 | .TP |
---|
[5159] | 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 |
---|
[5838] | 71 | \fBservername\fR |
---|
| 72 | This command shows the server address of the server currently connected to. |
---|
| 73 | This can be diffrent from what has given e.g. in case of special server |
---|
| 74 | names like +fork. |
---|
| 75 | |
---|
| 76 | .TP |
---|
[5159] | 77 | \fBwhoami\fR |
---|
| 78 | Report client ID of roarctl on the current server. |
---|
| 79 | |
---|
| 80 | .TP |
---|
[165] | 81 | \fBstandby\fR, \fBoff\fR, \fBresume\fR, \fBon\fR |
---|
[166] | 82 | Brings the server into standby mode or back into achtive (operating mode). |
---|
[165] | 83 | |
---|
| 84 | .TP |
---|
| 85 | \fBstandbymode\fR |
---|
[166] | 86 | Tells if the server is in standby mode or not. |
---|
[165] | 87 | |
---|
| 88 | .TP |
---|
| 89 | \fBexit\fR |
---|
[166] | 90 | Quits the server. |
---|
[165] | 91 | |
---|
| 92 | .TP |
---|
[1113] | 93 | \fBterminate\fR |
---|
| 94 | Terminates the server as soon as all clients disconnected and all streams reaches EOF. |
---|
| 95 | |
---|
| 96 | |
---|
| 97 | .SH "STREAM COMMANDS" |
---|
| 98 | .TP |
---|
[166] | 99 | \fBvolume STREAMID CHANNELS VOL0 VOL1 VOL2...\fR |
---|
| 100 | Sets the mixing level for a stream with id \fISTREAMID\fR. |
---|
| 101 | |
---|
| 102 | \fICHANNELS\fR is the nummber of channels to set volume. |
---|
| 103 | This should be the number of channels of the stream or a symbolic name. |
---|
| 104 | Currently the symbolic names \fBmono\fR and \fBstereo\fR are allowed. |
---|
| 105 | If you use \fBmono\fR all channels will get the level you give as |
---|
| 106 | \fIVOL0\fR. If you use \fBstereo\fR it will try to set the mixing levels |
---|
| 107 | as you are used from stereo setups even if the setup is not in stereo. |
---|
| 108 | |
---|
| 109 | The parameters \fIVOL0\fR ... \fIVOLn\fR and the number of them depends |
---|
| 110 | on what you gave as \fICHANNELS\fR. You have to give exactly \fICHANNELS\fR |
---|
| 111 | parameters. |
---|
| 112 | |
---|
| 113 | If you give a numerical (not symbolic) value for \fICHANNELS\fR and |
---|
| 114 | the stream does have a diffrent number of channels the behavor is undefined. |
---|
| 115 | In the current implementation only the first \fICHANNELS\fR channels will be updated. |
---|
| 116 | This behavor may change in the future. |
---|
[165] | 117 | |
---|
| 118 | .TP |
---|
[166] | 119 | \fBkick TYPE ID\fR |
---|
| 120 | Kicks an object of \fITYPE\fR with id \fIID\fR. |
---|
| 121 | Possible types are: \fBclient stream sample source\fR |
---|
| 122 | |
---|
| 123 | You can get the \fIID\fR via \fBlist*\fR (see bellow). |
---|
[165] | 124 | |
---|
[1124] | 125 | .TP |
---|
[5159] | 126 | \fBnewvirtual P D E R B C\fR |
---|
| 127 | Adds a new virtual (child) stream. |
---|
| 128 | This is used with container formats such as RAUM, Ogg and Matroska. |
---|
| 129 | |
---|
| 130 | |
---|
| 131 | Parameters: |
---|
| 132 | .RS |
---|
| 133 | .TP |
---|
| 134 | \fBP\fR |
---|
| 135 | Stream ID of \fBP\fRarent stream. |
---|
| 136 | .TP |
---|
| 137 | \fBD\fR |
---|
| 138 | Stream \fBD\fRirection. |
---|
| 139 | .TP |
---|
| 140 | \fBE\fR |
---|
| 141 | Stream cod\fBE\fRc. |
---|
| 142 | .TP |
---|
| 143 | \fBR\fR |
---|
| 144 | Sample \fBR\fRate. |
---|
| 145 | .TP |
---|
| 146 | \fBB\fR |
---|
| 147 | \fBB\fRits per sample. |
---|
| 148 | .TP |
---|
| 149 | \fBC\fR |
---|
| 150 | Number of \fBC\fRhannels. |
---|
| 151 | .RE |
---|
| 152 | |
---|
| 153 | .TP |
---|
| 154 | \fBflag ID FLAGS\fR, \fBunflag ID FLAGS\fR, \fBtoogleflag ID FLAGS\fR |
---|
| 155 | Sets, removes or toggles flags on a stream. ID is the stream id. |
---|
[4012] | 156 | FLAGS is a comma separated list of flags. |
---|
[1124] | 157 | |
---|
| 158 | It is not possible to set all kinds of flags at runtime. |
---|
| 159 | |
---|
[5159] | 160 | .TP |
---|
| 161 | \fBprotectflag ID FLAGS\fR |
---|
| 162 | Protects flags on a stream. ID is the stream id. |
---|
| 163 | FLAGS is a comma separated list of flags. |
---|
| 164 | |
---|
| 165 | Protected flags can not be changed anymore after the they got protected. |
---|
| 166 | |
---|
[1128] | 167 | .SH "META DATA COMMANDS" |
---|
| 168 | .TP |
---|
[5159] | 169 | \fBrole ID ROLE\fR |
---|
| 170 | Set stream role ROLE on stream ID. |
---|
| 171 | |
---|
| 172 | .TP |
---|
| 173 | \fBmetaget ID TYPE\fR |
---|
| 174 | Read meta date of type TYPE from stream ID. |
---|
| 175 | |
---|
| 176 | .TP |
---|
[1128] | 177 | \fBmetasave ID FILE\fR |
---|
| 178 | Saves the meta data of stream ID to file FILE. |
---|
| 179 | The Format is one KEY=Value pair per line. |
---|
| 180 | The same format is used by Xiph's tools. |
---|
| 181 | |
---|
| 182 | .TP |
---|
| 183 | \fBmetaload ID FILE\fR |
---|
| 184 | Load meta data from file FILE into stream ID. The format is the same |
---|
| 185 | as for \fBmetasave\fR. |
---|
| 186 | |
---|
[5159] | 187 | .SH "SERVER INFO COMMANDS" |
---|
| 188 | .TP |
---|
| 189 | \fBserverinfo\fR |
---|
| 190 | Gets general information about the server. |
---|
| 191 | This includes software vendor and version. |
---|
| 192 | |
---|
| 193 | .TP |
---|
| 194 | \fBservertime\fR |
---|
| 195 | Reports the server's system time. |
---|
| 196 | |
---|
| 197 | .TP |
---|
| 198 | \fBserverstandards\fR |
---|
| 199 | Report a list of standards the server supports. |
---|
| 200 | |
---|
| 201 | .TP |
---|
| 202 | \fBlibstandards\fR |
---|
| 203 | Similar to serverstandards, reports the list of standard libroar supports. |
---|
| 204 | Same as \fB--list-libstandards\fR. |
---|
| 205 | |
---|
[165] | 206 | .TP |
---|
| 207 | \fBserveroinfo\fR |
---|
[4012] | 208 | Gets Information about server output. |
---|
[165] | 209 | |
---|
| 210 | .TP |
---|
[4643] | 211 | \fBserveroinfo2 DIR\fR |
---|
| 212 | Gets Information about server output for a given direction. |
---|
| 213 | |
---|
[5159] | 214 | .SH "LISTING COMMANDS" |
---|
[4643] | 215 | .TP |
---|
[165] | 216 | \fBlistclients\fR |
---|
[4012] | 217 | Gets Information about clients. |
---|
[165] | 218 | |
---|
| 219 | .TP |
---|
[4818] | 220 | \fBclientinfo ID\fR |
---|
| 221 | Gets Information about client ID. |
---|
| 222 | |
---|
| 223 | .TP |
---|
[165] | 224 | \fBliststreams\fR |
---|
[4012] | 225 | Gets Information about streams. |
---|
[165] | 226 | |
---|
| 227 | .TP |
---|
[4818] | 228 | \fBstreaminfo ID\fR |
---|
| 229 | Gets Information about stream ID. |
---|
| 230 | |
---|
| 231 | .TP |
---|
[165] | 232 | \fBallinfo\fR |
---|
| 233 | Same as "\fBserveroinfo\fR \fBlistclients\fR \fBliststreams\fR". |
---|
| 234 | |
---|
| 235 | .SH "ENVIRONMENT VARIABLES" |
---|
| 236 | Bellow only the basic environment varibales are listend. |
---|
| 237 | For a complete list see \fBlibroar\fR(7). |
---|
| 238 | |
---|
| 239 | .TP |
---|
| 240 | \fBHOME\fR |
---|
| 241 | The users home directory. |
---|
| 242 | |
---|
| 243 | .TP |
---|
| 244 | \fBROAR_SERVER\fR |
---|
| 245 | The address of the listening server. This may be in form of host:port for TCP/IP connections |
---|
| 246 | and /path/to/sock for UNIX Domain Sockets. |
---|
| 247 | This is the same as the \fB--server\fR option. |
---|
| 248 | |
---|
| 249 | .SH "BUGS" |
---|
[167] | 250 | 1) Make the meta data commands api-fixed and list them here. |
---|
| 251 | |
---|
| 252 | 2) more often check if the user gave us enough arguments. |
---|
[165] | 253 | |
---|
| 254 | .SH "SEE ALSO" |
---|
| 255 | \fBroarvorbis\fR(1), |
---|
| 256 | \fBroarfish\fR(1), |
---|
| 257 | \fBroarbaseclients\fR(1), |
---|
| 258 | \fBroartestclients\fR(1), |
---|
| 259 | \fBlibroar\fR(7), |
---|
| 260 | \fBRoarAudio\fR(7). |
---|
| 261 | |
---|
| 262 | .SH "HISTORY" |
---|
| 263 | |
---|
| 264 | For history information see \fBRoarAudio\fR(7). |
---|
| 265 | |
---|
| 266 | .\" ll |
---|