X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached.3;h=ad603497ed35a03ddd53398655d91e41ec64ece9;hb=82f13dcb410d2f13b9b1f7b4d97925bd5bdcd5ef;hp=69e8bde4ab8976f1f7f80af9b206b711dc6f8fa6;hpb=e4e6bde654ddb9017f090f3a36d6e9f5fd70b354;p=awesomized%2Flibmemcached diff --git a/docs/man/memcached.3 b/docs/man/memcached.3 index 69e8bde4..ad603497 100644 --- 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" "July 05, 2012" "1.0.9" "libmemcached" .SH NAME memcached \- libmemcached Documentation . @@ -32,7 +32,11 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] . .SH SYNOPSIS .sp -#include +#include +.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="/?" +.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 @@ -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