Merging bzr://gaz.tangent.org/libmemcached/build/ to Build branch

[m6w6/libmemcached] / docs / man / memcached.3

diff --git a/docs/man/memcached.3 b/docs/man/memcached.3
index 9145d44409925018fb818a6e694d68d53a51b37e..2e144f0675e33eea43ccac5ad06bf3f5e9513eec 100644 (file)
--- a/docs/man/memcached.3
+++ b/docs/man/memcached.3
@@ -1,4 +1,4 @@
-.TH "MEMCACHED" "3" "April 13, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED" "3" "April 21, 2012" "1.0.6" "libmemcached"
 .SH NAME
 memcached \- libmemcached Documentation
 .
@@ -31,6 +31,8 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" Man page generated from reStructeredText.
 .
 .SH SYNOPSIS
+.sp
+#include <libmemcached/memcached.h>
 .INDENT 0.0
 .TP
 .B memcached_st *memcached(const char\fI\ *string\fP, size_t\fI\ string_length\fP)
@@ -44,7 +46,7 @@ Compile and link with \-lmemcached
 .SH DESCRIPTION
 .sp
 Libmemcached implements a custom language for configuring and modifying
-servers. By passing in an option string you can generate a memcached_st object
+servers. By passing in an option string you can generate a \fBmemcached_st\fP object
 that you can use in your application directly.
 .INDENT 0.0
 .TP
@@ -54,6 +56,12 @@ that you can use in your application directly.
 Provide a servername to be used by the client. Providing a weight will cause weighting to occur with all hosts with each server getting a default weight of 1.
 .INDENT 0.0
 .TP
+.B \-\-SOCKET="<filepath>/?<optional_weight>"
+.UNINDENT
+.sp
+Provide a filepath to a UNIX socket file. Providing a weight will cause weighting to occur with all hosts with each server getting a default weight of 1.
+.INDENT 0.0
+.TP
 .B \-\-VERIFY\-KEY
 .UNINDENT
 .sp
@@ -261,7 +269,7 @@ End configutation processing.
 End configutation processing and throw an error.
 .SH RETURN
 .sp
-memcached() returns a pointer to the memcached_st that was
+\fI\%memcached()\fP returns a pointer to the memcached_st that was
 created (or initialized).  On an allocation failure, it returns NULL.
 .SH EXAMPLE
 .sp
@@ -278,7 +286,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