X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Flibmemcached_configuration.3;h=2a1287c64786f12362de4acf331fb33cf2114701;hb=bb79afb7484c21ee590a15399e2e8a39cca7b627;hp=dac97b939e4167fb4af39e943e2a822ac16e47e5;hpb=30e386cd241ac56fd9205d12c143761475307705;p=m6w6%2Flibmemcached

diff --git a/docs/man/libmemcached_configuration.3 b/docs/man/libmemcached_configuration.3
index dac97b93..db95a75c 100644
--- a/docs/man/libmemcached_configuration.3
+++ b/docs/man/libmemcached_configuration.3
@@ -1,4 +1,4 @@
-.TH "LIBMEMCACHED_CONFIGURATION" "3" "April 09, 2011" "0.47" "libmemcached"
+.TH "LIBMEMCACHED_CONFIGURATION" "3" "April 21, 2012" "1.0.6" "libmemcached"
 .SH NAME
 libmemcached_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 <libmemcached/memcached.h>
 .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="<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
@@ -102,44 +110,82 @@ Set the distribution model used by the client.  See :manpage:\(ga\(ga for more d
 Set the hashing alogrthm used for placing keys on servers.
 .INDENT 0.0
 .TP
-.B \-\-HASH\-WITH\-PREFIX_KEY
+.B \-\-HASH\-WITH\-NAMESPACE
 .UNINDENT
+.sp
+When enabled the prefix key will be added to the key when determining which
+server to store the data in.
 .INDENT 0.0
 .TP
-.B \-\-IO\-BYTES\-WATERMARK=
+.B \-\-NOREPLY
 .UNINDENT
+.sp
+Enable "no reply" for all calls that support this. It is highly recommended
+that you use this option with the binary protocol only.
 .INDENT 0.0
 .TP
-.B \-\-IO\-KEY\-PREFETCH=
+.B \-\-NUMBER\-OF\-REPLICAS=
 .UNINDENT
+.sp
+Set the nummber of servers that keys will be replicated to.
 .INDENT 0.0
 .TP
-.B \-\-IO\-MSG\-WATERMARK=
+.B \-\-RANDOMIZE\-REPLICA\-READ
 .UNINDENT
+.sp
+Select randomly the server within the replication pool to read from.
 .INDENT 0.0
 .TP
-.B \-\-NOREPLY
+.B \-\-SORT\-HOSTS
 .UNINDENT
+.sp
+When adding new servers always calculate their distribution based on sorted naming order.
 .INDENT 0.0
 .TP
-.B \-\-NUMBER\-OF\-REPLICAS=
+.B \-\-SUPPORT\-CAS
 .UNINDENT
 .sp
-Set the nummber of servers that keys will be replicated to.
+See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SUPPORT_CAS
 .INDENT 0.0
 .TP
-.B \-\-POLL\-TIMEOUT=
+.B \-\-USE\-UDP
 .UNINDENT
+.sp
+See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_USE_UDP
 .INDENT 0.0
 .TP
-.B \-\-RANDOMIZE\-REPLICA\-READ
+.B \-\-NAMESPACE=
 .UNINDENT
 .sp
-Select randomly the server within the replication pool to read from.
+A namespace is a container that provides context for keys, only other
+requests that know the namespace can access these values. This is
+accomplished by prepending the namespace value to all keys.
+.SS Mecached Pool Options:
 .INDENT 0.0
 .TP
-.B \-\-RCV\-TIMEOUT=
+.B \-\-POOL\-MIN
 .UNINDENT
+.sp
+Initial size of pool.
+.INDENT 0.0
+.TP
+.B \-\-POOL\-MAX
+.UNINDENT
+.sp
+Maximize size of the pool.
+.SS I/O Options:
+.INDENT 0.0
+.TP
+.B \-\-TCP\-NODELAY
+.UNINDENT
+.sp
+See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_TCP_NODELAY
+.INDENT 0.0
+.TP
+.B \-\-TCP\-KEEPALIVE
+.UNINDENT
+.sp
+See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
 .INDENT 0.0
 .TP
 .B \-\-RETRY\-TIMEOUT=
@@ -172,42 +218,31 @@ See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
 See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
 .INDENT 0.0
 .TP
-.B \-\-SORT\-HOSTS
+.B \-\-POLL\-TIMEOUT=
 .UNINDENT
 .sp
-When adding new servers always calculate their distribution based on sorted naming order.
+That sets the value of the timeout used by :manpage: \fIpoll()\fP.
 .INDENT 0.0
 .TP
-.B \-\-SUPPORT\-CAS
+.B \-\-IO\-BYTES\-WATERMARK=
 .UNINDENT
-.sp
-See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SUPPORT_CAS
 .INDENT 0.0
 .TP
-.B \-\-TCP\-NODELAY
+.B \-\-IO\-KEY\-PREFETCH=
 .UNINDENT
-.sp
-See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_TCP_NODELAY
 .INDENT 0.0
 .TP
-.B \-\-TCP\-KEEPALIVE
+.B \-\-IO\-MSG\-WATERMARK=
 .UNINDENT
-.sp
-See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
 .INDENT 0.0
 .TP
 .B \-\-TCP\-KEEPIDLE
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-\-USE\-UDP
-.UNINDENT
-.sp
-See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_USE_UDP
-.INDENT 0.0
-.TP
-.B \-\-PREFIX\-KEY=
+.B \-\-RCV\-TIMEOUT=
 .UNINDENT
+.SS Other:
 .INDENT 0.0
 .TP
 .B INCLUDE
@@ -234,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);
 {
  ...
 }
@@ -251,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