.\" RoarAudio
.TH "libroar" "7" "June 2011" "RoarAudio" "System Manager's Manual: RoarAuido"

.SH NAME
libroar \- RoarAudio sound library

.SH SYNOPSIS

 #include <roaraudio.h>

.SH "DESCRIPTION"
\fBlibroar\fR is a central library used to comunicate with RoarAudio servers.
It supports all commands from simple commands to play some audio up to complex commands
to control the server and do nice things over the network.
It also includes several useful functions from buffer management to IO abstraction.


.SH "EXAMPLES"
The basic tools shipped with RoarAudio are designed to also work as examples for the lib.
You may start by looking at \fBroarcat\fR(1)s source code as an example on how to simply play back
some audio. A more complex example is \fBroarvorbis\fR(1) which also includes meta data updates.

You should also have a look at VS API, see \fBroarvs\fR(7) for a overview.

.SH "TUTORIALS"
Tutorials can be found in \fBroartut\fR(7).

.SH "ENVIRONMENT VARIABLES"
The following variables are used in libroar itself so they are common to all clients
using libroar.

.TP
\fBHOME\fR
The users home directory.

.TP
\fBROAR_SERVER\fR
The address of the listening server. This may be in form of host:port for TCP/IP connections
and /path/to/sock for UNIX Domain Sockets. If a value of '+fork' is given a roard is forked and used.
This roard will not listen on any sockets so it is used exclusiv by this client. See \fBroard\fR(1) for
more information.

.TP
\fBROAR_PROXY\fR
Set the type of the proxy being used to connect to the server.
Valid values are 'socks4', 'socks4a', 'socks4d', 'http' and 'ssh' for the moment.
You can add type depending options in form 'type/opts'.

.TP
\fBsocks_proxy\fR
The SOCKS4/4a/4d/5 proxy to use in form [user@]host[:port].
Default port is 9050.

.TP
\fBhttp_proxy\fR, \fBhttps_proxy\fR
The HTTP/HTTPS Proxy server. This server needs to understand the CONNECT request type.
Give the server name in this format: [http://]host[:port][/]
The default port is 8080.

.TP
\fBssh_proxy\fR
The remote host to use as SSH Proxy server.
Give the server name in this format: [user@]host[:port]
The default port is 22.
Note that you may need to use publickey based auth or ssh-agent because the application
may start SSH in a non interactive environment and SSH can not ask you for a password.


.SH "FILES"
.TP
\fB/etc/roarserver\fR
This is a symlink to the server socket.
If all types of server addresses are supported.
Example:
 ln \-s /tmp/roar /etc/roarserver
 ln \-s somehost /etc/roarserver
 ln \-s mynode:: /etc/roarserver

.SH "BUGS"
A lot...

.SH "SEE ALSO"
\fBroar-config\fR(1),
\fBroartypes\fR(1),
\fBroarvs\fR(7),
\fBroartut\fR(7),
\fBroard\fR(1),
\fBroartips\fR(7),
\fBRoarAudio\fR(7).

.SH "HISTORY"
See \fBRoarAudio\fR(7).

.\"ll