source: roaraudio/doc/man1/roarbaseclients.1 @ 1624:252d81db5aa7

Last change on this file since 1624:252d81db5aa7 was 1624:252d81db5aa7, checked in by phi, 15 years ago

removed roarfilt from baseclients manpage

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