Changeset 164:f2a7aec1d04f in roaraudio

Timestamp:

07/19/08 22:57:12 (16 years ago)

Author:

phi

Branch:

default

Phase:

public

Message:

added descriptions and roarfilt specific options

File:

• doc/man1/roarbaseclients.1 (modified) (2 diffs)

doc/man1/roarbaseclients.1

@@ -16 +16 @@
 
 .SH "DESCRIPTION"
+This are some basic clients for RoarAuido. Some more complex are listen in the \fbSEE ALSO\fR block.
+For controlling \fBroard\fR take a look at \fBroarctl\fR(1). For a simple Ogg Vorbis player
+take a look at \fBroarvorbis\fR(1) (ogg123 supportes RoarAudio via libao plugin).
+
+.TP
+\fBroarcat\fR
+Sends raw PCM audio data from a file or stdin (pipe) to the sound server.
+
+.TP
+\fBroarmon\fR
+Gets a copy of the audio data the server sends to the soundcard. This is usefull for streaming
+to a server like \fBicecast2\fR(1).
+
+.TP
+\fBroarfilt\fR
+This filters the audio data before they are send to the soundcard.
 
 .SH "GENERAL OPTIONS"
@@ -41 +57 @@
 \fB--server SERVER\fR
 The server to connect to
+
+.SH "ROARFILT SPECIFIC OPTIONS"
+.TP
+\fB--half\fR
+Half the volume.
+
+.TP
+\fB--double\fR
+Double the volume.
+
+.TP
+\fB--amp n\fR
+Amplify volume by n.
+
+.TP
+\fB--mul n\fR
+
+.TP
+\fB--div n\fR
+
+.TP
+\fB--log n\fR
+Does a simple 'gamma correction'.
+This is done by:
+ sample = 2^(bits-1) * log(1 + (n - 1)*sample/2^(bits-1)) / log(n).
 
 .SH "ENVIRONMENT VARIABLES"