Changeset 1113:c4f7255f7b5d in roaraudio for doc

Timestamp:

01/14/09 18:42:40 (15 years ago)

Author:

phi

Branch:

default

Phase:

public

Message:

updated manpages a bit, mostly updated parameter lists

Location:

doc

Files:

• man1/roarctl.1 (modified) (4 diffs)
• man1/roard.1 (modified) (6 diffs)
• man3/roar_exit.3 (modified) (3 diffs)
• symlinks.src (modified) (1 diff)

doc/man1/roarctl.1

@@ -20 +20 @@
 Print some help text.
 
+.TP
+\fB-v\fR
+Be verbose. May be used multiple times.
+
 .SH "NETWORK OPTIONS"
 .TP
@@ -25 +29 @@
 The server to connect to
 
-.SH "COMMANDS"
+.SH "BASIC COMMANDS"
 .TP
 \fBhelp\fR
@@ -42 +46 @@
 Quits the server.
 
+.TP
+\fBterminate\fR
+Terminates the server as soon as all clients disconnected and all streams reaches EOF.
+
+
+.SH "STREAM COMMANDS"
 .TP
 \fBvolume STREAMID CHANNELS VOL0 VOL1 VOL2...\fR
@@ -69 +79 @@
 You can get the \fIID\fR via \fBlist*\fR (see bellow).
 
+.SH "LISTING COMMANDS"
 .TP
 \fBserveroinfo\fR

doc/man1/roard.1

@@ -29 +29 @@
 .TP
 \fB--realtime\fR
-Ask for higher priority.
+Ask for higher priority. May be used multiple times.
+
+.TP
+\fB--chroot DIR\fR
+Chroots to the given directory. This improves the security. This normally needs root privileg's.
+
+.SH "USER AND GROUPS"
+.TP
+\fB--setgid\fR
+Sets GroupID to the audio group as specified via \fB-G\fR.
+
+.TP
+\fB--setuid\fR
+Sets UserID to the audio user as specified via \fB-U\fR.
+
+.TP
+\fB-G GROUP\fR
+Sets the group for the UNIX Domain Socket, (default: audio)
+You need the permittions to change the GID.
+
+.TP
+\fB-U USER\fR
+Sets the user for the UNIX Domain Socket, (default: do not set)
+You need the permittions to change the UID (normaly only root has).
+
 
 .SH "AUDIO OPTIONS"
@@ -45 +69 @@
 
 .SH "DRIVER OPTIONS"
+.TP
+\fB--list-driver\fR
+Shows a list of all available drivers.
 
 .TP
 \fB--driver\fR, \fB-d\fR
-Set the output driver. To get a list of all drivers use \fB-d list\fR.
+Set the output driver. To get a list of all drivers use \fB--list-driver\fR.
+This option will obsolete soon.
 
 .TP
@@ -54 +82 @@
 Set the device for the output driver. Possible devices depends on the driver.
 They may be a path to a device node or a hostname.
-Use \fB-d list\fR to get a hint.
+Use \fB--list-driver\fR to get a hint.
+This option will obsolete soon.
+
+.SH "SOURCE OPTIONS"
+.TP
+\fB--source\fR, \fB-s\fR
+Adds a source of the given type.
+
+.TP
+\fB-S\fR
+Sets the device or filename for the source. Type may depend on the source type.
+
+.TP
+\fB-sO\fR
+Sets options for the current source.
+
+.TP
+\fB-sP\fR
+Marks the source as primary. If the source reaches EOF roard will quit automatically.
 
 .SH "NETWORK OPTIONS"
@@ -66 +112 @@
 
 .TP
+\fB--decnet\fR, \fB-n\fR
+Sets defaults for DECnet Socket.
+
+.TP
 \fB--port\fR, \fB-p\fR
 Sets the port the server should listen on.
@@ -74 +124 @@
 
 .TP
-\fB-G GROUP\fR
-Sets the group the UNIX Domain Socket should be \fBchgrp\fR(1)ed if UNIX Domain Socket is used.
-Default group is "audio".
+\fB--no-listen\fR
+Do not listen for new clients (only usefull for relaing, impleys --terminate).
+
+.TP
+\fB--client-fh FH\fR
+Expects a client on the given FH. This may be useful with \fB--no-listen\fR.
+
+.TP
+\fB--close-fh FH\fR
+Close the given FH. This is not useful for endusers but used internaly.
 
 
@@ -98 +155 @@
 
 .SH "BUGS"
-There are a lot of bugs...
+There are lots of bugs...
 
 .SH "SEE ALSO"

doc/man3/roar_exit.3

@@ -6 +6 @@
 roar_exit \- let RoarAudio's sound server quit
 
+roar_terminate \- let RoarAudio's sound server quit as soon as all clients quit
+
 .SH SYNOPSIS
 
@@ -12 +14 @@
 int roar_exit(struct roar_connection * con);
 
+int roar_terminate(struct roar_connection * con, int terminate);
+
 .SH "DESCRIPTION"
 Ask the sound server to quit.
+
+roar_exit() let the server quit ....
+
+roar_terminate() will let the server quit as soon as all clients disconnects
+and all input streams ended. The listening socket will be closed. This is useful
+in case of restarting roard.
 
 
@@ -20 +30 @@
 \fBcon\fR
 An open controll connection to the server.
+
+.TP
+\fBterminate\fR
+Wait for all clients to disconnect and all streams to EOF in case of 1.
+In case of 0 roar_terminate() is equal to roar_exit().
 
 .SH "RETURN VALUE"

doc/symlinks.src

@@ -13 +13 @@
 roar_simple_record              3       roar_simple_play        3
 roar_codec2str                  3       roar_str2codec          3
+roar_terminate                  3       roar_exit               3