Update for release.

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

diff --git a/docs/man/memcached.3 b/docs/man/memcached.3
index 69e8bde4ab8976f1f7f80af9b206b711dc6f8fa6..c4fa6d4c80348c2707a88280b9762bec2ad674cb 100644 (file)
--- a/docs/man/memcached.3
+++ b/docs/man/memcached.3
@@ -1,4 +1,4 @@
-.TH "MEMCACHED" "3" "June 17, 2011" "0.49" "libmemcached"
+.TH "MEMCACHED" "3" "September 16, 2012" "1.0.10" "libmemcached"
 .SH NAME
 memcached \- libmemcached Documentation
 .
@@ -32,7 +32,11 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .
 .SH SYNOPSIS
 .sp
-#include <libmemcached/memcached.h>
+#include <libmemcached\-1.0/memcached.h>
+.INDENT 0.0
+.TP
+.B LIBMEMCACHED
+.UNINDENT
 .INDENT 0.0
 .TP
 .B memcached_st *memcached(const char\fI\ *string\fP, size_t\fI\ string_length\fP)
@@ -46,7 +50,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
@@ -56,6 +60,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
@@ -65,7 +75,7 @@ Verify that keys that are being used fit within the design of the protocol being
 .B \-\-REMOVE_FAILED_SERVERS
 .UNINDENT
 .sp
-Enable the behavior MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS.
+Enable the behavior \fBMEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS\fP.
 .INDENT 0.0
 .TP
 .B \-\-BINARY\-PROTOCOL
@@ -77,7 +87,7 @@ Force all connections to use the binary protocol.
 .B \-\-BUFFER\-REQUESTS
 .UNINDENT
 .sp
-Enable MEMCACHED_BEHAVIOR_BUFFER_REQUESTS.
+Please see \fBMEMCACHED_BEHAVIOR_BUFFER_REQUESTS\fP.
 .INDENT 0.0
 .TP
 .B \-\-CONFIGURE\-FILE=
@@ -89,7 +99,7 @@ Provide a configuration file to be used to load requests. Beware that by using a
 .B \-\-CONNECT\-TIMEOUT=
 .UNINDENT
 .sp
-Enable MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT.
+Please see \fBMEMCACHED_BEHAVIOR_CONNECT_TIMEOUT\fP.
 .INDENT 0.0
 .TP
 .B \-\-DISTRIBUTION=
@@ -139,13 +149,13 @@ When adding new servers always calculate their distribution based on sorted nami
 .B \-\-SUPPORT\-CAS
 .UNINDENT
 .sp
-See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SUPPORT_CAS
+See \fImemcached_behavior_set(3)\fP for \fBMEMCACHED_BEHAVIOR_SUPPORT_CAS\fP
 .INDENT 0.0
 .TP
 .B \-\-USE\-UDP
 .UNINDENT
 .sp
-See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_USE_UDP
+See \fImemcached_behavior_set(3)\fP for \fBMEMCACHED_BEHAVIOR_USE_UDP\fP
 .INDENT 0.0
 .TP
 .B \-\-NAMESPACE=
@@ -263,7 +273,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
@@ -287,7 +297,7 @@ To find out more information please check:
 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT
-2011, Brian Aker DataDifferential, http://datadifferential.com/
+2011-2012, Brian Aker DataDifferential, http://datadifferential.com/
 .\" Generated by docutils manpage writer.
 .\" 
 .