| 1 | .\" roard.1: |
|---|
| 2 | |
|---|
| 3 | .TH "roarbaseclients" "1" "July 2008" "RoarAudio" "System Manager's Manual: roard" |
|---|
| 4 | |
|---|
| 5 | .SH NAME |
|---|
| 6 | |
|---|
| 7 | roarcat, roarmon \- RoarAudio sound server base clients |
|---|
| 8 | |
|---|
| 9 | .SH SYNOPSIS |
|---|
| 10 | |
|---|
| 11 | roarcat [OPTIONS]... [FILE] |
|---|
| 12 | |
|---|
| 13 | roarmon [OPTIONS]... |
|---|
| 14 | |
|---|
| 15 | .SH "DESCRIPTION" |
|---|
| 16 | This are some basic clients for RoarAuido. Some more complex are listen in the \fbSEE ALSO\fR block. |
|---|
| 17 | For controlling \fBroard\fR take a look at \fBroarctl\fR(1). For a simple Ogg Vorbis player |
|---|
| 18 | take a look at \fBroarvorbis\fR(1) (ogg123 supportes RoarAudio via libao plugin). |
|---|
| 19 | |
|---|
| 20 | .TP |
|---|
| 21 | \fBroarcat\fR |
|---|
| 22 | Sends raw PCM audio data from a file or stdin (pipe) to the sound server. |
|---|
| 23 | |
|---|
| 24 | .TP |
|---|
| 25 | \fBroarmon\fR |
|---|
| 26 | Gets a copy of the audio data the server sends to the soundcard. This is useful for streaming |
|---|
| 27 | to a server like \fBicecast2\fR(1). |
|---|
| 28 | |
|---|
| 29 | .SH "GENERAL OPTIONS" |
|---|
| 30 | \fBNOTE: This list is incomplete!\fR |
|---|
| 31 | In addition to this list all three programs provide compatible |
|---|
| 32 | options for esdcat, esdmon. You can just replace the "esd" |
|---|
| 33 | in the name with "roar" or use symlinks. This options are for compatibly |
|---|
| 34 | only and should not used in new programs. |
|---|
| 35 | |
|---|
| 36 | .TP |
|---|
| 37 | \fB--help\fR |
|---|
| 38 | Print some help text. |
|---|
| 39 | |
|---|
| 40 | .SH "AUDIO OPTIONS" |
|---|
| 41 | .TP |
|---|
| 42 | \fB--rate RATE\fR, \fB-R RATE\fR |
|---|
| 43 | Set server sample rate. |
|---|
| 44 | |
|---|
| 45 | .TP |
|---|
| 46 | \fB--bits BITS\fR, \fB-B BITS\fR |
|---|
| 47 | Set server bits. |
|---|
| 48 | |
|---|
| 49 | .TP |
|---|
| 50 | \fB--chans CHANNELS\fR, \fB-C CHANNELS\fR |
|---|
| 51 | Set server channels. |
|---|
| 52 | |
|---|
| 53 | .SH "NETWORK OPTIONS" |
|---|
| 54 | .TP |
|---|
| 55 | \fB--server SERVER\fR |
|---|
| 56 | The server to connect to. |
|---|
| 57 | |
|---|
| 58 | .SH "ENVIRONMENT VARIABLES" |
|---|
| 59 | Bellow only the basic environment varibales are listend. |
|---|
| 60 | For a complete list see \fBlibroar\fR(7). |
|---|
| 61 | |
|---|
| 62 | .TP |
|---|
| 63 | \fBHOME\fR |
|---|
| 64 | The users home directory. |
|---|
| 65 | |
|---|
| 66 | .TP |
|---|
| 67 | \fBROAR_SERVER\fR |
|---|
| 68 | The address of the listening server. This may be in form of host:port for TCP/IP connections |
|---|
| 69 | and /path/to/sock for UNIX Domain Sockets or any other supported format. See \fBroartips\fR(7) |
|---|
| 70 | for a full list. |
|---|
| 71 | This is the same as the \fB--server\fR option. |
|---|
| 72 | |
|---|
| 73 | .SH "BUGS" |
|---|
| 74 | There are a lot of bugs... |
|---|
| 75 | |
|---|
| 76 | .SH "SEE ALSO" |
|---|
| 77 | \fBroarctl\fR(1), |
|---|
| 78 | \fBroarvorbis\fR(1), |
|---|
| 79 | \fBroarfish\fR(1), |
|---|
| 80 | \fBroartestclients\fR(1), |
|---|
| 81 | \fBroartips\fR(7), |
|---|
| 82 | \fBlibroar\fR(7), |
|---|
| 83 | \fBRoarAudio\fR(7). |
|---|
| 84 | |
|---|
| 85 | .SH "HISTORY" |
|---|
| 86 | |
|---|
| 87 | For history information see \fBRoarAudio\fR(7). |
|---|
| 88 | |
|---|
| 89 | .\" ll |
|---|
