Line | |
---|
1 | .\" RoarAudio |
---|
2 | .TH "libroar" "7" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" |
---|
3 | |
---|
4 | .SH NAME |
---|
5 | libroar \- RoarAudio sound library |
---|
6 | |
---|
7 | .SH SYNOPSIS |
---|
8 | |
---|
9 | #include <roaraudio.h> |
---|
10 | |
---|
11 | .SH "DESCRIPTION" |
---|
12 | \fBlibroar\fR is the central library used to comunicate with the roard. |
---|
13 | It suppots all commands from simple commands to play some audio up to complex commands |
---|
14 | to controll the server and do nice things over the network. |
---|
15 | |
---|
16 | |
---|
17 | .SH "EXAMPLES" |
---|
18 | The basic tools shiped with RoarAudio are designed to also work as examples for the lib. |
---|
19 | You may start by looking at \fBroarcat\fR(1)s source code as an example on how to simply play back |
---|
20 | some audio. A more complex example is \fBroarvorbis\fR(1) which also includes meta data updates. |
---|
21 | |
---|
22 | .SH "TUTORIALS" |
---|
23 | Tutorials can be found in \fBroartut\fR(7). |
---|
24 | |
---|
25 | .SH "ENVIRONMENT VARIABLES" |
---|
26 | The following variables are used in libroar itself so they are common to all clients |
---|
27 | using libroar. |
---|
28 | |
---|
29 | .TP |
---|
30 | \fBHOME\fR |
---|
31 | The users home directory. |
---|
32 | |
---|
33 | .TP |
---|
34 | \fBROAR_SERVER\fR |
---|
35 | The address of the listening server. This may be in form of host:port for TCP/IP connections |
---|
36 | and /path/to/sock for UNIX Domain Sockets. If a value of '+fork' is given a roard is forked and used. |
---|
37 | This roard will not listen on any sockets so it is used exclusiv by this client. See \fBroard\fR(1) for |
---|
38 | more information. |
---|
39 | |
---|
40 | .TP |
---|
41 | \fBROAR_PROXY\fR |
---|
42 | Set the type of the proxy being used to connect to the server. |
---|
43 | The only valid value at the moment is 'socks4a'. Note that this is incompatible |
---|
44 | with SOCKS4 like OpenSSH supports it. |
---|
45 | |
---|
46 | .TP |
---|
47 | \fBsocks_proxy\fR |
---|
48 | The SOCKS4/4a/5 proxy to use in form host:port. |
---|
49 | |
---|
50 | |
---|
51 | .SH "BUGS" |
---|
52 | A lot... |
---|
53 | |
---|
54 | .SH "SEE ALSO" |
---|
55 | \fBroar-config\fR(1), |
---|
56 | \fBroartypes\fR(1), |
---|
57 | \fBroartut\fR(7), |
---|
58 | \fBroard\fR(1), |
---|
59 | \fBRoarAudio\fR(7). |
---|
60 | |
---|
61 | .SH "HISTORY" |
---|
62 | Project started in mid of 2008. |
---|
63 | |
---|
64 | .\"ll |
---|
Note: See
TracBrowser
for help on using the repository browser.