1 | .\" RoarAudio |
---|
2 | .TH "libroar" "7" "November 2010" "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 RoarAudio servers. |
---|
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 | It also includes several useful functions from buffer mangement to IO abstraction. |
---|
16 | |
---|
17 | |
---|
18 | .SH "EXAMPLES" |
---|
19 | The basic tools shiped with RoarAudio are designed to also work as examples for the lib. |
---|
20 | You may start by looking at \fBroarcat\fR(1)s source code as an example on how to simply play back |
---|
21 | some audio. A more complex example is \fBroarvorbis\fR(1) which also includes meta data updates. |
---|
22 | |
---|
23 | .SH "TUTORIALS" |
---|
24 | Tutorials can be found in \fBroartut\fR(7). |
---|
25 | |
---|
26 | .SH "ENVIRONMENT VARIABLES" |
---|
27 | The following variables are used in libroar itself so they are common to all clients |
---|
28 | using libroar. |
---|
29 | |
---|
30 | .TP |
---|
31 | \fBHOME\fR |
---|
32 | The users home directory. |
---|
33 | |
---|
34 | .TP |
---|
35 | \fBROAR_SERVER\fR |
---|
36 | The address of the listening server. This may be in form of host:port for TCP/IP connections |
---|
37 | and /path/to/sock for UNIX Domain Sockets. If a value of '+fork' is given a roard is forked and used. |
---|
38 | This roard will not listen on any sockets so it is used exclusiv by this client. See \fBroard\fR(1) for |
---|
39 | more information. |
---|
40 | |
---|
41 | .TP |
---|
42 | \fBROAR_PROXY\fR |
---|
43 | Set the type of the proxy being used to connect to the server. |
---|
44 | Valid values are 'socks4', 'socks4a', 'socks4d', 'http' and 'ssh' for the moment. |
---|
45 | You can add type depending options in form 'type/opts'. |
---|
46 | |
---|
47 | .TP |
---|
48 | \fBsocks_proxy\fR |
---|
49 | The SOCKS4/4a/4d/5 proxy to use in form [user@]host[:port]. |
---|
50 | Default port is 9050. |
---|
51 | |
---|
52 | .TP |
---|
53 | \fBhttp_proxy\fR, \fBhttps_proxy\fR |
---|
54 | The HTTP/HTTPS Proxy server. This server needs to understand the CONNECT request type. |
---|
55 | Give the server name in this format: [http://]host[:port][/] |
---|
56 | The default port is 8080. |
---|
57 | |
---|
58 | .TP |
---|
59 | \fBssh_proxy\fR |
---|
60 | The remote host to use as SSH Proxy server. |
---|
61 | Give the server name in this format: [user@]host[:port] |
---|
62 | The default port is 22. |
---|
63 | Note that you may need to use publickey based auth or ssh-agent because the application |
---|
64 | may start SSH in a non interactive environment and SSH can not ask you for a password. |
---|
65 | |
---|
66 | |
---|
67 | .SH "FILES" |
---|
68 | .TP |
---|
69 | \fB/etc/roarserver\fR |
---|
70 | This is a symlink to the server socket. |
---|
71 | If all types of server addresses are supported. |
---|
72 | Example: |
---|
73 | ln \-s /tmp/roar /etc/roarserver |
---|
74 | ln \-s somehost /etc/roarserver |
---|
75 | ln \-s mynode:: /etc/roarserver |
---|
76 | |
---|
77 | .SH "BUGS" |
---|
78 | A lot... |
---|
79 | |
---|
80 | .SH "SEE ALSO" |
---|
81 | \fBroar-config\fR(1), |
---|
82 | \fBroartypes\fR(1), |
---|
83 | \fBroartut\fR(7), |
---|
84 | \fBroard\fR(1), |
---|
85 | \fBroartips\fR(7), |
---|
86 | \fBRoarAudio\fR(7). |
---|
87 | |
---|
88 | .SH "HISTORY" |
---|
89 | Project started in mid of 2008. |
---|
90 | |
---|
91 | .\"ll |
---|