Changeset 5032:b2c8bbc7907f in roaraudio for doc/man3/roar_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_connect.3 (modified) (3 diffs)

doc/man3/roar_connect.3

@@ -1 +1 @@
 .\" roar_simple_play.3:
 
-.TH "roar_connect" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"
+.TH "roar_connect" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio"
 
 .SH NAME
-roar_connect \- connects to RoarAudio's sound server
+roar_connect, roar_connect2 \- connects to RoarAudio's sound server
 
 .SH SYNOPSIS
@@ -11 +11 @@
 
 int roar_connect(struct roar_connection * con, char * server);
+int roar_connect2     (struct roar_connection * con, char * server, int flags, uint_least32_t timeout);
 
 .SH "DESCRIPTION"
 Connects to RoarAudio's sound server.
-This call just connects to the sound server without any auth or identify.
-Do not use this from end user applications. Use \fBroar_simple_connect\fR(3).
+This calls just connects to the sound server without any authentication or identify.
+Do not use this from end user applications. Use \fBroar_simple_connect\fR(3) or \fBroar_simple_connect2\fR(3).
 
 
@@ -26 +27 @@
 \fBserver\fR
 The server to connect to.
-This may be in form "host[:port]" (TCP/IP), "/path/to/sock" (UNIX Domain Socket) or any other supported.
-For a full list see \fBroartips\fR(7).
 
+.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"