projects
/
awesomized
/
libmemcached
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
|
github
raw
|
inline
| side by side
Merge in stats fix for lp:794717
[awesomized/libmemcached]
/
docs
/
man
/
libmemcached_configuration.3
diff --git
a/docs/man/libmemcached_configuration.3
b/docs/man/libmemcached_configuration.3
index 3fa476ea657de67ab005dbfd3b06e04e9fa80e74..d33c179f8ce0f32e80c133bd742ab7eb0169d370 100644
(file)
--- a/
docs/man/libmemcached_configuration.3
+++ b/
docs/man/libmemcached_configuration.3
@@
-1,4
+1,4
@@
-.TH "LIBMEMCACHED_CONFIGURATION" "3" "
April 10
, 2011" "0.47" "libmemcached"
+.TH "LIBMEMCACHED_CONFIGURATION" "3" "
May 23
, 2011" "0.47" "libmemcached"
.SH NAME
libmemcached_configuration \- libmemcached Documentation
.
.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
.\" Man page generated from reStructeredText.
.
.SH SYNOPSIS
+.sp
+#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
.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
.UNINDENT
.INDENT 0.0
.TP
@@
-102,44
+104,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
Set the hashing alogrthm used for placing keys on servers.
.INDENT 0.0
.TP
-.B \-\-HASH\-WITH\-
PREFIX_KEY
+.B \-\-HASH\-WITH\-
NAMESPACE
.UNINDENT
.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
.INDENT 0.0
.TP
-.B \-\-
IO\-BYTES\-WATERMARK=
+.B \-\-
NOREPLY
.UNINDENT
.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
.INDENT 0.0
.TP
-.B \-\-
IO\-KEY\-PREFETCH
=
+.B \-\-
NUMBER\-OF\-REPLICAS
=
.UNINDENT
.UNINDENT
+.sp
+Set the nummber of servers that keys will be replicated to.
.INDENT 0.0
.TP
.INDENT 0.0
.TP
-.B \-\-
IO\-MSG\-WATERMARK=
+.B \-\-
RANDOMIZE\-REPLICA\-READ
.UNINDENT
.UNINDENT
+.sp
+Select randomly the server within the replication pool to read from.
.INDENT 0.0
.TP
.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 \-\-SUPPORT\-CAS
.UNINDENT
.UNINDENT
+.sp
+See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SUPPORT_CAS
.INDENT 0.0
.TP
.INDENT 0.0
.TP
-.B \-\-
NUMBER\-OF\-REPLICAS=
+.B \-\-
USE\-UDP
.UNINDENT
.sp
.UNINDENT
.sp
-Se
t the nummber of servers that keys will be replicated to.
+Se
e \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_USE_UDP
.INDENT 0.0
.TP
.INDENT 0.0
.TP
-.B \-\-
POLL\-TIMEOUT
=
+.B \-\-
NAMESPACE
=
.UNINDENT
.UNINDENT
+.sp
+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
.INDENT 0.0
.TP
-.B \-\-
RANDOMIZE\-REPLICA\-READ
+.B \-\-
POOL\-MIN
.UNINDENT
.sp
.UNINDENT
.sp
-
Select randomly the server within the replication pool to read from
.
+
Initial size of pool
.
.INDENT 0.0
.TP
.INDENT 0.0
.TP
-.B \-\-
RCV\-TIMEOUT=
+.B \-\-
POOL\-MAX
.UNINDENT
.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=
.INDENT 0.0
.TP
.B \-\-RETRY\-TIMEOUT=
@@
-172,42
+212,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
See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
.INDENT 0.0
.TP
-.B \-\-
SORT\-HOSTS
+.B \-\-
POLL\-TIMEOUT=
.UNINDENT
.sp
.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
.INDENT 0.0
.TP
-.B \-\-
SUPPORT\-CAS
+.B \-\-
IO\-BYTES\-WATERMARK=
.UNINDENT
.UNINDENT
-.sp
-See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SUPPORT_CAS
.INDENT 0.0
.TP
.INDENT 0.0
.TP
-.B \-\-
TCP\-NODELAY
+.B \-\-
IO\-KEY\-PREFETCH=
.UNINDENT
.UNINDENT
-.sp
-See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_TCP_NODELAY
.INDENT 0.0
.TP
.INDENT 0.0
.TP
-.B \-\-
TCP\-KEEPALIVE
+.B \-\-
IO\-MSG\-WATERMARK=
.UNINDENT
.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
.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
.UNINDENT
+.SS Other:
.INDENT 0.0
.TP
.B INCLUDE
.INDENT 0.0
.TP
.B INCLUDE
@@
-234,14
+263,14
@@
End configutation processing.
End configutation processing and throw an error.
.SH RETURN
.sp
End configutation processing and throw an error.
.SH RETURN
.sp
-memcached
_create_with_options
() returns a pointer to the memcached_st that was
+memcached() 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"
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
+280,7
@@
memcached_free(memc);
.SH HOME
.sp
To find out more information please check:
.SH HOME
.sp
To find out more information please check:
-\fI\%http
s://launchpad.net/libmemcached
\fP
+\fI\%http
://libmemcached.org/
\fP
.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP