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