source: roaraudio/doc/man1/roartestclients.1 @ 4107:c238b3bd2b17

Last change on this file since 4107:c238b3bd2b17 was 4012:28bea7336add, checked in by phi, 14 years ago

typos

File size: 2.1 KB
RevLine 
[162]1.\" roard.1:
2
3.TH "roartestclients" "1" "July 2008" "RoarAudio" "System Manager's Manual: roard"
4
5.SH NAME
6
7roarcat2sock, roarcatad, roarsin, roarsockconnect \- RoarAudio sound server test clients
8
9.SH SYNOPSIS
10
11roarcat2sock [OPTIONS]...
12
13roarcatad [OPTIONS]...
14
15roarsin
16
17roarsockconnect HOST PORT
18
19.SH "DESCRIPTION"
[4012]20This clients are primary for test perpose but may be useful for someone
[163]21or can be used as examples.
22
23.TP
24\fBroarcat2sock\fR
25This is the same as \fBroarcat\fR(1) but uses \fBroar_simple_new_stream\fR(3)
26to open the audio stream.
27
28.TP
29\fBroarcatad\fR
30This is also the same as \fBroarcat\fR(1) but uses \fBroar_stream_add_data\fR(3)
31to fill the server's input buffer.
32
33.TP
34\fBroarsin\fR
35This is the complete version of the sinus generator from \fBroartut\fR(7).
[4012]36It plays a 5 second middle C (523.2Hz) sine.
[163]37
38.TP
39\fBroarsockconnect\fB
40This is just a test tool connecting somewhere via \fBroar_socket_connect\fR(3).
41First the data of stdin is copied to the socket than the data from the socket to
42stdout. It's a very simlple semi-bi-directional version of \fBnetcat\fR(1).
[162]43
44.SH "GENERAL OPTIONS"
45\fBNOTE: This list is incomplete!\fR
46
47.TP
48\fB--help\fR
49Print some help text.
50
51.SH "AUDIO OPTIONS"
52.TP
53\fB--rate RATE\fR, \fB-R RATE\fR
54Set server sample rate.
55
56.TP
57\fB--bits BITS\fR, \fB-B BITS\fR
58Set server bits.
59
60.TP
61\fB--chans CHANNELS\fR, \fB-C CHANNELS\fR
62Set server channels.
63
64.SH "NETWORK OPTIONS"
65.TP
66\fB--server SERVER\fR
67The server to connect to
68
69.SH "ENVIRONMENT VARIABLES"
70Bellow only the basic environment varibales are listend.
71For a complete list see \fBlibroar\fR(7).
72
73.TP
74\fBHOME\fR
75The users home directory.
76
77.TP
78\fBROAR_SERVER\fR
79The address of the listening server. This may be in form of host:port for TCP/IP connections
[732]80and /path/to/sock for UNIX Domain Sockets. See \fBroartips\fR(7)
81for a full list.
[162]82This is the same as the \fB--server\fR option.
83
84.SH "BUGS"
85There are a lot of bugs...
86
87.SH "SEE ALSO"
88\fBroarctl\fR(1),
89\fBroarvorbis\fR(1),
90\fBroarfish\fR(1),
91\fBroarbaseclients\fR(1),
[732]92\fBroartips\fR(7),
[162]93\fBlibroar\fR(7),
94\fBRoarAudio\fR(7).
95
96.SH "HISTORY"
97
98For history information see \fBRoarAudio\fR(7).
99
100.\" ll
Note: See TracBrowser for help on using the repository browser.