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