Changeset 5032:b2c8bbc7907f in roaraudio for doc/man3/roar_simple_connect.3

Timestamp:

05/28/11 17:23:34 (13 years ago)

Author:

phi

Branch:

default

Phase:

public

Message:

some manpage correction

File:

• doc/man3/roar_simple_connect.3 (modified) (4 diffs)

doc/man3/roar_simple_connect.3

@@ -1 +1 @@
 .\" roar_simple_play.3:
 
-.TH "roar_simple_connect" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"
+.TH "roar_simple_connect" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio"
 
 .SH NAME
-roar_simple_connect \- Opens a connection to RoarAudio's sound server
+roar_simple_connect, roar_simple_connect2 \- Opens a connection to RoarAudio's sound server
 
 .SH SYNOPSIS
@@ -11 +11 @@
 
 int roar_simple_connect (struct roar_connection * con, char * server, char * name);
+int roar_simple_connect2(struct roar_connection * con, char * server, char * name, int flags, uint_least32_t timeout);
+
 
 .SH "DESCRIPTION"
-This call opens a connection to the RoarAudio's sound server. This is useful for controlling the server or
-update meta data of any kind. For simple playback see \fBroar_simple_play\fR(3).
+This calls opens a connection to the RoarAudio's sound server.
 To disconnect use \fBroar_disconnect\fR(3).
 
@@ -31 +32 @@
 The name of this client. Should be the name of the player without any paths or filenames.
 
+.TP
+\fBflags\fR
+Flags used to connect to the server. Currently only ROAR_ENUM_FLAG_NONE and ROAR_ENUM_FLAG_NONBLOCK are supported.
+ROAR_ENUM_FLAG_NONBLOCK disables some of the server location features.
+
+.TP
+\fBtimeout\fR
+Timeout for the connection. A value of zero means no timeout. Currently timeouts are not supported.
+
 .SH "RETURN VALUE"
 On success these calls return 0.  On error, \-1 is returned.
@@ -39 +49 @@
 .SH "SEE ALSO"
 \fBroar_disconnect\fR(3),
-\fBroar_simple_play\fR(3),
 \fBlibroar\fR(7),
 \fBRoarAudio\fR(7).