1 | .\" roard.1: |
---|
2 | |
---|
3 | .TH "roarbaseclients" "1" "July 2008" "RoarAudio" "System Manager's Manual: roard" |
---|
4 | |
---|
5 | .SH NAME |
---|
6 | |
---|
7 | roarcat, roarmon, roarfilt \- RoarAudio sound server base clients |
---|
8 | |
---|
9 | .SH SYNOPSIS |
---|
10 | |
---|
11 | roarcat [OPTIONS]... [FILE] |
---|
12 | |
---|
13 | roarmon [OPTIONS]... |
---|
14 | |
---|
15 | roarfilt [OPTIONS]... |
---|
16 | |
---|
17 | .SH "DESCRIPTION" |
---|
18 | This are some basic clients for RoarAuido. Some more complex are listen in the \fbSEE ALSO\fR block. |
---|
19 | For controlling \fBroard\fR take a look at \fBroarctl\fR(1). For a simple Ogg Vorbis player |
---|
20 | take a look at \fBroarvorbis\fR(1) (ogg123 supportes RoarAudio via libao plugin). |
---|
21 | |
---|
22 | .TP |
---|
23 | \fBroarcat\fR |
---|
24 | Sends raw PCM audio data from a file or stdin (pipe) to the sound server. |
---|
25 | |
---|
26 | .TP |
---|
27 | \fBroarmon\fR |
---|
28 | Gets a copy of the audio data the server sends to the soundcard. This is usefull for streaming |
---|
29 | to a server like \fBicecast2\fR(1). |
---|
30 | |
---|
31 | .TP |
---|
32 | \fBroarfilt\fR |
---|
33 | This filters the audio data before they are send to the soundcard. |
---|
34 | |
---|
35 | .SH "GENERAL OPTIONS" |
---|
36 | \fBNOTE: This list is incomplete!\fR |
---|
37 | |
---|
38 | .TP |
---|
39 | \fB--help\fR |
---|
40 | Print some help text. |
---|
41 | |
---|
42 | .SH "AUDIO OPTIONS" |
---|
43 | .TP |
---|
44 | \fB--rate RATE\fR, \fB-R RATE\fR |
---|
45 | Set server sample rate. |
---|
46 | |
---|
47 | .TP |
---|
48 | \fB--bits BITS\fR, \fB-B BITS\fR |
---|
49 | Set server bits. |
---|
50 | |
---|
51 | .TP |
---|
52 | \fB--chans CHANNELS\fR, \fB-C CHANNELS\fR |
---|
53 | Set server channels. |
---|
54 | |
---|
55 | .SH "NETWORK OPTIONS" |
---|
56 | .TP |
---|
57 | \fB--server SERVER\fR |
---|
58 | The server to connect to. |
---|
59 | |
---|
60 | .SH "ROARFILT SPECIFIC OPTIONS" |
---|
61 | .TP |
---|
62 | \fB--half\fR |
---|
63 | Half the volume. |
---|
64 | |
---|
65 | .TP |
---|
66 | \fB--double\fR |
---|
67 | Double the volume. |
---|
68 | |
---|
69 | .TP |
---|
70 | \fB--amp n\fR |
---|
71 | Amplify volume by n. |
---|
72 | |
---|
73 | .TP |
---|
74 | \fB--mul n\fR |
---|
75 | |
---|
76 | .TP |
---|
77 | \fB--div n\fR |
---|
78 | |
---|
79 | .TP |
---|
80 | \fB--log n\fR |
---|
81 | Does a simple 'gamma correction'. |
---|
82 | This is done by: |
---|
83 | sample = 2^(bits-1) * log(1 + (n - 1)*sample/2^(bits-1)) / log(n). |
---|
84 | |
---|
85 | .SH "ENVIRONMENT VARIABLES" |
---|
86 | Bellow only the basic environment varibales are listend. |
---|
87 | For a complete list see \fBlibroar\fR(7). |
---|
88 | |
---|
89 | .TP |
---|
90 | \fBHOME\fR |
---|
91 | The users home directory. |
---|
92 | |
---|
93 | .TP |
---|
94 | \fBROAR_SERVER\fR |
---|
95 | The address of the listening server. This may be in form of host:port for TCP/IP connections |
---|
96 | and /path/to/sock for UNIX Domain Sockets or any other supported format. See \fBroartips\fR(7) |
---|
97 | for a full list. |
---|
98 | This is the same as the \fB--server\fR option. |
---|
99 | |
---|
100 | .SH "BUGS" |
---|
101 | There are a lot of bugs... |
---|
102 | |
---|
103 | .SH "SEE ALSO" |
---|
104 | \fBroarctl\fR(1), |
---|
105 | \fBroarvorbis\fR(1), |
---|
106 | \fBroarfish\fR(1), |
---|
107 | \fBroartestclients\fR(1), |
---|
108 | \fBroartips\fR(7), |
---|
109 | \fBlibroar\fR(7), |
---|
110 | \fBRoarAudio\fR(7). |
---|
111 | |
---|
112 | .SH "HISTORY" |
---|
113 | |
---|
114 | For history information see \fBRoarAudio\fR(7). |
---|
115 | |
---|
116 | .\" ll |
---|