X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached.3;h=696ba96bc70850a48af22c5ecbe4ece2b9e5ec72;hb=bb79afb7484c21ee590a15399e2e8a39cca7b627;hp=302545f664e270be270a06adcafc30cd9c2ee27f;hpb=86be0943416087ba738c28ddbde8cdcbd62ad777;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached.3 b/docs/man/memcached.3 index 302545f6..2e144f06 100644 --- 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 .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="/?" +.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