From: Brian Aker Date: Sun, 10 Apr 2011 05:07:19 +0000 (-0700) Subject: Additional doc updates. X-Git-Tag: 0.51~15^2~6 X-Git-Url: https://git.m6w6.name/?a=commitdiff_plain;h=ba3ec0beb20c1163737d3b6ff58f7eaa21a21708;p=awesomized%2Flibmemcached Additional doc updates. --- diff --git a/docs/conf.py b/docs/conf.py index 33febd2e..d4cd9f9c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -229,6 +229,9 @@ man_pages = [ ('hashkit_value', 'hashkit_value', u'libhashkit Documentation', [u'Brian Aker'], 3), ('libmemcached', 'libmemcached', u'Introducing the C Client Library for memcached', [u'Brian Aker'], 3), ('libmemcached_examples', 'libmemcached_examples', u'libmemcached Documentation', [u'Brian Aker'], 3), + ('libmemcached_configuration', 'libmemcached_configuration', u'libmemcached Documentation', [u'Brian Aker'], 3), + ('libmemcached_configuration', 'memcached_create_with_options', u'libmemcached Documentation', [u'Brian Aker'], 3), + ('libmemcached_configuration', 'libmemcached_check_configuration', u'libmemcached Documentation', [u'Brian Aker'], 3), ('libmemcachedutil', 'libmemcachedutil', u'libmemcached Documentation', [u'Brian Aker'], 3), ('memcached_analyze', 'memcached_analyze', u'libmemcached Documentation', [u'Brian Aker'], 3), ('memcached_auto', 'memcached_auto', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3), diff --git a/docs/include.am b/docs/include.am index 6721c4d2..28cea239 100644 --- a/docs/include.am +++ b/docs/include.am @@ -108,6 +108,9 @@ man_MANS+= \ docs/man/memcached_flush_buffers.3 \ docs/man/memcached_free.3 \ docs/man/memcached_generate_hash.3 \ + docs/man/libmemcached_check_configuration.3 \ + docs/man/libmemcached_configuration.3 \ + docs/man/memcached_create_with_options.3 \ docs/man/memcached_generate_hash_value.3 \ docs/man/memcached_get.3 \ docs/man/memcached_get_by_key.3 \ diff --git a/docs/libmemcached_configuration.rst b/docs/libmemcached_configuration.rst index a6b4b606..10103f50 100644 --- a/docs/libmemcached_configuration.rst +++ b/docs/libmemcached_configuration.rst @@ -33,9 +33,9 @@ Provide a servername to be used by the client. Providing a weight will cause wei Verify that keys that are being used fit within the design of the protocol being used. -.. describe:: --AUTO-EJECT_HOSTS +.. describe:: --REMOVE_FAILED_SERVERS -Enable the behavior MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS. +Enable the behavior MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS. .. describe:: --BINARY-PROTOCOL @@ -153,6 +153,23 @@ memcached_create_with_options() returns a pointer to the memcached_st that was created (or initialized). On an allocation failure, it returns NULL. + +------- +EXAMPLE +------- + + +.. code-block:: 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_free(memc); + + + ---- HOME ---- diff --git a/docs/man/libmemcached_check_configuration.3 b/docs/man/libmemcached_check_configuration.3 new file mode 100644 index 00000000..c5a81dfb --- /dev/null +++ b/docs/man/libmemcached_check_configuration.3 @@ -0,0 +1,264 @@ +.TH "LIBMEMCACHED_CHECK_CONFIGURATION" "3" "April 09, 2011" "0.47" "libmemcached" +.SH NAME +libmemcached_check_configuration \- libmemcached Documentation +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.\" Man page generated from reStructeredText. +. +.SH SYNOPSIS +.INDENT 0.0 +.TP +.B memcached_st *memcached_create_with_options(const char\fI\ *string\fP, size_t\fI\ string_length\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t libmemcached_check_configuration(const char\fI\ *option_string\fP, size_t\fI\ length\fP, char\fI\ *error_buffer\fP, size_t\fI\ error_buffer_size\fP) +.UNINDENT +.sp +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 +that you can use in your application directly. +.INDENT 0.0 +.TP +.B \-\-SERVER=:/? +.UNINDENT +.sp +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 \-\-VERIFY\-KEY +.UNINDENT +.sp +Verify that keys that are being used fit within the design of the protocol being used. +.INDENT 0.0 +.TP +.B \-\-REMOVE_FAILED_SERVERS +.UNINDENT +.sp +Enable the behavior MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS. +.INDENT 0.0 +.TP +.B \-\-BINARY\-PROTOCOL +.UNINDENT +.sp +Force all connections to use the binary protocol. +.INDENT 0.0 +.TP +.B \-\-BUFFER\-REQUESTS +.UNINDENT +.sp +Enable MEMCACHED_BEHAVIOR_BUFFER_REQUESTS. +.INDENT 0.0 +.TP +.B \-\-CONFIGURE\-FILE= +.UNINDENT +.sp +Provide a configuration file to be used to load requests. Beware that by using a configuration file libmemcached will reset memcached_st based on information only contained in the file. +.INDENT 0.0 +.TP +.B \-\-CONNECT\-TIMEOUT= +.UNINDENT +.sp +Enable MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT. +.INDENT 0.0 +.TP +.B \-\-DISTRIBUTION= +.UNINDENT +.sp +Set the distribution model used by the client. See :manpage:\(ga\(ga for more details. +.INDENT 0.0 +.TP +.B \-\-HASH= +.UNINDENT +.sp +Set the hashing alogrthm used for placing keys on servers. +.INDENT 0.0 +.TP +.B \-\-HASH\-WITH\-PREFIX_KEY +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-IO\-BYTES\-WATERMARK= +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-IO\-KEY\-PREFETCH= +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-IO\-MSG\-WATERMARK= +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-NOREPLY +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-NUMBER\-OF\-REPLICAS= +.UNINDENT +.sp +Set the nummber of servers that keys will be replicated to. +.INDENT 0.0 +.TP +.B \-\-POLL\-TIMEOUT= +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-RANDOMIZE\-REPLICA\-READ +.UNINDENT +.sp +Select randomly the server within the replication pool to read from. +.INDENT 0.0 +.TP +.B \-\-RCV\-TIMEOUT= +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-RETRY\-TIMEOUT= +.UNINDENT +.sp +See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_RETRY_TIMEOUT +.INDENT 0.0 +.TP +.B \-\-SERVER\-FAILURE\-LIMIT= +.UNINDENT +.sp +See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT +.INDENT 0.0 +.TP +.B \-\-SND\-TIMEOUT= +.UNINDENT +.sp +See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SND_TIMEOUT +.INDENT 0.0 +.TP +.B \-\-SOCKET\-RECV\-SIZE= +.UNINDENT +.sp +See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE +.INDENT 0.0 +.TP +.B \-\-SOCKET\-SEND\-SIZE= +.UNINDENT +.sp +See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE +.INDENT 0.0 +.TP +.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 +.sp +See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SUPPORT_CAS +.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 \-\-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= +.UNINDENT +.INDENT 0.0 +.TP +.B INCLUDE +.UNINDENT +.sp +Include a file in configuration. Unlike \-\-CONFIGURE\-FILE= this will not reset memcached_st +.INDENT 0.0 +.TP +.B RESET +.UNINDENT +.sp +Reset memcached_st and continue to process. +.INDENT 0.0 +.TP +.B END +.UNINDENT +.sp +End configutation processing. +.INDENT 0.0 +.TP +.B ERROR +.UNINDENT +.sp +End configutation processing and throw an error. +.SH RETURN +.sp +memcached_create_with_options() 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_free(memc); +.ft P +.fi +.SH HOME +.sp +To find out more information please check: +\fI\%https://launchpad.net/libmemcached\fP +.SH SEE ALSO +.sp +\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP +.SH AUTHOR +Brian Aker +.SH COPYRIGHT +2011, Brian Aker DataDifferential, http://datadifferential.com/ +.\" Generated by docutils manpage writer. +.\" +. diff --git a/docs/man/libmemcached_configuration.3 b/docs/man/libmemcached_configuration.3 new file mode 100644 index 00000000..dac97b93 --- /dev/null +++ b/docs/man/libmemcached_configuration.3 @@ -0,0 +1,264 @@ +.TH "LIBMEMCACHED_CONFIGURATION" "3" "April 09, 2011" "0.47" "libmemcached" +.SH NAME +libmemcached_configuration \- libmemcached Documentation +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.\" Man page generated from reStructeredText. +. +.SH SYNOPSIS +.INDENT 0.0 +.TP +.B memcached_st *memcached_create_with_options(const char\fI\ *string\fP, size_t\fI\ string_length\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t libmemcached_check_configuration(const char\fI\ *option_string\fP, size_t\fI\ length\fP, char\fI\ *error_buffer\fP, size_t\fI\ error_buffer_size\fP) +.UNINDENT +.sp +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 +that you can use in your application directly. +.INDENT 0.0 +.TP +.B \-\-SERVER=:/? +.UNINDENT +.sp +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 \-\-VERIFY\-KEY +.UNINDENT +.sp +Verify that keys that are being used fit within the design of the protocol being used. +.INDENT 0.0 +.TP +.B \-\-REMOVE_FAILED_SERVERS +.UNINDENT +.sp +Enable the behavior MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS. +.INDENT 0.0 +.TP +.B \-\-BINARY\-PROTOCOL +.UNINDENT +.sp +Force all connections to use the binary protocol. +.INDENT 0.0 +.TP +.B \-\-BUFFER\-REQUESTS +.UNINDENT +.sp +Enable MEMCACHED_BEHAVIOR_BUFFER_REQUESTS. +.INDENT 0.0 +.TP +.B \-\-CONFIGURE\-FILE= +.UNINDENT +.sp +Provide a configuration file to be used to load requests. Beware that by using a configuration file libmemcached will reset memcached_st based on information only contained in the file. +.INDENT 0.0 +.TP +.B \-\-CONNECT\-TIMEOUT= +.UNINDENT +.sp +Enable MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT. +.INDENT 0.0 +.TP +.B \-\-DISTRIBUTION= +.UNINDENT +.sp +Set the distribution model used by the client. See :manpage:\(ga\(ga for more details. +.INDENT 0.0 +.TP +.B \-\-HASH= +.UNINDENT +.sp +Set the hashing alogrthm used for placing keys on servers. +.INDENT 0.0 +.TP +.B \-\-HASH\-WITH\-PREFIX_KEY +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-IO\-BYTES\-WATERMARK= +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-IO\-KEY\-PREFETCH= +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-IO\-MSG\-WATERMARK= +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-NOREPLY +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-NUMBER\-OF\-REPLICAS= +.UNINDENT +.sp +Set the nummber of servers that keys will be replicated to. +.INDENT 0.0 +.TP +.B \-\-POLL\-TIMEOUT= +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-RANDOMIZE\-REPLICA\-READ +.UNINDENT +.sp +Select randomly the server within the replication pool to read from. +.INDENT 0.0 +.TP +.B \-\-RCV\-TIMEOUT= +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-RETRY\-TIMEOUT= +.UNINDENT +.sp +See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_RETRY_TIMEOUT +.INDENT 0.0 +.TP +.B \-\-SERVER\-FAILURE\-LIMIT= +.UNINDENT +.sp +See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT +.INDENT 0.0 +.TP +.B \-\-SND\-TIMEOUT= +.UNINDENT +.sp +See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SND_TIMEOUT +.INDENT 0.0 +.TP +.B \-\-SOCKET\-RECV\-SIZE= +.UNINDENT +.sp +See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE +.INDENT 0.0 +.TP +.B \-\-SOCKET\-SEND\-SIZE= +.UNINDENT +.sp +See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE +.INDENT 0.0 +.TP +.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 +.sp +See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SUPPORT_CAS +.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 \-\-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= +.UNINDENT +.INDENT 0.0 +.TP +.B INCLUDE +.UNINDENT +.sp +Include a file in configuration. Unlike \-\-CONFIGURE\-FILE= this will not reset memcached_st +.INDENT 0.0 +.TP +.B RESET +.UNINDENT +.sp +Reset memcached_st and continue to process. +.INDENT 0.0 +.TP +.B END +.UNINDENT +.sp +End configutation processing. +.INDENT 0.0 +.TP +.B ERROR +.UNINDENT +.sp +End configutation processing and throw an error. +.SH RETURN +.sp +memcached_create_with_options() 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_free(memc); +.ft P +.fi +.SH HOME +.sp +To find out more information please check: +\fI\%https://launchpad.net/libmemcached\fP +.SH SEE ALSO +.sp +\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP +.SH AUTHOR +Brian Aker +.SH COPYRIGHT +2011, Brian Aker DataDifferential, http://datadifferential.com/ +.\" Generated by docutils manpage writer. +.\" +. diff --git a/docs/man/memcached_create_with_options.3 b/docs/man/memcached_create_with_options.3 new file mode 100644 index 00000000..eac57824 --- /dev/null +++ b/docs/man/memcached_create_with_options.3 @@ -0,0 +1,264 @@ +.TH "MEMCACHED_CREATE_WITH_OPTIONS" "3" "April 09, 2011" "0.47" "libmemcached" +.SH NAME +memcached_create_with_options \- libmemcached Documentation +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.\" Man page generated from reStructeredText. +. +.SH SYNOPSIS +.INDENT 0.0 +.TP +.B memcached_st *memcached_create_with_options(const char\fI\ *string\fP, size_t\fI\ string_length\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t libmemcached_check_configuration(const char\fI\ *option_string\fP, size_t\fI\ length\fP, char\fI\ *error_buffer\fP, size_t\fI\ error_buffer_size\fP) +.UNINDENT +.sp +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 +that you can use in your application directly. +.INDENT 0.0 +.TP +.B \-\-SERVER=:/? +.UNINDENT +.sp +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 \-\-VERIFY\-KEY +.UNINDENT +.sp +Verify that keys that are being used fit within the design of the protocol being used. +.INDENT 0.0 +.TP +.B \-\-REMOVE_FAILED_SERVERS +.UNINDENT +.sp +Enable the behavior MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS. +.INDENT 0.0 +.TP +.B \-\-BINARY\-PROTOCOL +.UNINDENT +.sp +Force all connections to use the binary protocol. +.INDENT 0.0 +.TP +.B \-\-BUFFER\-REQUESTS +.UNINDENT +.sp +Enable MEMCACHED_BEHAVIOR_BUFFER_REQUESTS. +.INDENT 0.0 +.TP +.B \-\-CONFIGURE\-FILE= +.UNINDENT +.sp +Provide a configuration file to be used to load requests. Beware that by using a configuration file libmemcached will reset memcached_st based on information only contained in the file. +.INDENT 0.0 +.TP +.B \-\-CONNECT\-TIMEOUT= +.UNINDENT +.sp +Enable MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT. +.INDENT 0.0 +.TP +.B \-\-DISTRIBUTION= +.UNINDENT +.sp +Set the distribution model used by the client. See :manpage:\(ga\(ga for more details. +.INDENT 0.0 +.TP +.B \-\-HASH= +.UNINDENT +.sp +Set the hashing alogrthm used for placing keys on servers. +.INDENT 0.0 +.TP +.B \-\-HASH\-WITH\-PREFIX_KEY +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-IO\-BYTES\-WATERMARK= +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-IO\-KEY\-PREFETCH= +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-IO\-MSG\-WATERMARK= +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-NOREPLY +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-NUMBER\-OF\-REPLICAS= +.UNINDENT +.sp +Set the nummber of servers that keys will be replicated to. +.INDENT 0.0 +.TP +.B \-\-POLL\-TIMEOUT= +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-RANDOMIZE\-REPLICA\-READ +.UNINDENT +.sp +Select randomly the server within the replication pool to read from. +.INDENT 0.0 +.TP +.B \-\-RCV\-TIMEOUT= +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-RETRY\-TIMEOUT= +.UNINDENT +.sp +See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_RETRY_TIMEOUT +.INDENT 0.0 +.TP +.B \-\-SERVER\-FAILURE\-LIMIT= +.UNINDENT +.sp +See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT +.INDENT 0.0 +.TP +.B \-\-SND\-TIMEOUT= +.UNINDENT +.sp +See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SND_TIMEOUT +.INDENT 0.0 +.TP +.B \-\-SOCKET\-RECV\-SIZE= +.UNINDENT +.sp +See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE +.INDENT 0.0 +.TP +.B \-\-SOCKET\-SEND\-SIZE= +.UNINDENT +.sp +See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE +.INDENT 0.0 +.TP +.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 +.sp +See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SUPPORT_CAS +.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 \-\-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= +.UNINDENT +.INDENT 0.0 +.TP +.B INCLUDE +.UNINDENT +.sp +Include a file in configuration. Unlike \-\-CONFIGURE\-FILE= this will not reset memcached_st +.INDENT 0.0 +.TP +.B RESET +.UNINDENT +.sp +Reset memcached_st and continue to process. +.INDENT 0.0 +.TP +.B END +.UNINDENT +.sp +End configutation processing. +.INDENT 0.0 +.TP +.B ERROR +.UNINDENT +.sp +End configutation processing and throw an error. +.SH RETURN +.sp +memcached_create_with_options() 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_free(memc); +.ft P +.fi +.SH HOME +.sp +To find out more information please check: +\fI\%https://launchpad.net/libmemcached\fP +.SH SEE ALSO +.sp +\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP +.SH AUTHOR +Brian Aker +.SH COPYRIGHT +2011, Brian Aker DataDifferential, http://datadifferential.com/ +.\" Generated by docutils manpage writer. +.\" +. diff --git a/support/libmemcached.spec.in b/support/libmemcached.spec.in index 6a4ef4a1..f689742a 100644 --- a/support/libmemcached.spec.in +++ b/support/libmemcached.spec.in @@ -167,7 +167,6 @@ you will need to install %{name}-devel. %{_libdir}/libmemcachedprotocol.so %{_libdir}/libmemcachedutil.so %{_libdir}/pkgconfig/libmemcached.pc -%{_mandir}/man3/libhashkit.3.gz %{_mandir}/man3/hashkit_clone.3.gz %{_mandir}/man3/hashkit_crc32.3.gz %{_mandir}/man3/hashkit_create.3.gz @@ -183,7 +182,10 @@ you will need to install %{name}-devel. %{_mandir}/man3/hashkit_md5.3.gz %{_mandir}/man3/hashkit_murmur.3.gz %{_mandir}/man3/hashkit_value.3.gz +%{_mandir}/man3/libhashkit.3.gz %{_mandir}/man3/libmemcached.3.gz +%{_mandir}/man3/libmemcached_check_configuration.3.gz +%{_mandir}/man3/libmemcached_configuration.3.gz %{_mandir}/man3/libmemcached_examples.3.gz %{_mandir}/man3/libmemcachedutil.3.gz %{_mandir}/man3/memcached_add.3.gz @@ -199,6 +201,7 @@ you will need to install %{name}-devel. %{_mandir}/man3/memcached_cas_by_key.3.gz %{_mandir}/man3/memcached_clone.3.gz %{_mandir}/man3/memcached_create.3.gz +%{_mandir}/man3/memcached_create_with_options.3.gz %{_mandir}/man3/memcached_decrement.3.gz %{_mandir}/man3/memcached_decrement_with_initial.3.gz %{_mandir}/man3/memcached_delete.3.gz