X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Flibmemcached_check_configuration.3;h=7363f94ad63b2d1fb172cc90fc531349f6985071;hb=11621e78bab29c7535bcdd52c3d8b3f10a150001;hp=e2f3f256e9401ab8ceb2f907606b0edc4c8be288;hpb=7f1777bbeaa41f71567f20350cb2555f2d9466da;p=m6w6%2Flibmemcached diff --git a/docs/man/libmemcached_check_configuration.3 b/docs/man/libmemcached_check_configuration.3 index e2f3f256..7363f94a 100644 --- a/docs/man/libmemcached_check_configuration.3 +++ b/docs/man/libmemcached_check_configuration.3 @@ -1,4 +1,4 @@ -.TH "LIBMEMCACHED_CHECK_CONFIGURATION" "3" "April 12, 2011" "0.47" "libmemcached" +.TH "LIBMEMCACHED_CHECK_CONFIGURATION" "3" "July 21, 2011" "0.51" "libmemcached" .SH NAME libmemcached_check_configuration \- libmemcached Documentation . @@ -31,9 +31,11 @@ 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_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 @@ -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,14 +269,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 +\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 .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); { ... } @@ -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