source: roaraudio/doc/man7/libroar.7 @ 4013:abd38c189de7

Last change on this file since 4013:abd38c189de7 was 4013:abd38c189de7, checked in by phi, 14 years ago

some manpage fixes

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