Merge in man page updates.
[m6w6/libmemcached] / docs / man / libmemcached_configuration.3
index 6b0951c1e55a1321c586f0e2c4b560a4241e383e..3918f73588392be444c134b9db59ae1ab47ba54d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "LIBMEMCACHED_CONFIGURATION" "3" "April 11, 2011" "0.47" "libmemcached"
+.TH "LIBMEMCACHED_CONFIGURATION" "3" "April 14, 2011" "0.47" "libmemcached"
 .SH NAME
 libmemcached_configuration \- libmemcached Documentation
 .
@@ -33,7 +33,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .SH SYNOPSIS
 .INDENT 0.0
 .TP
-.B memcached_st *memcached_create_with_options(const char\fI\ *string\fP, size_t\fI\ string_length\fP)
+.B memcached_st *memcached(const char\fI\ *string\fP, size_t\fI\ string_length\fP)
 .UNINDENT
 .INDENT 0.0
 .TP
@@ -152,6 +152,19 @@ See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_USE_UDP
 A namespace is a container that provides context for keys, only other
 requests that know the namespace can access these values. This is
 accomplished by prepending the namespace value to all keys.
+.SS Mecached Pool Options:
+.INDENT 0.0
+.TP
+.B \-\-POOL\-MIN
+.UNINDENT
+.sp
+Initial size of pool.
+.INDENT 0.0
+.TP
+.B \-\-POOL\-MAX
+.UNINDENT
+.sp
+Maximize size of the pool.
 .SS I/O Options:
 .INDENT 0.0
 .TP
@@ -248,14 +261,14 @@ End configutation processing.
 End configutation processing and throw an error.
 .SH RETURN
 .sp
-memcached_create_with_options() returns a pointer to the memcached_st that was
+memcached() returns a pointer to the memcached_st that was
 created (or initialized).  On an allocation failure, it returns NULL.
 .SH EXAMPLE
 .sp
 .nf
 .ft C
 const char *config_string= "\-\-SERVER=host10.example.com \-\-SERVER=host11.example.com \-\-SERVER=host10.example.com"
-memcached_st *memc= memcached_create_with_options(config_string, strlen(config_string);
+memcached_st *memc= memcached(config_string, strlen(config_string);
 {
  ...
 }
@@ -265,7 +278,7 @@ memcached_free(memc);
 .SH HOME
 .sp
 To find out more information please check:
-\fI\%https://launchpad.net/libmemcached\fP
+\fI\%http://libmemcached.org/\fP
 .SH SEE ALSO
 .sp
 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP