Changeset 1113:c4f7255f7b5d in roaraudio for doc/man3

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

File:

• doc/man3/roar_exit.3 (modified) (3 diffs)

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"