source: roaraudio/doc/man1/roarctl.1 @ 165:d8cce810c032

Last change on this file since 165:d8cce810c032 was 165:d8cce810c032, checked in by phi, 16 years ago

added roarctl.1

File size: 1.5 KB
Line 
1.\" roard.1:
2
3.TH "roarctl" "1" "July 2008" "RoarAudio" "System Manager's Manual: roard"
4
5.SH NAME
6
7roarctl \- RoarAudio sound server controll tool
8
9.SH SYNOPSIS
10
11roarcat [OPTIONS]... COMMAND [OPTS] [COMMAND [OPTS] [COMMAND [OPTS] [...]]]
12
13.SH "DESCRIPTION"
14This tool controlls the RoarAudio's sound server.
15This is done by sending commands to the server. See \fBCOMMANDS\fR for a list.
16
17.SH "GENERAL OPTIONS"
18.TP
19\fB--help\fR
20Print some help text.
21
22.SH "NETWORK OPTIONS"
23.TP
24\fB--server SERVER\fR
25The server to connect to
26
27.SH "COMMANDS"
28.TP
29\fBhelp\fR
30Same as \fB--help\fR.
31
32.TP
33\fBstandby\fR, \fBoff\fR, \fBresume\fR, \fBon\fR
34
35.TP
36\fBstandbymode\fR
37
38.TP
39\fBexit\fR
40
41.TP
42\fBvolume\fR
43
44.TP
45\fBkick\fR
46
47.TP
48\fBserveroinfo\fR
49
50.TP
51\fBlistclients\fR
52
53.TP
54\fBliststreams\fR
55
56.TP
57\fBallinfo\fR
58Same as "\fBserveroinfo\fR \fBlistclients\fR \fBliststreams\fR".
59
60.SH "ENVIRONMENT VARIABLES"
61Bellow only the basic environment varibales are listend.
62For a complete list see \fBlibroar\fR(7).
63
64.TP
65\fBHOME\fR
66The users home directory.
67
68.TP
69\fBROAR_SERVER\fR
70The address of the listening server. This may be in form of host:port for TCP/IP connections
71and /path/to/sock for UNIX Domain Sockets.
72This is the same as the \fB--server\fR option.
73
74.SH "BUGS"
75There are a lot of bugs...
76
77.SH "SEE ALSO"
78\fBroarvorbis\fR(1),
79\fBroarfish\fR(1),
80\fBroarbaseclients\fR(1),
81\fBroartestclients\fR(1),
82\fBlibroar\fR(7),
83\fBRoarAudio\fR(7).
84
85.SH "HISTORY"
86
87For history information see \fBRoarAudio\fR(7).
88
89.\" ll
Note: See TracBrowser for help on using the repository browser.