From ef301192f389f5f6ab4f8ed8c204ca7e115fe0b1 Mon Sep 17 00:00:00 2001 From: Brian Aker Date: Fri, 8 Apr 2011 17:46:34 -0700 Subject: [PATCH] Update all docs! --- docs/conf.py | 3 +- docs/include.am | 77 +++++-------- docs/index.rst | 19 ++- docs/libhashkit.rst | 49 ++++++++ docs/libmemcached.rst | 6 +- docs/libmemcached_examples.rst | 16 ++- docs/libmemcachedutil.rst | 8 +- docs/man/hashkit_clone.3 | 2 +- docs/man/hashkit_crc32.3 | 2 +- docs/man/hashkit_create.3 | 2 +- docs/man/hashkit_fnv1_32.3 | 2 +- docs/man/hashkit_fnv1_64.3 | 2 +- docs/man/hashkit_fnv1a_32.3 | 2 +- docs/man/hashkit_fnv1a_64.3 | 2 +- docs/man/hashkit_free.3 | 2 +- docs/man/hashkit_functions.3 | 2 +- docs/man/hashkit_hsieh.3 | 2 +- docs/man/hashkit_is_allocated.3 | 2 +- docs/man/hashkit_jenkins.3 | 2 +- docs/man/hashkit_md5.3 | 2 +- docs/man/hashkit_murmur.3 | 2 +- docs/man/hashkit_value.3 | 2 +- docs/man/libhashkit.3 | 61 ++++++++++ docs/man/libmemcached.3 | 2 +- docs/man/libmemcached_examples.3 | 2 +- docs/man/libmemcachedutil.3 | 4 +- docs/man/memaslap.1 | 18 ++- docs/man/memcached_add.3 | 2 +- docs/man/memcached_add_by_key.3 | 2 +- docs/man/memcached_analyze.3 | 2 +- docs/man/memcached_append.3 | 2 +- docs/man/memcached_append_by_key.3 | 2 +- docs/man/memcached_auto.3 | 2 +- docs/man/memcached_behavior.3 | 2 +- docs/man/memcached_behavior_get.3 | 2 +- docs/man/memcached_behavior_set.3 | 2 +- docs/man/memcached_callback.3 | 108 +++++++----------- docs/man/memcached_callback_get.3 | 108 +++++++----------- docs/man/memcached_callback_set.3 | 108 +++++++----------- docs/man/memcached_cas.3 | 2 +- docs/man/memcached_cas_by_key.3 | 2 +- docs/man/memcached_clone.3 | 36 +++--- docs/man/memcached_create.3 | 36 +++--- docs/man/memcached_decrement.3 | 2 +- docs/man/memcached_decrement_with_initial.3 | 2 +- docs/man/memcached_delete.3 | 19 +-- docs/man/memcached_delete_by_key.3 | 19 +-- docs/man/memcached_destroy_sasl_auth_data.3 | 13 ++- docs/man/memcached_dump.3 | 8 +- docs/man/memcached_fetch.3 | 2 +- docs/man/memcached_fetch_execute.3 | 2 +- docs/man/memcached_fetch_result.3 | 2 +- docs/man/memcached_flush.3 | 9 +- docs/man/memcached_flush_buffers.3 | 22 ++-- docs/man/memcached_free.3 | 36 +++--- docs/man/memcached_generate_hash_value.3 | 11 +- docs/man/memcached_get.3 | 2 +- docs/man/memcached_get_by_key.3 | 2 +- docs/man/memcached_get_memory_allocators.3 | 2 +- docs/man/memcached_get_sasl_callbacks.3 | 13 ++- docs/man/memcached_get_user_data.3 | 2 +- docs/man/memcached_increment.3 | 2 +- docs/man/memcached_increment_with_initial.3 | 2 +- docs/man/memcached_lib_version.3 | 2 +- docs/man/memcached_memory_allocators.3 | 2 +- docs/man/memcached_mget.3 | 2 +- docs/man/memcached_mget_by_key.3 | 2 +- docs/man/memcached_mget_execute.3 | 2 +- docs/man/memcached_mget_execute_by_key.3 | 2 +- docs/man/memcached_pool.3 | 63 +++++----- docs/man/memcached_pool_behavior_get.3 | 63 +++++----- docs/man/memcached_pool_behavior_set.3 | 63 +++++----- docs/man/memcached_pool_create.3 | 63 +++++----- docs/man/memcached_pool_destroy.3 | 63 +++++----- docs/man/memcached_pool_pop.3 | 63 +++++----- docs/man/memcached_pool_push.3 | 63 +++++----- docs/man/memcached_prepend.3 | 2 +- docs/man/memcached_prepend_by_key.3 | 2 +- docs/man/memcached_quit.3 | 8 +- docs/man/memcached_replace.3 | 2 +- docs/man/memcached_replace_by_key.3 | 2 +- docs/man/memcached_result_cas.3 | 2 +- docs/man/memcached_result_create.3 | 2 +- docs/man/memcached_result_flags.3 | 2 +- docs/man/memcached_result_free.3 | 2 +- docs/man/memcached_result_key_length.3 | 2 +- docs/man/memcached_result_key_value.3 | 2 +- docs/man/memcached_result_length.3 | 2 +- docs/man/memcached_result_st.3 | 2 +- docs/man/memcached_result_value.3 | 2 +- docs/man/memcached_sasl.3 | 13 ++- docs/man/memcached_sasl_set_auth_data.3 | 13 ++- docs/man/memcached_server_add.3 | 2 +- docs/man/memcached_server_add_unix_socket.3 | 2 +- docs/man/memcached_server_count.3 | 2 +- docs/man/memcached_server_cursor.3 | 2 +- docs/man/memcached_server_list.3 | 2 +- docs/man/memcached_server_list_append.3 | 2 +- docs/man/memcached_server_list_count.3 | 2 +- docs/man/memcached_server_list_free.3 | 2 +- docs/man/memcached_server_push.3 | 2 +- docs/man/memcached_server_st.3 | 2 +- docs/man/memcached_servers.3 | 2 +- docs/man/memcached_servers_parse.3 | 2 +- docs/man/memcached_servers_reset.3 | 36 +++--- docs/man/memcached_set.3 | 2 +- docs/man/memcached_set_by_key.3 | 2 +- docs/man/memcached_set_memory_allocators.3 | 2 +- .../memcached_set_memory_allocators_context.3 | 2 +- docs/man/memcached_set_sasl_callbacks.3 | 13 ++- docs/man/memcached_set_user_data.3 | 2 +- docs/man/memcached_stat.3 | 2 +- docs/man/memcached_stat_execute.3 | 2 +- docs/man/memcached_stat_get_keys.3 | 2 +- docs/man/memcached_stat_get_value.3 | 2 +- docs/man/memcached_stat_servername.3 | 2 +- docs/man/memcached_stats.3 | 2 +- docs/man/memcached_strerror.3 | 2 +- docs/man/memcached_user_data.3 | 2 +- docs/man/memcached_verbosity.3 | 2 +- docs/man/memcached_version.3 | 2 +- docs/man/memcapable.1 | 2 +- docs/man/memcat.1 | 12 +- docs/man/memcp.1 | 12 +- docs/man/memdump.1 | 6 +- docs/man/memerror.1 | 12 +- docs/man/memflush.1 | 15 +-- docs/man/memrm.1 | 12 +- docs/man/memslap.1 | 6 +- docs/man/memstat.1 | 14 +-- docs/memaslap.rst | 70 +++++------- docs/memcached_analyze.rst | 2 +- docs/memcached_callback.rst | 56 ++++----- docs/memcached_create.rst | 30 +++-- docs/memcached_delete.rst | 35 +++--- docs/memcached_dump.rst | 24 ++-- docs/memcached_flush.rst | 24 ++-- docs/memcached_flush_buffers.rst | 35 +++--- docs/memcached_generate_hash_value.rst | 26 ++--- docs/memcached_pool.rst | 47 +++----- docs/memcached_quit.rst | 24 ++-- docs/memcached_sasl.rst | 29 +++-- docs/memcat.rst | 5 +- docs/memcp.rst | 7 +- docs/memdump.rst | 10 +- docs/memerror.rst | 8 +- docs/memflush.rst | 22 ++-- docs/memrm.rst | 4 +- docs/memslap.rst | 11 +- docs/memstat.rst | 18 ++- 150 files changed, 1040 insertions(+), 1039 deletions(-) create mode 100644 docs/libhashkit.rst create mode 100644 docs/man/libhashkit.3 diff --git a/docs/conf.py b/docs/conf.py index 1d99b203..2c634707 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -41,7 +41,7 @@ master_doc = 'index' # General information about the project. project = u'libmemcached' -copyright = u'2011, Brian Aker' +copyright = u'2011, Brian Aker DataDifferential, http://datadifferential.com/' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -211,6 +211,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ + ('libhashkit', 'libhashkit', u'libhashkit Documentation', [u'Brian Aker'], 3), ('hashkit_create', 'hashkit_clone', u'libhashkit Documentation', [u'Brian Aker'], 3), ('hashkit_create', 'hashkit_create', u'libhashkit Documentation', [u'Brian Aker'], 3), ('hashkit_create', 'hashkit_free', u'libhashkit Documentation', [u'Brian Aker'], 3), diff --git a/docs/include.am b/docs/include.am index 8f152547..e316ba21 100644 --- a/docs/include.am +++ b/docs/include.am @@ -3,6 +3,9 @@ # All paths should be given relative to the root EXTRA_DIST+= \ + docs/_static \ + docs/_templates \ + docs/conf.py \ docs/hashkit_clone.rst \ docs/hashkit_crc32.rst \ docs/hashkit_create.rst \ @@ -19,63 +22,65 @@ EXTRA_DIST+= \ docs/hashkit_murmur.rst \ docs/hashkit_value.rst \ docs/index.rst \ - docs/libmemcached_examples.rst \ + docs/libhashkit.rst \ docs/libmemcached.rst \ + docs/libmemcached_examples.rst \ docs/libmemcachedutil.rst \ - docs/memcached_add_by_key.rst \ + docs/memaslap.rst \ docs/memcached_add.rst \ + docs/memcached_add_by_key.rst \ docs/memcached_analyze.rst \ - docs/memcached_append_by_key.rst \ docs/memcached_append.rst \ + docs/memcached_append_by_key.rst \ docs/memcached_auto.rst \ - docs/memcached_behavior_get.rst \ docs/memcached_behavior.rst \ + docs/memcached_behavior_get.rst \ docs/memcached_behavior_set.rst \ - docs/memcached_callback_get.rst \ docs/memcached_callback.rst \ + docs/memcached_callback_get.rst \ docs/memcached_callback_set.rst \ - docs/memcached_cas_by_key.rst \ docs/memcached_cas.rst \ + docs/memcached_cas_by_key.rst \ docs/memcached_clone.rst \ docs/memcached_create.rst \ docs/memcached_decrement.rst \ docs/memcached_decrement_with_initial.rst \ - docs/memcached_delete_by_key.rst \ docs/memcached_delete.rst \ + docs/memcached_delete_by_key.rst \ docs/memcached_destroy_sasl_auth_data.rst \ docs/memcached_dump.rst \ + docs/memcached_fetch.rst \ docs/memcached_fetch_execute.rst \ docs/memcached_fetch_result.rst \ - docs/memcached_fetch.rst \ - docs/memcached_flush_buffers.rst \ docs/memcached_flush.rst \ + docs/memcached_flush_buffers.rst \ docs/memcached_free.rst \ docs/memcached_generate_hash_value.rst \ + docs/memcached_get.rst \ docs/memcached_get_by_key.rst \ docs/memcached_get_memory_allocators.rst \ - docs/memcached_get.rst \ docs/memcached_get_sasl_callbacks.rst \ docs/memcached_get_user_data.rst \ docs/memcached_increment.rst \ docs/memcached_increment_with_initial.rst \ docs/memcached_lib_version.rst \ docs/memcached_memory_allocators.rst \ + docs/memcached_mget.rst \ docs/memcached_mget_by_key.rst \ - docs/memcached_mget_execute_by_key.rst \ docs/memcached_mget_execute.rst \ - docs/memcached_mget.rst \ + docs/memcached_mget_execute_by_key.rst \ + docs/memcached_pool.rst \ docs/memcached_pool_behavior_get.rst \ docs/memcached_pool_behavior_set.rst \ docs/memcached_pool_create.rst \ docs/memcached_pool_destroy.rst \ docs/memcached_pool_push.rst \ - docs/memcached_pool.rst \ docs/memcached_pool_rst.rst \ - docs/memcached_prepend_by_key.rst \ docs/memcached_prepend.rst \ + docs/memcached_prepend_by_key.rst \ docs/memcached_quit.rst \ - docs/memcached_replace_by_key.rst \ docs/memcached_replace.rst \ + docs/memcached_replace_by_key.rst \ docs/memcached_result_cas.rst \ docs/memcached_result_create.rst \ docs/memcached_result_flags.rst \ @@ -91,25 +96,25 @@ EXTRA_DIST+= \ docs/memcached_server_add_unix_socket.rst \ docs/memcached_server_count.rst \ docs/memcached_server_cursor.rst \ + docs/memcached_server_list.rst \ docs/memcached_server_list_append.rst \ docs/memcached_server_list_count.rst \ docs/memcached_server_list_free.rst \ - docs/memcached_server_list.rst \ docs/memcached_server_push.rst \ + docs/memcached_server_st.rst \ + docs/memcached_servers.rst \ docs/memcached_servers_parse.rst \ docs/memcached_servers_reset.rst \ - docs/memcached_servers.rst \ - docs/memcached_server_st.rst \ + docs/memcached_set.rst \ docs/memcached_set_by_key.rst \ - docs/memcached_set_memory_allocators_context.rst \ docs/memcached_set_memory_allocators.rst \ - docs/memcached_set.rst \ + docs/memcached_set_memory_allocators_context.rst \ docs/memcached_set_sasl_callbacks.rst \ docs/memcached_set_user_data.rst \ + docs/memcached_stat.rst \ docs/memcached_stat_execute.rst \ docs/memcached_stat_get_keys.rst \ docs/memcached_stat_get_value.rst \ - docs/memcached_stat.rst \ docs/memcached_stat_servername.rst \ docs/memcached_stats.rst \ docs/memcached_strerror.rst \ @@ -123,32 +128,7 @@ EXTRA_DIST+= \ docs/memerror.rst \ docs/memflush.rst \ docs/memrm.rst \ - docs/memaslap.rst \ docs/memslap.rst \ - docs/memstat.rst \ - docs/_static \ - docs/_templates \ - docs/conf.py \ - docs/libmemcached.rst \ - docs/libmemcached_examples.rst \ - docs/libmemcachedutil.rst \ - docs/memcached_analyze.rst \ - docs/memcached_dump.rst \ - docs/memcached_flush.rst \ - docs/memcached_flush_buffers.rst \ - docs/memcached_generate_hash_value.rst \ - docs/memcached_quit.rst \ - docs/memcached_strerror.rst \ - docs/memcached_verbosity.rst \ - docs/memcapable.rst \ - docs/memcat.rst \ - docs/memcp.rst \ - docs/memdump.rst \ - docs/memerror.rst \ - docs/memflush.rst \ - docs/memrm.rst \ - docs/memslap.rst \ - docs/memaslap.rst \ docs/memstat.rst # Makefile for Sphinx documentation @@ -166,8 +146,8 @@ ALLSPHINXOPTS = -d $(SPHINX_BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOP .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest man_MANS+= \ - docs/man/hashkit_crc32.3 \ docs/man/hashkit_clone.3 \ + docs/man/hashkit_crc32.3 \ docs/man/hashkit_create.3 \ docs/man/hashkit_fnv1_32.3 \ docs/man/hashkit_fnv1_64.3 \ @@ -181,9 +161,11 @@ man_MANS+= \ docs/man/hashkit_md5.3 \ docs/man/hashkit_murmur.3 \ docs/man/hashkit_value.3 \ + docs/man/libhashkit.3 \ docs/man/libmemcached.3 \ docs/man/libmemcached_examples.3 \ docs/man/libmemcachedutil.3 \ + docs/man/memaslap.1 \ docs/man/memcached_add.3 \ docs/man/memcached_add_by_key.3 \ docs/man/memcached_analyze.3 \ @@ -262,7 +244,6 @@ man_MANS+= \ docs/man/memerror.1 \ docs/man/memflush.1 \ docs/man/memrm.1 \ - docs/man/memaslap.1 \ docs/man/memslap.1 \ docs/man/memstat.1 diff --git a/docs/index.rst b/docs/index.rst index f4fda2df..00a437d8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,6 @@ -======================================== -Welcome to libmemcached's documentation! -======================================== +========================================= +Welcome to the libmemcached documentation +========================================= ------------ Libmemcached @@ -12,7 +12,6 @@ Libmemcached libmemcached libmemcached_examples libmemcached_configuration - libmemcachedutil memcached_analyze memcached_auto memcached_behavior @@ -25,7 +24,6 @@ Libmemcached memcached_generate_hash_value memcached_get memcached_memory_allocators - memcached_pool memcached_quit memcached_result_st memcached_sasl @@ -38,6 +36,16 @@ Libmemcached memcached_verbosity memcached_version +---------------- +Libmemcachedutil +---------------- + +.. toctree:: + :maxdepth: 1 + + libmemcachedutil + memcached_pool + ------------------- Client Applications ------------------- @@ -63,6 +71,7 @@ Libhashkit .. toctree:: :maxdepth: 1 + libhashkit hashkit_create hashkit_functions hashkit_value diff --git a/docs/libhashkit.rst b/docs/libhashkit.rst new file mode 100644 index 00000000..a5870c57 --- /dev/null +++ b/docs/libhashkit.rst @@ -0,0 +1,49 @@ +====================== +Introducing libhashkit +====================== + + +------- +LIBRARY +------- + + +C library collection of useful hashing algorithm (libhashkit, -lhashkit) + + +-------- +SYNOPSIS +-------- + + +.. code-block:: perl + + cc [ flag ... ] file ... -lhashkit + + #include + + + +----------- +DESCRIPTION +----------- + + +\ **libhashkit**\ is a small and thread-safe client library that provides a collection of useful hashing algorithm. libhashkit is distributed with libmemcached. + + +---- +HOME +---- + + +To find out more information please check: +`https://launchpad.net/libmemcached `_ + + +-------- +SEE ALSO +-------- + +:manpage:`libmemcached(3)` + diff --git a/docs/libmemcached.rst b/docs/libmemcached.rst index 92684f12..38346fca 100644 --- a/docs/libmemcached.rst +++ b/docs/libmemcached.rst @@ -1,6 +1,6 @@ -============ -libmemcached -============ +=========== +Introducing +=========== Client library for memcached diff --git a/docs/libmemcached_examples.rst b/docs/libmemcached_examples.rst index b6d27d5d..38d6f7b5 100644 --- a/docs/libmemcached_examples.rst +++ b/docs/libmemcached_examples.rst @@ -1,11 +1,9 @@ -===================== -libmemcached examples -===================== - +======== +Examples +======== Examples for libmemcached - ----------- DESCRIPTION ----------- @@ -20,7 +18,7 @@ Creating and Freeing structure ------------------------------ -.. code-block:: perl +.. code-block:: c memcached_st *memc; memcached_return_t rc; @@ -40,7 +38,7 @@ Connecting to servers -.. code-block:: perl +.. code-block:: c memcached_server_st *servers; memcached_st *memc= memcached_create(NULL); @@ -75,7 +73,7 @@ Adding a value to the server -.. code-block:: perl +.. code-block:: c char *key= "foo"; char *value; @@ -108,7 +106,7 @@ Fetching multiple values -.. code-block:: perl +.. code-block:: c memcached_return_t rc; char *keys[]= {"fudge", "son", "food"}; diff --git a/docs/libmemcachedutil.rst b/docs/libmemcachedutil.rst index 4fc6c792..b942ed7f 100644 --- a/docs/libmemcachedutil.rst +++ b/docs/libmemcachedutil.rst @@ -1,6 +1,6 @@ -================ -libmemcachedutil -================ +=========== +Introducing +=========== Utility library for libmemcached @@ -11,7 +11,7 @@ LIBRARY ------- -C Client Library containing utility functions for libmemcached (libmemcachedutil, -lmemcachedutil) +C Client Library containing utility functions for libmemcached (libmemcachedutil, -lmemcachedutil -lmemcached) -------- diff --git a/docs/man/hashkit_clone.3 b/docs/man/hashkit_clone.3 index 87f1e86a..838e3b1b 100644 --- a/docs/man/hashkit_clone.3 +++ b/docs/man/hashkit_clone.3 @@ -81,7 +81,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/hashkit_crc32.3 b/docs/man/hashkit_crc32.3 index b9502251..4ddaa14e 100644 --- a/docs/man/hashkit_crc32.3 +++ b/docs/man/hashkit_crc32.3 @@ -75,7 +75,7 @@ hashkit_set_continuum_hash_fn(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/hashkit_create.3 b/docs/man/hashkit_create.3 index b1864ca1..429719e5 100644 --- a/docs/man/hashkit_create.3 +++ b/docs/man/hashkit_create.3 @@ -81,7 +81,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/hashkit_fnv1_32.3 b/docs/man/hashkit_fnv1_32.3 index 94dd7aaa..55cde40b 100644 --- a/docs/man/hashkit_fnv1_32.3 +++ b/docs/man/hashkit_fnv1_32.3 @@ -75,7 +75,7 @@ hashkit_set_continuum_hash_fn(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/hashkit_fnv1_64.3 b/docs/man/hashkit_fnv1_64.3 index a9ece2d9..3e7d2cfe 100644 --- a/docs/man/hashkit_fnv1_64.3 +++ b/docs/man/hashkit_fnv1_64.3 @@ -75,7 +75,7 @@ hashkit_set_continuum_hash_fn(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/hashkit_fnv1a_32.3 b/docs/man/hashkit_fnv1a_32.3 index 82951a02..7dbf69a2 100644 --- a/docs/man/hashkit_fnv1a_32.3 +++ b/docs/man/hashkit_fnv1a_32.3 @@ -75,7 +75,7 @@ hashkit_set_continuum_hash_fn(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/hashkit_fnv1a_64.3 b/docs/man/hashkit_fnv1a_64.3 index a069f2c6..5a6b7bfd 100644 --- a/docs/man/hashkit_fnv1a_64.3 +++ b/docs/man/hashkit_fnv1a_64.3 @@ -75,7 +75,7 @@ hashkit_set_continuum_hash_fn(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/hashkit_free.3 b/docs/man/hashkit_free.3 index 8736d611..7125cc52 100644 --- a/docs/man/hashkit_free.3 +++ b/docs/man/hashkit_free.3 @@ -81,7 +81,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/hashkit_functions.3 b/docs/man/hashkit_functions.3 index bb2abe21..c840a104 100644 --- a/docs/man/hashkit_functions.3 +++ b/docs/man/hashkit_functions.3 @@ -75,7 +75,7 @@ hashkit_set_continuum_hash_fn(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/hashkit_hsieh.3 b/docs/man/hashkit_hsieh.3 index ee083500..2ae836d3 100644 --- a/docs/man/hashkit_hsieh.3 +++ b/docs/man/hashkit_hsieh.3 @@ -75,7 +75,7 @@ hashkit_set_continuum_hash_fn(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/hashkit_is_allocated.3 b/docs/man/hashkit_is_allocated.3 index b9ec2c74..a8602ae0 100644 --- a/docs/man/hashkit_is_allocated.3 +++ b/docs/man/hashkit_is_allocated.3 @@ -81,7 +81,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/hashkit_jenkins.3 b/docs/man/hashkit_jenkins.3 index 42efe2e8..9cbe2385 100644 --- a/docs/man/hashkit_jenkins.3 +++ b/docs/man/hashkit_jenkins.3 @@ -75,7 +75,7 @@ hashkit_set_continuum_hash_fn(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/hashkit_md5.3 b/docs/man/hashkit_md5.3 index 7dae44f2..310ed3bd 100644 --- a/docs/man/hashkit_md5.3 +++ b/docs/man/hashkit_md5.3 @@ -75,7 +75,7 @@ hashkit_set_continuum_hash_fn(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/hashkit_murmur.3 b/docs/man/hashkit_murmur.3 index 82198927..982275e9 100644 --- a/docs/man/hashkit_murmur.3 +++ b/docs/man/hashkit_murmur.3 @@ -75,7 +75,7 @@ hashkit_set_continuum_hash_fn(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/hashkit_value.3 b/docs/man/hashkit_value.3 index 66d3270b..05d97b9d 100644 --- a/docs/man/hashkit_value.3 +++ b/docs/man/hashkit_value.3 @@ -65,7 +65,7 @@ hashkit_create(3) hashkit_set_distribution(3) hashkit_set_hash_fn(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/libhashkit.3 b/docs/man/libhashkit.3 new file mode 100644 index 00000000..a279d4cc --- /dev/null +++ b/docs/man/libhashkit.3 @@ -0,0 +1,61 @@ +.TH "LIBHASHKIT" "3" "April 08, 2011" "0.47" "libmemcached" +.SH NAME +libhashkit \- libhashkit 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 LIBRARY +.sp +C library collection of useful hashing algorithm (libhashkit, \-lhashkit) +.SH SYNOPSIS +.sp +.nf +.ft C +cc [ flag ... ] file ... \-lhashkit + +#include +.ft P +.fi +.SH DESCRIPTION +.sp +\fBlibhashkit\fP is a small and thread\-safe client library that provides a collection of useful hashing algorithm. libhashkit is distributed with libmemcached. +.SH HOME +.sp +To find out more information please check: +\fI\%https://launchpad.net/libmemcached\fP +.SH SEE ALSO +.sp +\fIlibmemcached(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.3 b/docs/man/libmemcached.3 index 4d0320bc..5b31728e 100644 --- a/docs/man/libmemcached.3 +++ b/docs/man/libmemcached.3 @@ -156,7 +156,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/libmemcached_examples.3 b/docs/man/libmemcached_examples.3 index 64d069d1..4dbb99d7 100644 --- a/docs/man/libmemcached_examples.3 +++ b/docs/man/libmemcached_examples.3 @@ -147,7 +147,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/libmemcachedutil.3 b/docs/man/libmemcachedutil.3 index f427034c..b0d90b01 100644 --- a/docs/man/libmemcachedutil.3 +++ b/docs/man/libmemcachedutil.3 @@ -34,7 +34,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] Utility library for libmemcached .SH LIBRARY .sp -C Client Library containing utility functions for libmemcached (libmemcachedutil, \-lmemcachedutil) +C Client Library containing utility functions for libmemcached (libmemcachedutil, \-lmemcachedutil \-lmemcached) .SH SYNOPSIS .sp .nf @@ -65,7 +65,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memaslap.1 b/docs/man/memaslap.1 index 3b5a2b8a..f9dac052 100644 --- a/docs/man/memaslap.1 +++ b/docs/man/memaslap.1 @@ -30,15 +30,11 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . -.sp -memaslap \- Load testing and benchmarking tool for memcached .SH SYNOPSIS -.sp -.nf -.ft C -memaslap [options] -.ft P -.fi +.INDENT 0.0 +.TP +.B \-\-help +.UNINDENT .SH DESCRIPTION .sp \fBmemaslap\fP is a load generation and benchmark tool for memcached(1) @@ -528,7 +524,7 @@ Below is a sample configuration file: .sp .nf .ft C -*************************************************************************** +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- #comments should start with \(aq#\(aq #key #start_len end_len proportion @@ -1214,11 +1210,11 @@ Mingqiang Zhuang <\fI\%mingqiangzhuang@hengtiansoft.com\fP> (Schooner Technolgy) Brian Aker, <\fI\%brian@tangent.org\fP> .SH SEE ALSO .sp -\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP +\fImemcached(1)\fP \fIlibmemcached(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_add.3 b/docs/man/memcached_add.3 index 40857986..0d175863 100644 --- a/docs/man/memcached_add.3 +++ b/docs/man/memcached_add.3 @@ -207,7 +207,7 @@ memcached(1) libmemached(3) memcached_strerror(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_add_by_key.3 b/docs/man/memcached_add_by_key.3 index b1ff99d3..8ccb91a1 100644 --- a/docs/man/memcached_add_by_key.3 +++ b/docs/man/memcached_add_by_key.3 @@ -207,7 +207,7 @@ memcached(1) libmemached(3) memcached_strerror(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_analyze.3 b/docs/man/memcached_analyze.3 index 80f37b7c..7e8382c0 100644 --- a/docs/man/memcached_analyze.3 +++ b/docs/man/memcached_analyze.3 @@ -77,7 +77,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_append.3 b/docs/man/memcached_append.3 index c28c9c0f..44009525 100644 --- a/docs/man/memcached_append.3 +++ b/docs/man/memcached_append.3 @@ -207,7 +207,7 @@ memcached(1) libmemached(3) memcached_strerror(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_append_by_key.3 b/docs/man/memcached_append_by_key.3 index 23384276..d0aaa8bf 100644 --- a/docs/man/memcached_append_by_key.3 +++ b/docs/man/memcached_append_by_key.3 @@ -207,7 +207,7 @@ memcached(1) libmemached(3) memcached_strerror(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_auto.3 b/docs/man/memcached_auto.3 index acd77021..ded157eb 100644 --- a/docs/man/memcached_auto.3 +++ b/docs/man/memcached_auto.3 @@ -162,7 +162,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_behavior.3 b/docs/man/memcached_behavior.3 index 2524ab84..ef9ed1b0 100644 --- a/docs/man/memcached_behavior.3 +++ b/docs/man/memcached_behavior.3 @@ -462,7 +462,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_behavior_get.3 b/docs/man/memcached_behavior_get.3 index 37ddd88b..9b4eb1cd 100644 --- a/docs/man/memcached_behavior_get.3 +++ b/docs/man/memcached_behavior_get.3 @@ -462,7 +462,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_behavior_set.3 b/docs/man/memcached_behavior_set.3 index 2719ec7c..4654771a 100644 --- a/docs/man/memcached_behavior_set.3 +++ b/docs/man/memcached_behavior_set.3 @@ -462,7 +462,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_callback.3 b/docs/man/memcached_callback.3 index 39be97f6..ebd9fc90 100644 --- a/docs/man/memcached_callback.3 +++ b/docs/man/memcached_callback.3 @@ -35,24 +35,18 @@ Get and set a callback .SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS +.SH SYNOPSIS .sp -.nf -.ft C #include - -memcached_return_t - memcached_callback_set (memcached_st *ptr, - memcached_callback_t flag, - void *data); - -void * - memcached_callback_get (memcached_st *ptr, - memcached_callback_t flag, - memcached_return_t *error); -.ft P -.fi -.SS DESCRIPTION +.INDENT 0.0 +.TP +.B memcached_return_t memcached_callback_set (memcached_st *ptr, memcached_callback_t flag, void *data); +.UNINDENT +.INDENT 0.0 +.TP +.B void * memcached_callback_get (memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error); +.UNINDENT +.SH DESCRIPTION .sp libmemcached(3) can have callbacks set key execution points. These either provide function calls at points in the code, or return pointers to @@ -66,29 +60,24 @@ callback flag. No connections are reset. .sp You can use MEMCACHED_CALLBACK_USER_DATA to provide custom context if required for any of the callbacks -.sp -MEMCACHED_CALLBACK_CLEANUP_FUNCTION .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_CLEANUP_FUNCTION +. When memcached_delete() is called this function will be excuted. At the point of its execution all connections have been closed. .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_CLONE_FUNCTION .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_CLONE_FUNCTION +. When memcached_delete() is called this function will be excuted. At the point of its execution all connections have been closed. .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_PREFIX_KEY .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_PREFIX_KEY +. You can set a value which will be used to create a domain for your keys. The value specified here will be prefixed to each of your keys. The value can not be greater then MEMCACHED_PREFIX_KEY_MAX_SIZE \- 1 and will reduce MEMCACHED_MAX_KEY by @@ -98,46 +87,36 @@ of a key which is too long MEMCACHED_BAD_KEY_PROVIDED will be returned. .sp If you set a value with the value being NULL then the prefix key is disabled. .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_USER_DATA .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_USER_DATA +. This allows you to store a pointer to a specifc piece of data. This can be retrieved from inside of memcached_fetch_execute(). Cloning a memcached_st will copy the pointer to the clone. .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_MALLOC_FUNCTION .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_MALLOC_FUNCTION +. DEPRECATED: use memcached_set_memory_allocators instead. .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_REALLOC_FUNCTION .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_REALLOC_FUNCTION +. DEPRECATED: use memcached_set_memory_allocators instead. .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_FREE_FUNCTION .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_FREE_FUNCTION +. DEPRECATED: use memcached_set_memory_allocators instead. .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_GET_FAILURE .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_GET_FAILURE +. This function implements the read through cache behavior. On failure of retrieval this callback will be called. You are responsible for populating the result object provided. This result object will then be stored in the server and returned to the calling process. You must clone the memcached_st in order to @@ -148,19 +127,14 @@ cause the object to be buffered and not sent immediatly (if this is the default The prototype for this is: memcached_return_t (*memcached_trigger_key)(memcached_st *ptr, char *key, size_t key_length, memcached_result_st *result); .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_DELETE_TRIGGER .INDENT 0.0 -.INDENT 3.5 +.TP +.B MEMCACHED_CALLBACK_DELETE_TRIGGER +.UNINDENT .sp -This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned -in order to make use of it. +This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned in order to make use of it. .sp -The prototype for this is: -typedef memcached_return_t (*memcached_trigger_delete_key)(memcached_st *ptr, char *key, size_t key_length); -.UNINDENT -.UNINDENT +The prototype for this is: typedef memcached_return_t (*memcached_trigger_delete_key)(memcached_st *ptr, char *key, size_t key_length); .SH RETURN .sp memcached_callback_get() return the function or structure that was provided. @@ -176,13 +150,13 @@ To find out more information please check: .SH AUTHOR .sp Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_callback_get.3 b/docs/man/memcached_callback_get.3 index d245c78f..beeed3d2 100644 --- a/docs/man/memcached_callback_get.3 +++ b/docs/man/memcached_callback_get.3 @@ -35,24 +35,18 @@ Get and set a callback .SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS +.SH SYNOPSIS .sp -.nf -.ft C #include - -memcached_return_t - memcached_callback_set (memcached_st *ptr, - memcached_callback_t flag, - void *data); - -void * - memcached_callback_get (memcached_st *ptr, - memcached_callback_t flag, - memcached_return_t *error); -.ft P -.fi -.SS DESCRIPTION +.INDENT 0.0 +.TP +.B memcached_return_t memcached_callback_set (memcached_st *ptr, memcached_callback_t flag, void *data); +.UNINDENT +.INDENT 0.0 +.TP +.B void * memcached_callback_get (memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error); +.UNINDENT +.SH DESCRIPTION .sp libmemcached(3) can have callbacks set key execution points. These either provide function calls at points in the code, or return pointers to @@ -66,29 +60,24 @@ callback flag. No connections are reset. .sp You can use MEMCACHED_CALLBACK_USER_DATA to provide custom context if required for any of the callbacks -.sp -MEMCACHED_CALLBACK_CLEANUP_FUNCTION .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_CLEANUP_FUNCTION +. When memcached_delete() is called this function will be excuted. At the point of its execution all connections have been closed. .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_CLONE_FUNCTION .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_CLONE_FUNCTION +. When memcached_delete() is called this function will be excuted. At the point of its execution all connections have been closed. .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_PREFIX_KEY .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_PREFIX_KEY +. You can set a value which will be used to create a domain for your keys. The value specified here will be prefixed to each of your keys. The value can not be greater then MEMCACHED_PREFIX_KEY_MAX_SIZE \- 1 and will reduce MEMCACHED_MAX_KEY by @@ -98,46 +87,36 @@ of a key which is too long MEMCACHED_BAD_KEY_PROVIDED will be returned. .sp If you set a value with the value being NULL then the prefix key is disabled. .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_USER_DATA .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_USER_DATA +. This allows you to store a pointer to a specifc piece of data. This can be retrieved from inside of memcached_fetch_execute(). Cloning a memcached_st will copy the pointer to the clone. .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_MALLOC_FUNCTION .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_MALLOC_FUNCTION +. DEPRECATED: use memcached_set_memory_allocators instead. .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_REALLOC_FUNCTION .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_REALLOC_FUNCTION +. DEPRECATED: use memcached_set_memory_allocators instead. .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_FREE_FUNCTION .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_FREE_FUNCTION +. DEPRECATED: use memcached_set_memory_allocators instead. .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_GET_FAILURE .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_GET_FAILURE +. This function implements the read through cache behavior. On failure of retrieval this callback will be called. You are responsible for populating the result object provided. This result object will then be stored in the server and returned to the calling process. You must clone the memcached_st in order to @@ -148,19 +127,14 @@ cause the object to be buffered and not sent immediatly (if this is the default The prototype for this is: memcached_return_t (*memcached_trigger_key)(memcached_st *ptr, char *key, size_t key_length, memcached_result_st *result); .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_DELETE_TRIGGER .INDENT 0.0 -.INDENT 3.5 +.TP +.B MEMCACHED_CALLBACK_DELETE_TRIGGER +.UNINDENT .sp -This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned -in order to make use of it. +This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned in order to make use of it. .sp -The prototype for this is: -typedef memcached_return_t (*memcached_trigger_delete_key)(memcached_st *ptr, char *key, size_t key_length); -.UNINDENT -.UNINDENT +The prototype for this is: typedef memcached_return_t (*memcached_trigger_delete_key)(memcached_st *ptr, char *key, size_t key_length); .SH RETURN .sp memcached_callback_get() return the function or structure that was provided. @@ -176,13 +150,13 @@ To find out more information please check: .SH AUTHOR .sp Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_callback_set.3 b/docs/man/memcached_callback_set.3 index 597a54fe..388b51a7 100644 --- a/docs/man/memcached_callback_set.3 +++ b/docs/man/memcached_callback_set.3 @@ -35,24 +35,18 @@ Get and set a callback .SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS +.SH SYNOPSIS .sp -.nf -.ft C #include - -memcached_return_t - memcached_callback_set (memcached_st *ptr, - memcached_callback_t flag, - void *data); - -void * - memcached_callback_get (memcached_st *ptr, - memcached_callback_t flag, - memcached_return_t *error); -.ft P -.fi -.SS DESCRIPTION +.INDENT 0.0 +.TP +.B memcached_return_t memcached_callback_set (memcached_st *ptr, memcached_callback_t flag, void *data); +.UNINDENT +.INDENT 0.0 +.TP +.B void * memcached_callback_get (memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error); +.UNINDENT +.SH DESCRIPTION .sp libmemcached(3) can have callbacks set key execution points. These either provide function calls at points in the code, or return pointers to @@ -66,29 +60,24 @@ callback flag. No connections are reset. .sp You can use MEMCACHED_CALLBACK_USER_DATA to provide custom context if required for any of the callbacks -.sp -MEMCACHED_CALLBACK_CLEANUP_FUNCTION .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_CLEANUP_FUNCTION +. When memcached_delete() is called this function will be excuted. At the point of its execution all connections have been closed. .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_CLONE_FUNCTION .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_CLONE_FUNCTION +. When memcached_delete() is called this function will be excuted. At the point of its execution all connections have been closed. .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_PREFIX_KEY .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_PREFIX_KEY +. You can set a value which will be used to create a domain for your keys. The value specified here will be prefixed to each of your keys. The value can not be greater then MEMCACHED_PREFIX_KEY_MAX_SIZE \- 1 and will reduce MEMCACHED_MAX_KEY by @@ -98,46 +87,36 @@ of a key which is too long MEMCACHED_BAD_KEY_PROVIDED will be returned. .sp If you set a value with the value being NULL then the prefix key is disabled. .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_USER_DATA .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_USER_DATA +. This allows you to store a pointer to a specifc piece of data. This can be retrieved from inside of memcached_fetch_execute(). Cloning a memcached_st will copy the pointer to the clone. .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_MALLOC_FUNCTION .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_MALLOC_FUNCTION +. DEPRECATED: use memcached_set_memory_allocators instead. .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_REALLOC_FUNCTION .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_REALLOC_FUNCTION +. DEPRECATED: use memcached_set_memory_allocators instead. .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_FREE_FUNCTION .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_FREE_FUNCTION +. DEPRECATED: use memcached_set_memory_allocators instead. .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_GET_FAILURE .INDENT 0.0 -.INDENT 3.5 -.sp +.TP +.B MEMCACHED_CALLBACK_GET_FAILURE +. This function implements the read through cache behavior. On failure of retrieval this callback will be called. You are responsible for populating the result object provided. This result object will then be stored in the server and returned to the calling process. You must clone the memcached_st in order to @@ -148,19 +127,14 @@ cause the object to be buffered and not sent immediatly (if this is the default The prototype for this is: memcached_return_t (*memcached_trigger_key)(memcached_st *ptr, char *key, size_t key_length, memcached_result_st *result); .UNINDENT -.UNINDENT -.sp -MEMCACHED_CALLBACK_DELETE_TRIGGER .INDENT 0.0 -.INDENT 3.5 +.TP +.B MEMCACHED_CALLBACK_DELETE_TRIGGER +.UNINDENT .sp -This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned -in order to make use of it. +This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned in order to make use of it. .sp -The prototype for this is: -typedef memcached_return_t (*memcached_trigger_delete_key)(memcached_st *ptr, char *key, size_t key_length); -.UNINDENT -.UNINDENT +The prototype for this is: typedef memcached_return_t (*memcached_trigger_delete_key)(memcached_st *ptr, char *key, size_t key_length); .SH RETURN .sp memcached_callback_get() return the function or structure that was provided. @@ -176,13 +150,13 @@ To find out more information please check: .SH AUTHOR .sp Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_cas.3 b/docs/man/memcached_cas.3 index 96d266ba..b17ae5fd 100644 --- a/docs/man/memcached_cas.3 +++ b/docs/man/memcached_cas.3 @@ -207,7 +207,7 @@ memcached(1) libmemached(3) memcached_strerror(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_cas_by_key.3 b/docs/man/memcached_cas_by_key.3 index 7bbdcf4a..76ec3cdb 100644 --- a/docs/man/memcached_cas_by_key.3 +++ b/docs/man/memcached_cas_by_key.3 @@ -207,7 +207,7 @@ memcached(1) libmemached(3) memcached_strerror(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_clone.3 b/docs/man/memcached_clone.3 index 232e8791..7b4a9010 100644 --- a/docs/man/memcached_clone.3 +++ b/docs/man/memcached_clone.3 @@ -35,22 +35,26 @@ Create a memcached_st structure .SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS +.SH SYNOPSIS .sp -.nf -.ft C #include - -memcached_st *memcached_create (memcached_st *ptr); - -void memcached_free (memcached_st *ptr); - -memcached_st *memcached_clone (memcached_st *destination, memcached_st *source); - -void memcached_servers_reset(memcached_st); -.ft P -.fi -.SS DESCRIPTION +.INDENT 0.0 +.TP +.B memcached_st *memcached_create (memcached_st *ptr); +.UNINDENT +.INDENT 0.0 +.TP +.B void memcached_free (memcached_st *ptr); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st *memcached_clone (memcached_st *destination, memcached_st *source); +.UNINDENT +.INDENT 0.0 +.TP +.B void memcached_servers_reset(memcached_st); +.UNINDENT +.SH DESCRIPTION .sp memcached_create() is used to create a \fBmemcached_st\fP structure that will then be used by other libmemcached(3) functions to communicate with the server. You @@ -87,13 +91,13 @@ To find out more information please check: .SH AUTHOR .sp Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_create.3 b/docs/man/memcached_create.3 index 2dec82ca..702e2005 100644 --- a/docs/man/memcached_create.3 +++ b/docs/man/memcached_create.3 @@ -35,22 +35,26 @@ Create a memcached_st structure .SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS +.SH SYNOPSIS .sp -.nf -.ft C #include - -memcached_st *memcached_create (memcached_st *ptr); - -void memcached_free (memcached_st *ptr); - -memcached_st *memcached_clone (memcached_st *destination, memcached_st *source); - -void memcached_servers_reset(memcached_st); -.ft P -.fi -.SS DESCRIPTION +.INDENT 0.0 +.TP +.B memcached_st *memcached_create (memcached_st *ptr); +.UNINDENT +.INDENT 0.0 +.TP +.B void memcached_free (memcached_st *ptr); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st *memcached_clone (memcached_st *destination, memcached_st *source); +.UNINDENT +.INDENT 0.0 +.TP +.B void memcached_servers_reset(memcached_st); +.UNINDENT +.SH DESCRIPTION .sp memcached_create() is used to create a \fBmemcached_st\fP structure that will then be used by other libmemcached(3) functions to communicate with the server. You @@ -87,13 +91,13 @@ To find out more information please check: .SH AUTHOR .sp Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_decrement.3 b/docs/man/memcached_decrement.3 index df61e910..16901332 100644 --- a/docs/man/memcached_decrement.3 +++ b/docs/man/memcached_decrement.3 @@ -162,7 +162,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_decrement_with_initial.3 b/docs/man/memcached_decrement_with_initial.3 index 66654fa6..aefcc9c4 100644 --- a/docs/man/memcached_decrement_with_initial.3 +++ b/docs/man/memcached_decrement_with_initial.3 @@ -162,7 +162,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_delete.3 b/docs/man/memcached_delete.3 index 81a32682..dafd45ab 100644 --- a/docs/man/memcached_delete.3 +++ b/docs/man/memcached_delete.3 @@ -35,25 +35,18 @@ Delete a key .SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS +.SH SYNOPSIS .sp .nf .ft C #include -memcached_return_t - memcached_delete (memcached_st *ptr, - const char *key, size_t key_length, - time_t expiration); +memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration); -memcached_return_t -memcached_delete_by_key (memcached_st *ptr, - const char *master_key, size_t master_key_length, - const char *key, size_t key_length, - time_t expiration); +memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *master_key, size_t master_key_length, const char *key, size_t key_length, time_t expiration); .ft P .fi -.SS DESCRIPTION +.SH DESCRIPTION .sp memcached_delete() is used to delete a particular key. memcached_delete_by_key() works the same, but it takes a master key to @@ -81,13 +74,13 @@ To find out more information please check: .SH AUTHOR .sp Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_delete_by_key.3 b/docs/man/memcached_delete_by_key.3 index 9e8b04f9..387ee5b6 100644 --- a/docs/man/memcached_delete_by_key.3 +++ b/docs/man/memcached_delete_by_key.3 @@ -35,25 +35,18 @@ Delete a key .SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS +.SH SYNOPSIS .sp .nf .ft C #include -memcached_return_t - memcached_delete (memcached_st *ptr, - const char *key, size_t key_length, - time_t expiration); +memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration); -memcached_return_t -memcached_delete_by_key (memcached_st *ptr, - const char *master_key, size_t master_key_length, - const char *key, size_t key_length, - time_t expiration); +memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *master_key, size_t master_key_length, const char *key, size_t key_length, time_t expiration); .ft P .fi -.SS DESCRIPTION +.SH DESCRIPTION .sp memcached_delete() is used to delete a particular key. memcached_delete_by_key() works the same, but it takes a master key to @@ -81,13 +74,13 @@ To find out more information please check: .SH AUTHOR .sp Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_destroy_sasl_auth_data.3 b/docs/man/memcached_destroy_sasl_auth_data.3 index 811aad44..553c07d9 100644 --- a/docs/man/memcached_destroy_sasl_auth_data.3 +++ b/docs/man/memcached_destroy_sasl_auth_data.3 @@ -30,11 +30,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . -.sp -memcached_set_sasl_callbacks, memcached_get_sasl_callbacks, memcached_sasl_set_auth_data, memcached_destroy_sasl_auth_data -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-** -.sp -SASL tests +.SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) .SH SYNOPSIS @@ -72,13 +68,18 @@ specify your own callback function with memcached_set_sasl_callbacks(). You as a client user have to initialize libsasl by using sasl_client_init before enabling it in libmemcached, and you have to shut down libsasl by calling sasl_done() when you are done using SASL from libmemcached. +.SH RETURN .sp memcached_get_sasl_callbacks() returns the callbacks currently used by this memcached handle. memcached_get_sasl_set_auth_data() returns MEMCACHED_SUCCESS upon success. +.SH HOME .sp To find out more information please check: \fI\%http://libmemcached.org/\fP +.SH AUTHOR +.sp +Brian Aker, <\fI\%brian@tangent.org\fP> .sp Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> .SH SEE ALSO @@ -87,7 +88,7 @@ Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_dump.3 b/docs/man/memcached_dump.3 index 388f6ad1..7579d28f 100644 --- a/docs/man/memcached_dump.3 +++ b/docs/man/memcached_dump.3 @@ -35,7 +35,7 @@ Get a list of keys found on memcached servers .SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS +.SH SYNOPSIS .sp .nf .ft C @@ -53,7 +53,7 @@ typedef memcached_return_t (*memcached_dump_fn)(memcached_st *ptr, void *context); .ft P .fi -.SS DESCRIPTION +.SH DESCRIPTION .sp memcached_dump() is used to get a list of keys found memcached(1) servers. Because memcached(1) does not guarentee to dump all keys you can not assume @@ -73,13 +73,13 @@ To find out more information please check: .SH AUTHOR .sp Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_fetch.3 b/docs/man/memcached_fetch.3 index 0a557e1c..3fabb271 100644 --- a/docs/man/memcached_fetch.3 +++ b/docs/man/memcached_fetch.3 @@ -200,7 +200,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_fetch_execute.3 b/docs/man/memcached_fetch_execute.3 index 729953d8..2bf3560b 100644 --- a/docs/man/memcached_fetch_execute.3 +++ b/docs/man/memcached_fetch_execute.3 @@ -200,7 +200,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_fetch_result.3 b/docs/man/memcached_fetch_result.3 index 5f121187..95dd4297 100644 --- a/docs/man/memcached_fetch_result.3 +++ b/docs/man/memcached_fetch_result.3 @@ -200,7 +200,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_flush.3 b/docs/man/memcached_flush.3 index ff594898..c1d408a8 100644 --- a/docs/man/memcached_flush.3 +++ b/docs/man/memcached_flush.3 @@ -31,10 +31,8 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" Man page generated from reStructeredText. . .sp -memcached_flush -\-\-\-\-\-\-\-\-\-\-\-\-\-\-* -.sp Wipe contents of memcached servers +.SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) .SH SYNOPSIS @@ -56,13 +54,16 @@ expiration time passed to the method (a value of zero causes an immediate flush). The operation is not atomic to multiple servers, just atomic to a single server. That is, it will flush the servers in the order that they were added. +.SH RETURN .sp A value of type \fBmemcached_return_t\fP is returned On success that value will be \fBMEMCACHED_SUCCESS\fP. Use memcached_strerror() to translate this value to a printable string. +.SH HOME .sp To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP +.SH AUTHOR .sp Brian Aker, <\fI\%brian@tangent.org\fP> .SH SEE ALSO @@ -71,7 +72,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_flush_buffers.3 b/docs/man/memcached_flush_buffers.3 index 3924bb6a..16e1e374 100644 --- a/docs/man/memcached_flush_buffers.3 +++ b/docs/man/memcached_flush_buffers.3 @@ -31,34 +31,34 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" Man page generated from reStructeredText. . .sp -memcached_flush_buffers -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-* -.sp Flush buffers and send buffered commands +.SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) .SH SYNOPSIS .sp -.nf -.ft C #include - -memcached_return_t - memcached_flush_buffers (memcached_st *ptr); -.ft P -.fi +.INDENT 0.0 +.TP +.B memcached_return_t memcached_flush_buffers (memcached_st *ptr); +.UNINDENT .SH DESCRIPTION .sp memcached_flush_buffers() is used in conjunction with MEMCACHED_BEHAVIOR_BUFFER_REQUESTS (see memcached_behavior(3)) to flush all buffers by sending the buffered commands to the server for processing. +.SH RETURN .sp A value of type \fBmemcached_return_t\fP is returned On success that value will be \fBMEMCACHED_SUCCESS\fP. Use memcached_strerror() to translate this value to a printable string. +.SH HOME .sp To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP +.SH AUTHOR +.sp +Brian Aker, <\fI\%brian@tangent.org\fP> .sp Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> .SH SEE ALSO @@ -67,7 +67,7 @@ Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_free.3 b/docs/man/memcached_free.3 index 5615541a..2cdf64be 100644 --- a/docs/man/memcached_free.3 +++ b/docs/man/memcached_free.3 @@ -35,22 +35,26 @@ Create a memcached_st structure .SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS +.SH SYNOPSIS .sp -.nf -.ft C #include - -memcached_st *memcached_create (memcached_st *ptr); - -void memcached_free (memcached_st *ptr); - -memcached_st *memcached_clone (memcached_st *destination, memcached_st *source); - -void memcached_servers_reset(memcached_st); -.ft P -.fi -.SS DESCRIPTION +.INDENT 0.0 +.TP +.B memcached_st *memcached_create (memcached_st *ptr); +.UNINDENT +.INDENT 0.0 +.TP +.B void memcached_free (memcached_st *ptr); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st *memcached_clone (memcached_st *destination, memcached_st *source); +.UNINDENT +.INDENT 0.0 +.TP +.B void memcached_servers_reset(memcached_st); +.UNINDENT +.SH DESCRIPTION .sp memcached_create() is used to create a \fBmemcached_st\fP structure that will then be used by other libmemcached(3) functions to communicate with the server. You @@ -87,13 +91,13 @@ To find out more information please check: .SH AUTHOR .sp Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_generate_hash_value.3 b/docs/man/memcached_generate_hash_value.3 index 5034b0d8..614e1d9a 100644 --- a/docs/man/memcached_generate_hash_value.3 +++ b/docs/man/memcached_generate_hash_value.3 @@ -31,10 +31,8 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" Man page generated from reStructeredText. . .sp -memcached_generate_hash_value -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-** -.sp Hash a key value +.SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) .SH SYNOPSIS @@ -69,14 +67,17 @@ the hash value that would have been generated based on the defaults of the memcached_st structure. .sp As of version 0.36 all hash methods have been placed into the library -libmemcached(3) which is linked with libmemcached(3). +libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation. +.SH RETURN .sp A 32\-bit integer which is the result of hashing the given key. For 64\-bit hash algorithms, only the least\-significant 32 bits are returned. +.SH HOME .sp To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP +.SH AUTHOR .sp Brian Aker, <\fI\%brian@tangent.org\fP> .SH SEE ALSO @@ -85,7 +86,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_get.3 b/docs/man/memcached_get.3 index ecc85af3..b8f7fb75 100644 --- a/docs/man/memcached_get.3 +++ b/docs/man/memcached_get.3 @@ -200,7 +200,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_get_by_key.3 b/docs/man/memcached_get_by_key.3 index 5c370fa4..cb58fc6e 100644 --- a/docs/man/memcached_get_by_key.3 +++ b/docs/man/memcached_get_by_key.3 @@ -200,7 +200,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_get_memory_allocators.3 b/docs/man/memcached_get_memory_allocators.3 index 21db78ac..e861780b 100644 --- a/docs/man/memcached_get_memory_allocators.3 +++ b/docs/man/memcached_get_memory_allocators.3 @@ -96,7 +96,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_get_sasl_callbacks.3 b/docs/man/memcached_get_sasl_callbacks.3 index d82176d8..180d3c1d 100644 --- a/docs/man/memcached_get_sasl_callbacks.3 +++ b/docs/man/memcached_get_sasl_callbacks.3 @@ -30,11 +30,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . -.sp -memcached_set_sasl_callbacks, memcached_get_sasl_callbacks, memcached_sasl_set_auth_data, memcached_destroy_sasl_auth_data -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-** -.sp -SASL tests +.SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) .SH SYNOPSIS @@ -72,13 +68,18 @@ specify your own callback function with memcached_set_sasl_callbacks(). You as a client user have to initialize libsasl by using sasl_client_init before enabling it in libmemcached, and you have to shut down libsasl by calling sasl_done() when you are done using SASL from libmemcached. +.SH RETURN .sp memcached_get_sasl_callbacks() returns the callbacks currently used by this memcached handle. memcached_get_sasl_set_auth_data() returns MEMCACHED_SUCCESS upon success. +.SH HOME .sp To find out more information please check: \fI\%http://libmemcached.org/\fP +.SH AUTHOR +.sp +Brian Aker, <\fI\%brian@tangent.org\fP> .sp Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> .SH SEE ALSO @@ -87,7 +88,7 @@ Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_get_user_data.3 b/docs/man/memcached_get_user_data.3 index 03bd1b7a..a24b5c38 100644 --- a/docs/man/memcached_get_user_data.3 +++ b/docs/man/memcached_get_user_data.3 @@ -76,7 +76,7 @@ memcached(1) libmemcached(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_increment.3 b/docs/man/memcached_increment.3 index e14f194e..96a41ecf 100644 --- a/docs/man/memcached_increment.3 +++ b/docs/man/memcached_increment.3 @@ -162,7 +162,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_increment_with_initial.3 b/docs/man/memcached_increment_with_initial.3 index bb319e5e..41aef50a 100644 --- a/docs/man/memcached_increment_with_initial.3 +++ b/docs/man/memcached_increment_with_initial.3 @@ -162,7 +162,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_lib_version.3 b/docs/man/memcached_lib_version.3 index 81be835f..5312422a 100644 --- a/docs/man/memcached_lib_version.3 +++ b/docs/man/memcached_lib_version.3 @@ -79,7 +79,7 @@ memcached(1) libmemcached(3) memcached_strerror(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_memory_allocators.3 b/docs/man/memcached_memory_allocators.3 index 2a64aa33..2eb23fdb 100644 --- a/docs/man/memcached_memory_allocators.3 +++ b/docs/man/memcached_memory_allocators.3 @@ -96,7 +96,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_mget.3 b/docs/man/memcached_mget.3 index c8d773d9..c942e2dc 100644 --- a/docs/man/memcached_mget.3 +++ b/docs/man/memcached_mget.3 @@ -200,7 +200,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_mget_by_key.3 b/docs/man/memcached_mget_by_key.3 index 14287f10..8e921d42 100644 --- a/docs/man/memcached_mget_by_key.3 +++ b/docs/man/memcached_mget_by_key.3 @@ -200,7 +200,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_mget_execute.3 b/docs/man/memcached_mget_execute.3 index a028fc1a..430d419d 100644 --- a/docs/man/memcached_mget_execute.3 +++ b/docs/man/memcached_mget_execute.3 @@ -200,7 +200,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_mget_execute_by_key.3 b/docs/man/memcached_mget_execute_by_key.3 index 35e416fb..e43cba7a 100644 --- a/docs/man/memcached_mget_execute_by_key.3 +++ b/docs/man/memcached_mget_execute_by_key.3 @@ -200,7 +200,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_pool.3 b/docs/man/memcached_pool.3 index 4357aca6..17662a71 100644 --- a/docs/man/memcached_pool.3 +++ b/docs/man/memcached_pool.3 @@ -30,33 +30,40 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . +.SH SYNOPSIS .sp -Manage pools -.SH LIBRARY -.sp -C Client Library for memcached (libmemcachedutil, \-lmemcachedutil) -.SS SYNOPSIS -.sp -.nf -.ft C #include - -memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); - -memcached_st * memcached_pool_destroy(memcached_pool_st* pool); - -memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc); - -memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc); - -memcached_st *memcached_create (memcached_st *ptr); - -memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data) - -memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value) -.ft P -.fi -.SS DESCRIPTION +.INDENT 0.0 +.TP +.B memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st * memcached_pool_destroy(memcached_pool_st* pool); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st *memcached_create (memcached_st *ptr); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_behavior_set(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_behavior_get(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ *value\fP) +.UNINDENT +.sp +Compile and link with \-lmemcachedutil \-lmemcached +.SH DESCRIPTION .sp memcached_pool_create() is used to create a connection pool of objects you may use to remove the overhead of using memcached_clone for short @@ -107,14 +114,16 @@ To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP .SH AUTHOR .sp +Brian Aker, <\fI\%brian@tangent.org\fP> +.sp Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_pool_behavior_get.3 b/docs/man/memcached_pool_behavior_get.3 index cd86a98d..ea9aa1c3 100644 --- a/docs/man/memcached_pool_behavior_get.3 +++ b/docs/man/memcached_pool_behavior_get.3 @@ -30,33 +30,40 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . +.SH SYNOPSIS .sp -Manage pools -.SH LIBRARY -.sp -C Client Library for memcached (libmemcachedutil, \-lmemcachedutil) -.SS SYNOPSIS -.sp -.nf -.ft C #include - -memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); - -memcached_st * memcached_pool_destroy(memcached_pool_st* pool); - -memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc); - -memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc); - -memcached_st *memcached_create (memcached_st *ptr); - -memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data) - -memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value) -.ft P -.fi -.SS DESCRIPTION +.INDENT 0.0 +.TP +.B memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st * memcached_pool_destroy(memcached_pool_st* pool); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st *memcached_create (memcached_st *ptr); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_behavior_set(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_behavior_get(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ *value\fP) +.UNINDENT +.sp +Compile and link with \-lmemcachedutil \-lmemcached +.SH DESCRIPTION .sp memcached_pool_create() is used to create a connection pool of objects you may use to remove the overhead of using memcached_clone for short @@ -107,14 +114,16 @@ To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP .SH AUTHOR .sp +Brian Aker, <\fI\%brian@tangent.org\fP> +.sp Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_pool_behavior_set.3 b/docs/man/memcached_pool_behavior_set.3 index 0729736c..b2c07126 100644 --- a/docs/man/memcached_pool_behavior_set.3 +++ b/docs/man/memcached_pool_behavior_set.3 @@ -30,33 +30,40 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . +.SH SYNOPSIS .sp -Manage pools -.SH LIBRARY -.sp -C Client Library for memcached (libmemcachedutil, \-lmemcachedutil) -.SS SYNOPSIS -.sp -.nf -.ft C #include - -memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); - -memcached_st * memcached_pool_destroy(memcached_pool_st* pool); - -memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc); - -memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc); - -memcached_st *memcached_create (memcached_st *ptr); - -memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data) - -memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value) -.ft P -.fi -.SS DESCRIPTION +.INDENT 0.0 +.TP +.B memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st * memcached_pool_destroy(memcached_pool_st* pool); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st *memcached_create (memcached_st *ptr); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_behavior_set(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_behavior_get(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ *value\fP) +.UNINDENT +.sp +Compile and link with \-lmemcachedutil \-lmemcached +.SH DESCRIPTION .sp memcached_pool_create() is used to create a connection pool of objects you may use to remove the overhead of using memcached_clone for short @@ -107,14 +114,16 @@ To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP .SH AUTHOR .sp +Brian Aker, <\fI\%brian@tangent.org\fP> +.sp Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_pool_create.3 b/docs/man/memcached_pool_create.3 index f6611dd8..8171a03a 100644 --- a/docs/man/memcached_pool_create.3 +++ b/docs/man/memcached_pool_create.3 @@ -30,33 +30,40 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . +.SH SYNOPSIS .sp -Manage pools -.SH LIBRARY -.sp -C Client Library for memcached (libmemcachedutil, \-lmemcachedutil) -.SS SYNOPSIS -.sp -.nf -.ft C #include - -memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); - -memcached_st * memcached_pool_destroy(memcached_pool_st* pool); - -memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc); - -memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc); - -memcached_st *memcached_create (memcached_st *ptr); - -memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data) - -memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value) -.ft P -.fi -.SS DESCRIPTION +.INDENT 0.0 +.TP +.B memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st * memcached_pool_destroy(memcached_pool_st* pool); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st *memcached_create (memcached_st *ptr); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_behavior_set(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_behavior_get(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ *value\fP) +.UNINDENT +.sp +Compile and link with \-lmemcachedutil \-lmemcached +.SH DESCRIPTION .sp memcached_pool_create() is used to create a connection pool of objects you may use to remove the overhead of using memcached_clone for short @@ -107,14 +114,16 @@ To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP .SH AUTHOR .sp +Brian Aker, <\fI\%brian@tangent.org\fP> +.sp Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_pool_destroy.3 b/docs/man/memcached_pool_destroy.3 index 63fece13..5573f0b7 100644 --- a/docs/man/memcached_pool_destroy.3 +++ b/docs/man/memcached_pool_destroy.3 @@ -30,33 +30,40 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . +.SH SYNOPSIS .sp -Manage pools -.SH LIBRARY -.sp -C Client Library for memcached (libmemcachedutil, \-lmemcachedutil) -.SS SYNOPSIS -.sp -.nf -.ft C #include - -memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); - -memcached_st * memcached_pool_destroy(memcached_pool_st* pool); - -memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc); - -memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc); - -memcached_st *memcached_create (memcached_st *ptr); - -memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data) - -memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value) -.ft P -.fi -.SS DESCRIPTION +.INDENT 0.0 +.TP +.B memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st * memcached_pool_destroy(memcached_pool_st* pool); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st *memcached_create (memcached_st *ptr); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_behavior_set(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_behavior_get(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ *value\fP) +.UNINDENT +.sp +Compile and link with \-lmemcachedutil \-lmemcached +.SH DESCRIPTION .sp memcached_pool_create() is used to create a connection pool of objects you may use to remove the overhead of using memcached_clone for short @@ -107,14 +114,16 @@ To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP .SH AUTHOR .sp +Brian Aker, <\fI\%brian@tangent.org\fP> +.sp Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_pool_pop.3 b/docs/man/memcached_pool_pop.3 index 1f15cf38..0a787166 100644 --- a/docs/man/memcached_pool_pop.3 +++ b/docs/man/memcached_pool_pop.3 @@ -30,33 +30,40 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . +.SH SYNOPSIS .sp -Manage pools -.SH LIBRARY -.sp -C Client Library for memcached (libmemcachedutil, \-lmemcachedutil) -.SS SYNOPSIS -.sp -.nf -.ft C #include - -memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); - -memcached_st * memcached_pool_destroy(memcached_pool_st* pool); - -memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc); - -memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc); - -memcached_st *memcached_create (memcached_st *ptr); - -memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data) - -memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value) -.ft P -.fi -.SS DESCRIPTION +.INDENT 0.0 +.TP +.B memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st * memcached_pool_destroy(memcached_pool_st* pool); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st *memcached_create (memcached_st *ptr); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_behavior_set(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_behavior_get(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ *value\fP) +.UNINDENT +.sp +Compile and link with \-lmemcachedutil \-lmemcached +.SH DESCRIPTION .sp memcached_pool_create() is used to create a connection pool of objects you may use to remove the overhead of using memcached_clone for short @@ -107,14 +114,16 @@ To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP .SH AUTHOR .sp +Brian Aker, <\fI\%brian@tangent.org\fP> +.sp Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_pool_push.3 b/docs/man/memcached_pool_push.3 index ee0f4cbf..bc0023ec 100644 --- a/docs/man/memcached_pool_push.3 +++ b/docs/man/memcached_pool_push.3 @@ -30,33 +30,40 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . +.SH SYNOPSIS .sp -Manage pools -.SH LIBRARY -.sp -C Client Library for memcached (libmemcachedutil, \-lmemcachedutil) -.SS SYNOPSIS -.sp -.nf -.ft C #include - -memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); - -memcached_st * memcached_pool_destroy(memcached_pool_st* pool); - -memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc); - -memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc); - -memcached_st *memcached_create (memcached_st *ptr); - -memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data) - -memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value) -.ft P -.fi -.SS DESCRIPTION +.INDENT 0.0 +.TP +.B memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st * memcached_pool_destroy(memcached_pool_st* pool); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st *memcached_create (memcached_st *ptr); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_behavior_set(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_behavior_get(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ *value\fP) +.UNINDENT +.sp +Compile and link with \-lmemcachedutil \-lmemcached +.SH DESCRIPTION .sp memcached_pool_create() is used to create a connection pool of objects you may use to remove the overhead of using memcached_clone for short @@ -107,14 +114,16 @@ To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP .SH AUTHOR .sp +Brian Aker, <\fI\%brian@tangent.org\fP> +.sp Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_prepend.3 b/docs/man/memcached_prepend.3 index 18cb3b5c..89a0ac25 100644 --- a/docs/man/memcached_prepend.3 +++ b/docs/man/memcached_prepend.3 @@ -207,7 +207,7 @@ memcached(1) libmemached(3) memcached_strerror(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_prepend_by_key.3 b/docs/man/memcached_prepend_by_key.3 index fce8a183..c85e0532 100644 --- a/docs/man/memcached_prepend_by_key.3 +++ b/docs/man/memcached_prepend_by_key.3 @@ -207,7 +207,7 @@ memcached(1) libmemached(3) memcached_strerror(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_quit.3 b/docs/man/memcached_quit.3 index 371221a9..4691aa6d 100644 --- a/docs/man/memcached_quit.3 +++ b/docs/man/memcached_quit.3 @@ -35,7 +35,7 @@ Disconnect from all servers .SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS +.SH SYNOPSIS .sp .nf .ft C @@ -44,7 +44,7 @@ C Client Library for memcached (libmemcached, \-lmemcached) void memcached_quit (memcached_st *ptr); .ft P .fi -.SS DESCRIPTION +.SH DESCRIPTION .sp memcached_quit() will disconnect you from all currently connected servers. It will also reset the state of the connection (ie, any memcached_fetch() you @@ -67,13 +67,13 @@ To find out more information please check: .SH AUTHOR .sp Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_replace.3 b/docs/man/memcached_replace.3 index 594a7739..b745812b 100644 --- a/docs/man/memcached_replace.3 +++ b/docs/man/memcached_replace.3 @@ -207,7 +207,7 @@ memcached(1) libmemached(3) memcached_strerror(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_replace_by_key.3 b/docs/man/memcached_replace_by_key.3 index ec1ae4b4..29cdd820 100644 --- a/docs/man/memcached_replace_by_key.3 +++ b/docs/man/memcached_replace_by_key.3 @@ -207,7 +207,7 @@ memcached(1) libmemached(3) memcached_strerror(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_result_cas.3 b/docs/man/memcached_result_cas.3 index a9bdbe6e..8b3f859f 100644 --- a/docs/man/memcached_result_cas.3 +++ b/docs/man/memcached_result_cas.3 @@ -134,7 +134,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_result_create.3 b/docs/man/memcached_result_create.3 index 1298b2e3..f4a9cdbf 100644 --- a/docs/man/memcached_result_create.3 +++ b/docs/man/memcached_result_create.3 @@ -134,7 +134,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_result_flags.3 b/docs/man/memcached_result_flags.3 index ab43a42d..579de3c7 100644 --- a/docs/man/memcached_result_flags.3 +++ b/docs/man/memcached_result_flags.3 @@ -134,7 +134,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_result_free.3 b/docs/man/memcached_result_free.3 index dd04da78..621fb724 100644 --- a/docs/man/memcached_result_free.3 +++ b/docs/man/memcached_result_free.3 @@ -134,7 +134,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_result_key_length.3 b/docs/man/memcached_result_key_length.3 index b0049557..9f60c312 100644 --- a/docs/man/memcached_result_key_length.3 +++ b/docs/man/memcached_result_key_length.3 @@ -134,7 +134,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_result_key_value.3 b/docs/man/memcached_result_key_value.3 index feaccfb2..ce9ba0c0 100644 --- a/docs/man/memcached_result_key_value.3 +++ b/docs/man/memcached_result_key_value.3 @@ -134,7 +134,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_result_length.3 b/docs/man/memcached_result_length.3 index 0d6a4ced..88e8184e 100644 --- a/docs/man/memcached_result_length.3 +++ b/docs/man/memcached_result_length.3 @@ -134,7 +134,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_result_st.3 b/docs/man/memcached_result_st.3 index 5a00cb00..d0c7d648 100644 --- a/docs/man/memcached_result_st.3 +++ b/docs/man/memcached_result_st.3 @@ -134,7 +134,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_result_value.3 b/docs/man/memcached_result_value.3 index 3194d29f..990e4500 100644 --- a/docs/man/memcached_result_value.3 +++ b/docs/man/memcached_result_value.3 @@ -134,7 +134,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_sasl.3 b/docs/man/memcached_sasl.3 index 8b7cfedd..27fe6ca2 100644 --- a/docs/man/memcached_sasl.3 +++ b/docs/man/memcached_sasl.3 @@ -30,11 +30,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . -.sp -memcached_set_sasl_callbacks, memcached_get_sasl_callbacks, memcached_sasl_set_auth_data, memcached_destroy_sasl_auth_data -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-** -.sp -SASL tests +.SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) .SH SYNOPSIS @@ -72,13 +68,18 @@ specify your own callback function with memcached_set_sasl_callbacks(). You as a client user have to initialize libsasl by using sasl_client_init before enabling it in libmemcached, and you have to shut down libsasl by calling sasl_done() when you are done using SASL from libmemcached. +.SH RETURN .sp memcached_get_sasl_callbacks() returns the callbacks currently used by this memcached handle. memcached_get_sasl_set_auth_data() returns MEMCACHED_SUCCESS upon success. +.SH HOME .sp To find out more information please check: \fI\%http://libmemcached.org/\fP +.SH AUTHOR +.sp +Brian Aker, <\fI\%brian@tangent.org\fP> .sp Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> .SH SEE ALSO @@ -87,7 +88,7 @@ Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_sasl_set_auth_data.3 b/docs/man/memcached_sasl_set_auth_data.3 index 9ed62994..e07821b1 100644 --- a/docs/man/memcached_sasl_set_auth_data.3 +++ b/docs/man/memcached_sasl_set_auth_data.3 @@ -30,11 +30,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . -.sp -memcached_set_sasl_callbacks, memcached_get_sasl_callbacks, memcached_sasl_set_auth_data, memcached_destroy_sasl_auth_data -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-** -.sp -SASL tests +.SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) .SH SYNOPSIS @@ -72,13 +68,18 @@ specify your own callback function with memcached_set_sasl_callbacks(). You as a client user have to initialize libsasl by using sasl_client_init before enabling it in libmemcached, and you have to shut down libsasl by calling sasl_done() when you are done using SASL from libmemcached. +.SH RETURN .sp memcached_get_sasl_callbacks() returns the callbacks currently used by this memcached handle. memcached_get_sasl_set_auth_data() returns MEMCACHED_SUCCESS upon success. +.SH HOME .sp To find out more information please check: \fI\%http://libmemcached.org/\fP +.SH AUTHOR +.sp +Brian Aker, <\fI\%brian@tangent.org\fP> .sp Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> .SH SEE ALSO @@ -87,7 +88,7 @@ Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_server_add.3 b/docs/man/memcached_server_add.3 index a5613bea..21284ffb 100644 --- a/docs/man/memcached_server_add.3 +++ b/docs/man/memcached_server_add.3 @@ -119,7 +119,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_server_add_unix_socket.3 b/docs/man/memcached_server_add_unix_socket.3 index 2ada1461..39ac96e0 100644 --- a/docs/man/memcached_server_add_unix_socket.3 +++ b/docs/man/memcached_server_add_unix_socket.3 @@ -119,7 +119,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_server_count.3 b/docs/man/memcached_server_count.3 index 573c0ad0..011787d5 100644 --- a/docs/man/memcached_server_count.3 +++ b/docs/man/memcached_server_count.3 @@ -119,7 +119,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_server_cursor.3 b/docs/man/memcached_server_cursor.3 index 5dd5abcd..d5e5e15e 100644 --- a/docs/man/memcached_server_cursor.3 +++ b/docs/man/memcached_server_cursor.3 @@ -119,7 +119,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_server_list.3 b/docs/man/memcached_server_list.3 index 79ed0046..b91b6425 100644 --- a/docs/man/memcached_server_list.3 +++ b/docs/man/memcached_server_list.3 @@ -119,7 +119,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_server_list_append.3 b/docs/man/memcached_server_list_append.3 index 30e06c34..6195a810 100644 --- a/docs/man/memcached_server_list_append.3 +++ b/docs/man/memcached_server_list_append.3 @@ -108,7 +108,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_server_list_count.3 b/docs/man/memcached_server_list_count.3 index 144276d8..37acf92e 100644 --- a/docs/man/memcached_server_list_count.3 +++ b/docs/man/memcached_server_list_count.3 @@ -108,7 +108,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_server_list_free.3 b/docs/man/memcached_server_list_free.3 index 0696542e..987e69f5 100644 --- a/docs/man/memcached_server_list_free.3 +++ b/docs/man/memcached_server_list_free.3 @@ -108,7 +108,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_server_push.3 b/docs/man/memcached_server_push.3 index a4db6a81..87a42011 100644 --- a/docs/man/memcached_server_push.3 +++ b/docs/man/memcached_server_push.3 @@ -119,7 +119,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_server_st.3 b/docs/man/memcached_server_st.3 index ec69f14b..dd6098ef 100644 --- a/docs/man/memcached_server_st.3 +++ b/docs/man/memcached_server_st.3 @@ -119,7 +119,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_servers.3 b/docs/man/memcached_servers.3 index b49fe802..75c6fda3 100644 --- a/docs/man/memcached_servers.3 +++ b/docs/man/memcached_servers.3 @@ -119,7 +119,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_servers_parse.3 b/docs/man/memcached_servers_parse.3 index 248c026b..f9590a5c 100644 --- a/docs/man/memcached_servers_parse.3 +++ b/docs/man/memcached_servers_parse.3 @@ -108,7 +108,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_servers_reset.3 b/docs/man/memcached_servers_reset.3 index ba24a07b..b87b9d17 100644 --- a/docs/man/memcached_servers_reset.3 +++ b/docs/man/memcached_servers_reset.3 @@ -35,22 +35,26 @@ Create a memcached_st structure .SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS +.SH SYNOPSIS .sp -.nf -.ft C #include - -memcached_st *memcached_create (memcached_st *ptr); - -void memcached_free (memcached_st *ptr); - -memcached_st *memcached_clone (memcached_st *destination, memcached_st *source); - -void memcached_servers_reset(memcached_st); -.ft P -.fi -.SS DESCRIPTION +.INDENT 0.0 +.TP +.B memcached_st *memcached_create (memcached_st *ptr); +.UNINDENT +.INDENT 0.0 +.TP +.B void memcached_free (memcached_st *ptr); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st *memcached_clone (memcached_st *destination, memcached_st *source); +.UNINDENT +.INDENT 0.0 +.TP +.B void memcached_servers_reset(memcached_st); +.UNINDENT +.SH DESCRIPTION .sp memcached_create() is used to create a \fBmemcached_st\fP structure that will then be used by other libmemcached(3) functions to communicate with the server. You @@ -87,13 +91,13 @@ To find out more information please check: .SH AUTHOR .sp Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_set.3 b/docs/man/memcached_set.3 index 85a61943..4eccefce 100644 --- a/docs/man/memcached_set.3 +++ b/docs/man/memcached_set.3 @@ -207,7 +207,7 @@ memcached(1) libmemached(3) memcached_strerror(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_set_by_key.3 b/docs/man/memcached_set_by_key.3 index b94515c8..b3d92c58 100644 --- a/docs/man/memcached_set_by_key.3 +++ b/docs/man/memcached_set_by_key.3 @@ -207,7 +207,7 @@ memcached(1) libmemached(3) memcached_strerror(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_set_memory_allocators.3 b/docs/man/memcached_set_memory_allocators.3 index 22655217..3a546e14 100644 --- a/docs/man/memcached_set_memory_allocators.3 +++ b/docs/man/memcached_set_memory_allocators.3 @@ -96,7 +96,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_set_memory_allocators_context.3 b/docs/man/memcached_set_memory_allocators_context.3 index b1161bb6..3f371d9a 100644 --- a/docs/man/memcached_set_memory_allocators_context.3 +++ b/docs/man/memcached_set_memory_allocators_context.3 @@ -96,7 +96,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_set_sasl_callbacks.3 b/docs/man/memcached_set_sasl_callbacks.3 index 093c8b98..f6349a2e 100644 --- a/docs/man/memcached_set_sasl_callbacks.3 +++ b/docs/man/memcached_set_sasl_callbacks.3 @@ -30,11 +30,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . -.sp -memcached_set_sasl_callbacks, memcached_get_sasl_callbacks, memcached_sasl_set_auth_data, memcached_destroy_sasl_auth_data -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-** -.sp -SASL tests +.SH LIBRARY .sp C Client Library for memcached (libmemcached, \-lmemcached) .SH SYNOPSIS @@ -72,13 +68,18 @@ specify your own callback function with memcached_set_sasl_callbacks(). You as a client user have to initialize libsasl by using sasl_client_init before enabling it in libmemcached, and you have to shut down libsasl by calling sasl_done() when you are done using SASL from libmemcached. +.SH RETURN .sp memcached_get_sasl_callbacks() returns the callbacks currently used by this memcached handle. memcached_get_sasl_set_auth_data() returns MEMCACHED_SUCCESS upon success. +.SH HOME .sp To find out more information please check: \fI\%http://libmemcached.org/\fP +.SH AUTHOR +.sp +Brian Aker, <\fI\%brian@tangent.org\fP> .sp Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> .SH SEE ALSO @@ -87,7 +88,7 @@ Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_set_user_data.3 b/docs/man/memcached_set_user_data.3 index 63bd6733..07370658 100644 --- a/docs/man/memcached_set_user_data.3 +++ b/docs/man/memcached_set_user_data.3 @@ -76,7 +76,7 @@ memcached(1) libmemcached(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_stat.3 b/docs/man/memcached_stat.3 index 93d3abda..c75805eb 100644 --- a/docs/man/memcached_stat.3 +++ b/docs/man/memcached_stat.3 @@ -121,7 +121,7 @@ memcached(1) libmemcached(3) memcached_strerror(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_stat_execute.3 b/docs/man/memcached_stat_execute.3 index ea47976b..4cf1bf42 100644 --- a/docs/man/memcached_stat_execute.3 +++ b/docs/man/memcached_stat_execute.3 @@ -121,7 +121,7 @@ memcached(1) libmemcached(3) memcached_strerror(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_stat_get_keys.3 b/docs/man/memcached_stat_get_keys.3 index 422ec82f..38416d19 100644 --- a/docs/man/memcached_stat_get_keys.3 +++ b/docs/man/memcached_stat_get_keys.3 @@ -121,7 +121,7 @@ memcached(1) libmemcached(3) memcached_strerror(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_stat_get_value.3 b/docs/man/memcached_stat_get_value.3 index 64e60cdb..ef74c1a9 100644 --- a/docs/man/memcached_stat_get_value.3 +++ b/docs/man/memcached_stat_get_value.3 @@ -121,7 +121,7 @@ memcached(1) libmemcached(3) memcached_strerror(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_stat_servername.3 b/docs/man/memcached_stat_servername.3 index 6ad944bd..997ade41 100644 --- a/docs/man/memcached_stat_servername.3 +++ b/docs/man/memcached_stat_servername.3 @@ -121,7 +121,7 @@ memcached(1) libmemcached(3) memcached_strerror(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_stats.3 b/docs/man/memcached_stats.3 index 6d25b058..5df027c3 100644 --- a/docs/man/memcached_stats.3 +++ b/docs/man/memcached_stats.3 @@ -121,7 +121,7 @@ memcached(1) libmemcached(3) memcached_strerror(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_strerror.3 b/docs/man/memcached_strerror.3 index d36ebaa4..56ae5c6d 100644 --- a/docs/man/memcached_strerror.3 +++ b/docs/man/memcached_strerror.3 @@ -71,7 +71,7 @@ memcached(1) libmemcached(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_user_data.3 b/docs/man/memcached_user_data.3 index 42f2ee3e..2dcc2a31 100644 --- a/docs/man/memcached_user_data.3 +++ b/docs/man/memcached_user_data.3 @@ -76,7 +76,7 @@ memcached(1) libmemcached(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_verbosity.3 b/docs/man/memcached_verbosity.3 index 0339e6a9..fe831726 100644 --- a/docs/man/memcached_verbosity.3 +++ b/docs/man/memcached_verbosity.3 @@ -68,7 +68,7 @@ memcached(1) libmemcached(3) memcached_strerror(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcached_version.3 b/docs/man/memcached_version.3 index 572a1eaf..4c489474 100644 --- a/docs/man/memcached_version.3 +++ b/docs/man/memcached_version.3 @@ -79,7 +79,7 @@ memcached(1) libmemcached(3) memcached_strerror(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcapable.1 b/docs/man/memcapable.1 index 2ec8d996..386c0b1a 100644 --- a/docs/man/memcapable.1 +++ b/docs/man/memcapable.1 @@ -84,7 +84,7 @@ Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcat.1 b/docs/man/memcat.1 index 3185c232..a5a551e2 100644 --- a/docs/man/memcat.1 +++ b/docs/man/memcat.1 @@ -33,12 +33,10 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .sp Copy a set of keys to stdout .SH SYNOPSIS -.sp -.nf -.ft C -memcat [options] key key ... -.ft P -.fi +.INDENT 0.0 +.TP +.B \-\-help +.UNINDENT .SH DESCRIPTION .sp \fBmemcat\fP outputs to stdout the value a single or multiple set of keys @@ -65,7 +63,7 @@ memcached(1) libmemcached(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memcp.1 b/docs/man/memcp.1 index 0deddac8..21fc1ec7 100644 --- a/docs/man/memcp.1 +++ b/docs/man/memcp.1 @@ -33,12 +33,10 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .sp Copies files to a collection of memcached servers .SH SYNOPSIS -.sp -.nf -.ft C -memcp [options] file file -.ft P -.fi +.INDENT 0.0 +.TP +.B \-\-help +.UNINDENT .SH DESCRIPTION .sp \fBmemcp\fP copies one or more files into memcached(1) servers. @@ -68,7 +66,7 @@ memcached(1) libmemcached(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memdump.1 b/docs/man/memdump.1 index c00846c9..a321cf91 100644 --- a/docs/man/memdump.1 +++ b/docs/man/memdump.1 @@ -33,6 +33,10 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .sp Dump a list of keys from a server. .SH SYNOPSIS +.INDENT 0.0 +.TP +.B \-\-help +.UNINDENT .SH DESCRIPTION .sp \fBmemdump\fP currently dumps a list of "keys" from all servers that @@ -50,7 +54,7 @@ To find out more information please check: .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memerror.1 b/docs/man/memerror.1 index 7d9502cb..24c43ef8 100644 --- a/docs/man/memerror.1 +++ b/docs/man/memerror.1 @@ -33,12 +33,10 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .sp Translate a memcached error code to a string .SH SYNOPSIS -.sp -.nf -.ft C -memerror [options] error_code -.ft P -.fi +.INDENT 0.0 +.TP +.B \-\-help +.UNINDENT .SH DESCRIPTION .sp \fBmemerror\fP translate an error code from libmemcached(3) to a human @@ -58,7 +56,7 @@ memcached(1) libmemcached(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memflush.1 b/docs/man/memflush.1 index 80e3f1bf..95877948 100644 --- a/docs/man/memflush.1 +++ b/docs/man/memflush.1 @@ -32,12 +32,12 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] . .sp Reset a server or list of servers -.sp -.nf -.ft C -memflush [options] -.ft P -.fi +.SH SYNOPSIS +.INDENT 0.0 +.TP +.B \-\-help +.UNINDENT +.SH DESCRIPTION .sp \fBmemflush\fP resets the contents of memcached(1) servers. This means all data in these servers will be deleted. @@ -55,12 +55,13 @@ To find out more information please check: Brian Aker, <\fI\%brian@tangent.org\fP> .sp Mark Atwood <\fI\%mark@fallenpegasus.com\fP> +.SH SEE ALSO .sp memcached(1) libmemcached(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memrm.1 b/docs/man/memrm.1 index 4d91ebb7..01c45bbb 100644 --- a/docs/man/memrm.1 +++ b/docs/man/memrm.1 @@ -33,12 +33,10 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .sp memrm \- Remove a key(s) from a collection of memcached servers .SH SYNOPSIS -.sp -.nf -.ft C -memrm [options] key key ... -.ft P -.fi +.INDENT 0.0 +.TP +.B \-\-help +.UNINDENT .SH DESCRIPTION .sp \fBmemrm\fP removes items, specified by key, from memcached(1) servers. @@ -62,7 +60,7 @@ memcached(1) libmemcached(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memslap.1 b/docs/man/memslap.1 index e3708c48..4465e136 100644 --- a/docs/man/memslap.1 +++ b/docs/man/memslap.1 @@ -30,8 +30,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . -.sp -memslap \- Load testing and benchmarking tool for memcached .SH SYNOPSIS .SH DESCRIPTION .sp @@ -44,11 +42,11 @@ You can specify servers via the \fB\-\-servers\fP option or via the environment variable \fBMEMCACHED_SERVERS\fP. .SH SEE ALSO .sp -\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP +\fImemcached(1)\fP \fIlibmemcached(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/man/memstat.1 b/docs/man/memstat.1 index 2b079ec2..944292af 100644 --- a/docs/man/memstat.1 +++ b/docs/man/memstat.1 @@ -33,12 +33,10 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .sp memstat \- Display the operating status of a single or group of memcached servers .SH SYNOPSIS -.sp -.nf -.ft C -memstat [options] -.ft P -.fi +.INDENT 0.0 +.TP +.B \-\-help +.UNINDENT .SH DESCRIPTION .sp \fBmemstat\fP dumps the state of memcached(1) servers. @@ -50,7 +48,7 @@ to specify the "argument" sent to the stats command (ie slab, size, items, etc..). .sp For a full list of operations run the tool with the \fB\-\-help\fP option. -.SS HOME +.SH HOME .sp To find out more information please check: \fI\%http://launchpad.org/libmemcached\fP @@ -60,7 +58,7 @@ memcached(1) libmemcached(3) .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" . diff --git a/docs/memaslap.rst b/docs/memaslap.rst index 76579d56..841b7a64 100644 --- a/docs/memaslap.rst +++ b/docs/memaslap.rst @@ -1,26 +1,19 @@ -======== -memaslap -======== +================================================== +memaslap - Load testing and benchmarking a server +================================================== -memaslap - Load testing and benchmarking tool for memcached - - -******** +-------- SYNOPSIS -******** - - +-------- -.. code-block:: perl - - memaslap [options] +.. program:: memaslap +.. option:: --help - -*********** +----------- DESCRIPTION -*********** +----------- \ **memaslap**\ is a load generation and benchmark tool for memcached(1) @@ -40,9 +33,9 @@ You can specify servers via the \ **--servers**\ option or via the environment variable \ ``MEMCACHED_SERVERS``\ . -******** +-------- FEATURES -******** +-------- Memslap is developed to for the following purposes: @@ -97,9 +90,9 @@ Supports facebook test (set with TCP and multi-get with UDP) and replication tes -******* +------- DETAILS -******* +------- Effective implementation of network. @@ -224,9 +217,9 @@ be discarded and the next command will be sent. -***** +----- USAGE -***** +----- Below are some usage samples: @@ -617,9 +610,9 @@ commands together as “mulit-get” to the server. -****************** +------------------ Configuration file -****************** +------------------ This section describes the format of the configuration file. By default @@ -631,7 +624,7 @@ Below is a sample configuration file: .. code-block:: perl - *************************************************************************** + --------------------------------------------------------------------------- #comments should start with '#' #key #start_len end_len proportion @@ -705,9 +698,9 @@ Below is a sample configuration file: -**************** +---------------- Format of output -**************** +---------------- At the beginning, memaslap displays some configuration information as follows: @@ -1127,9 +1120,9 @@ Net_rate -******* +------- OPTIONS -******* +------- -s, --servers= @@ -1210,9 +1203,9 @@ OPTIONS Display the version of the application and then exit. -******** +-------- EXAMPLES -******** +-------- memaslap -s 127.0.0.1:11211 -S 5s @@ -1230,27 +1223,26 @@ memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m -p 2 -**** +---- HOME -**** +---- To find out more information please check: `http://launchpad.org/libmemcached `_ -******* +------- AUTHORS -******* +------- Mingqiang Zhuang (Schooner Technolgy) Brian Aker, -******** +-------- SEE ALSO -******** - +-------- -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` +:manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/memcached_analyze.rst b/docs/memcached_analyze.rst index c177be92..1cd8bc3e 100644 --- a/docs/memcached_analyze.rst +++ b/docs/memcached_analyze.rst @@ -1,5 +1,5 @@ ================= -memcached_analyze +Anaylzing servers ================= diff --git a/docs/memcached_callback.rst b/docs/memcached_callback.rst index a4b4b3d3..258fa697 100644 --- a/docs/memcached_callback.rst +++ b/docs/memcached_callback.rst @@ -6,9 +6,9 @@ Setting callbacks Get and set a callback -******* +------- LIBRARY -******* +------- C Client Library for memcached (libmemcached, -lmemcached) @@ -18,21 +18,11 @@ C Client Library for memcached (libmemcached, -lmemcached) SYNOPSIS -------- - - -.. code-block:: perl - - #include +#include - memcached_return_t - memcached_callback_set (memcached_st *ptr, - memcached_callback_t flag, - void *data); +.. c:function:: memcached_return_t memcached_callback_set (memcached_st *ptr, memcached_callback_t flag, void *data); - void * - memcached_callback_get (memcached_st *ptr, - memcached_callback_t flag, - memcached_return_t *error); +.. c:function:: void * memcached_callback_get (memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error); @@ -55,21 +45,21 @@ You can use MEMCACHED_CALLBACK_USER_DATA to provide custom context if required f of the callbacks -MEMCACHED_CALLBACK_CLEANUP_FUNCTION +.. c:var:: MEMCACHED_CALLBACK_CLEANUP_FUNCTION When memcached_delete() is called this function will be excuted. At the point of its execution all connections have been closed. -MEMCACHED_CALLBACK_CLONE_FUNCTION +.. c:var:: MEMCACHED_CALLBACK_CLONE_FUNCTION When memcached_delete() is called this function will be excuted. At the point of its execution all connections have been closed. -MEMCACHED_CALLBACK_PREFIX_KEY +.. c:var:: MEMCACHED_CALLBACK_PREFIX_KEY You can set a value which will be used to create a domain for your keys. The value specified here will be prefixed to each of your keys. The value can not @@ -81,7 +71,7 @@ MEMCACHED_CALLBACK_PREFIX_KEY If you set a value with the value being NULL then the prefix key is disabled. -MEMCACHED_CALLBACK_USER_DATA +.. c:var:: MEMCACHED_CALLBACK_USER_DATA This allows you to store a pointer to a specifc piece of data. This can be retrieved from inside of memcached_fetch_execute(). Cloning a memcached_st @@ -89,25 +79,25 @@ MEMCACHED_CALLBACK_USER_DATA -MEMCACHED_CALLBACK_MALLOC_FUNCTION +.. c:var:: MEMCACHED_CALLBACK_MALLOC_FUNCTION DEPRECATED: use memcached_set_memory_allocators instead. -MEMCACHED_CALLBACK_REALLOC_FUNCTION +.. c:var:: MEMCACHED_CALLBACK_REALLOC_FUNCTION DEPRECATED: use memcached_set_memory_allocators instead. -MEMCACHED_CALLBACK_FREE_FUNCTION +.. c:var:: MEMCACHED_CALLBACK_FREE_FUNCTION DEPRECATED: use memcached_set_memory_allocators instead. -MEMCACHED_CALLBACK_GET_FAILURE +.. c:var:: MEMCACHED_CALLBACK_GET_FAILURE This function implements the read through cache behavior. On failure of retrieval this callback will be called. You are responsible for populating the result object provided. This result object will then be stored in the server and @@ -121,20 +111,18 @@ MEMCACHED_CALLBACK_GET_FAILURE -MEMCACHED_CALLBACK_DELETE_TRIGGER +.. c:var:: MEMCACHED_CALLBACK_DELETE_TRIGGER - This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned - in order to make use of it. +This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned in order to make use of it. - The prototype for this is: - typedef memcached_return_t (\*memcached_trigger_delete_key)(memcached_st \*ptr, char \*key, size_t key_length); +The prototype for this is: typedef memcached_return_t (\*memcached_trigger_delete_key)(memcached_st \*ptr, char \*key, size_t key_length); -****** +------ RETURN -****** +------ memcached_callback_get() return the function or structure that was provided. @@ -145,18 +133,18 @@ memcached_callback_set() returns MEMCACHED_SUCCESS upon successful setting, otherwise MEMCACHED_FAILURE on error. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** +------ AUTHOR -****** +------ Brian Aker, diff --git a/docs/memcached_create.rst b/docs/memcached_create.rst index 36a36bd7..c63bd761 100644 --- a/docs/memcached_create.rst +++ b/docs/memcached_create.rst @@ -6,9 +6,9 @@ Creating and destroying a memcached_st Create a memcached_st structure -******* +------- LIBRARY -******* +------- C Client Library for memcached (libmemcached, -lmemcached) @@ -18,19 +18,15 @@ C Client Library for memcached (libmemcached, -lmemcached) SYNOPSIS -------- - - -.. code-block:: perl - - #include +#include - memcached_st *memcached_create (memcached_st *ptr); +.. c:function:: memcached_st *memcached_create (memcached_st *ptr); - void memcached_free (memcached_st *ptr); +.. c:function:: void memcached_free (memcached_st *ptr); - memcached_st *memcached_clone (memcached_st *destination, memcached_st *source); +.. c:function:: memcached_st *memcached_clone (memcached_st *destination, memcached_st *source); - void memcached_servers_reset(memcached_st); +.. c:function:: void memcached_servers_reset(memcached_st); @@ -62,9 +58,9 @@ stack based allocation. The most common issues related to ABI safety involve heap allocated structures. -****** +------ RETURN -****** +------ memcached_create() returns a pointer to the memcached_st that was created @@ -74,18 +70,18 @@ memcached_clone() returns a pointer to the memcached_st that was created (or initialized). On an allocation failure, it returns NULL. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** +------ AUTHOR -****** +------ Brian Aker, diff --git a/docs/memcached_delete.rst b/docs/memcached_delete.rst index 56ad9697..1c8acaf9 100644 --- a/docs/memcached_delete.rst +++ b/docs/memcached_delete.rst @@ -1,16 +1,14 @@ -.. highlight:: perl - - -memcached_delete ----------------- +=========================== +Deleting data from a server +=========================== Delete a key -******* +------- LIBRARY -******* +------- C Client Library for memcached (libmemcached, -lmemcached) @@ -26,16 +24,9 @@ SYNOPSIS #include - memcached_return_t - memcached_delete (memcached_st *ptr, - const char *key, size_t key_length, - time_t expiration); + memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration); - memcached_return_t - memcached_delete_by_key (memcached_st *ptr, - const char *master_key, size_t master_key_length, - const char *key, size_t key_length, - time_t expiration); + memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *master_key, size_t master_key_length, const char *key, size_t key_length, time_t expiration); @@ -57,9 +48,9 @@ Please note the the Danga memcached server removed tests for expiration in the 1.4 version. -****** +------ RETURN -****** +------ A value of type \ ``memcached_return_t``\ is returned @@ -70,18 +61,18 @@ If you are using the non-blocking mode of the library, success only means that the message was queued for delivery. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** +------ AUTHOR -****** +------ Brian Aker, diff --git a/docs/memcached_dump.rst b/docs/memcached_dump.rst index 4e33d17a..2e119684 100644 --- a/docs/memcached_dump.rst +++ b/docs/memcached_dump.rst @@ -1,16 +1,14 @@ -.. highlight:: perl - - -memcached_dump --------------- +========================== +Dumping data from a server +========================== Get a list of keys found on memcached servers -******* +------- LIBRARY -******* +------- C Client Library for memcached (libmemcached, -lmemcached) @@ -52,9 +50,9 @@ of callbacks that it will use to execute on keys as they are found. Currently the binar protocol is not testsed. -****** +------ RETURN -****** +------ A value of type \ ``memcached_return_t``\ is returned @@ -62,18 +60,18 @@ On success that value will be \ ``MEMCACHED_SUCCESS``\ . Use memcached_strerror() to translate this value to a printable string. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** +------ AUTHOR -****** +------ Brian Aker, diff --git a/docs/memcached_flush.rst b/docs/memcached_flush.rst index 27217b34..3852366e 100644 --- a/docs/memcached_flush.rst +++ b/docs/memcached_flush.rst @@ -1,16 +1,14 @@ -.. highlight:: perl - - -memcached_flush ---------------* +===================================== +Wiping clean the contents of a server +===================================== Wipe contents of memcached servers -******* +------- LIBRARY -******* +------- C Client Library for memcached (libmemcached, -lmemcached) @@ -45,9 +43,9 @@ single server. That is, it will flush the servers in the order that they were added. -****** +------ RETURN -****** +------ A value of type \ ``memcached_return_t``\ is returned @@ -55,18 +53,18 @@ On success that value will be \ ``MEMCACHED_SUCCESS``\ . Use memcached_strerror() to translate this value to a printable string. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** +------ AUTHOR -****** +------ Brian Aker, diff --git a/docs/memcached_flush_buffers.rst b/docs/memcached_flush_buffers.rst index 2d8a5b7f..634ded1d 100644 --- a/docs/memcached_flush_buffers.rst +++ b/docs/memcached_flush_buffers.rst @@ -1,16 +1,14 @@ -.. highlight:: perl - - -memcached_flush_buffers -----------------------* +======================= +Flushing client buffers +======================= Flush buffers and send buffered commands -******* +------- LIBRARY -******* +------- C Client Library for memcached (libmemcached, -lmemcached) @@ -20,14 +18,9 @@ C Client Library for memcached (libmemcached, -lmemcached) SYNOPSIS -------- - - -.. code-block:: perl - - #include +#include - memcached_return_t - memcached_flush_buffers (memcached_st *ptr); +.. c:function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr); @@ -41,9 +34,9 @@ MEMCACHED_BEHAVIOR_BUFFER_REQUESTS (see memcached_behavior(3)) to flush all buffers by sending the buffered commands to the server for processing. -****** +------ RETURN -****** +------ A value of type \ ``memcached_return_t``\ is returned @@ -51,19 +44,21 @@ On success that value will be \ ``MEMCACHED_SUCCESS``\ . Use memcached_strerror() to translate this value to a printable string. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** +------ AUTHOR -****** +------ + +Brian Aker, Trond Norbye, diff --git a/docs/memcached_generate_hash_value.rst b/docs/memcached_generate_hash_value.rst index 7094f9f1..eb213c9b 100644 --- a/docs/memcached_generate_hash_value.rst +++ b/docs/memcached_generate_hash_value.rst @@ -1,16 +1,14 @@ -.. highlight:: perl - - -memcached_generate_hash_value ----------------------------** +=============================== +Generating hash values directly +=============================== Hash a key value -******* +------- LIBRARY -******* +------- C Client Library for memcached (libmemcached, -lmemcached) @@ -56,12 +54,12 @@ the hash value that would have been generated based on the defaults of the memcached_st structure. As of version 0.36 all hash methods have been placed into the library -libmemcached(3) which is linked with libmemcached(3). +libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation. -****** +------ RETURN -****** +------ A 32-bit integer which is the result of hashing the given key. @@ -69,18 +67,18 @@ For 64-bit hash algorithms, only the least-significant 32 bits are returned. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** +------ AUTHOR -****** +------ Brian Aker, diff --git a/docs/memcached_pool.rst b/docs/memcached_pool.rst index 9f842738..b7a0f040 100644 --- a/docs/memcached_pool.rst +++ b/docs/memcached_pool.rst @@ -2,42 +2,27 @@ Working with memcached pools ============================ - -Manage pools - - -******* -LIBRARY -******* - - -C Client Library for memcached (libmemcachedutil, -lmemcachedutil) - - -------- SYNOPSIS -------- +#include - -.. code-block:: perl - - #include +.. c:function:: memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); - memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); +.. c:function:: memcached_st * memcached_pool_destroy(memcached_pool_st* pool); - memcached_st * memcached_pool_destroy(memcached_pool_st* pool); +.. c:function:: memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc); - memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc); +.. c:function:: memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc); - memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc); +.. c:function:: memcached_st *memcached_create (memcached_st *ptr); - memcached_st *memcached_create (memcached_st *ptr); +.. c:function:: memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data) - memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data) - - memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value) +.. c:function:: memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value) +Compile and link with -lmemcachedutil -lmemcached ----------- @@ -74,9 +59,9 @@ memcached_pool_behavior_set() and memcached_pool_behagior_get() is used to get/set behavior flags on all connections in the pool. -****** +------ RETURN -****** +------ memcached_pool_create() returns a pointer to the newly created @@ -96,19 +81,21 @@ memcached_pool_behavior_get() and memcached_pool_behavior_get() returns MEMCACHED_SUCCESS upon success. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** +------ AUTHOR -****** +------ + +Brian Aker, Trond Norbye, diff --git a/docs/memcached_quit.rst b/docs/memcached_quit.rst index 7cdbe05c..5048f456 100644 --- a/docs/memcached_quit.rst +++ b/docs/memcached_quit.rst @@ -1,16 +1,14 @@ -.. highlight:: perl - - -memcached_quit --------------- +==================================== +Disconnecting a client from a server +==================================== Disconnect from all servers -******* +------- LIBRARY -******* +------- C Client Library for memcached (libmemcached, -lmemcached) @@ -46,9 +44,9 @@ function is provided mainly so that you can timeout your connections or reset connections during the middle of a memcached_fetch(). -****** +------ RETURN -****** +------ A value of type \ ``memcached_return``\ is returned @@ -56,18 +54,18 @@ On success that value will be \ ``MEMCACHED_SUCCESS``\ . Use memcached_strerror() to translate this value to a printable string. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** +------ AUTHOR -****** +------ Brian Aker, diff --git a/docs/memcached_sasl.rst b/docs/memcached_sasl.rst index 74a4e919..30aa72ca 100644 --- a/docs/memcached_sasl.rst +++ b/docs/memcached_sasl.rst @@ -1,16 +1,11 @@ -.. highlight:: perl +============ +SASL support +============ -memcached_set_sasl_callbacks, memcached_get_sasl_callbacks, memcached_sasl_set_auth_data, memcached_destroy_sasl_auth_data -------------------------------------------------------------------------------------------------------------------------** - - -SASL tests - - -******* +------- LIBRARY -******* +------- C Client Library for memcached (libmemcached, -lmemcached) @@ -61,9 +56,9 @@ before enabling it in libmemcached, and you have to shut down libsasl by calling sasl_done() when you are done using SASL from libmemcached. -****** +------ RETURN -****** +------ memcached_get_sasl_callbacks() returns the callbacks currently used @@ -71,19 +66,21 @@ by this memcached handle. memcached_get_sasl_set_auth_data() returns MEMCACHED_SUCCESS upon success. -**** +---- HOME -**** +---- To find out more information please check: `http://libmemcached.org/ `_ -****** +------ AUTHOR -****** +------ + +Brian Aker, Trond Norbye, diff --git a/docs/memcat.rst b/docs/memcat.rst index d2535945..911e478b 100644 --- a/docs/memcat.rst +++ b/docs/memcat.rst @@ -12,10 +12,9 @@ SYNOPSIS -.. code-block:: perl - - memcat [options] key key ... +.. program:: memcat +.. option:: --help ----------- diff --git a/docs/memcp.rst b/docs/memcp.rst index 16cedf7a..1933078b 100644 --- a/docs/memcp.rst +++ b/docs/memcp.rst @@ -10,12 +10,9 @@ Copies files to a collection of memcached servers SYNOPSIS -------- +.. program:: memcp - -.. code-block:: perl - - memcp [options] file file - +.. option:: --help ----------- diff --git a/docs/memdump.rst b/docs/memdump.rst index 5b7fb960..05fea79a 100644 --- a/docs/memdump.rst +++ b/docs/memdump.rst @@ -1,6 +1,6 @@ -======= -memdump -======= +============================= +memdump - Dumping your server +============================= Dump a list of keys from a server. @@ -10,7 +10,9 @@ Dump a list of keys from a server. SYNOPSIS -------- -.. program:: memdump [options] +.. program:: memdump + +.. option:: --help ----------- DESCRIPTION diff --git a/docs/memerror.rst b/docs/memerror.rst index 7e675109..880de8ca 100644 --- a/docs/memerror.rst +++ b/docs/memerror.rst @@ -10,13 +10,9 @@ Translate a memcached error code to a string SYNOPSIS -------- +.. program:: memerror - -.. code-block:: perl - - memerror [options] error_code - - +.. option:: --help ----------- DESCRIPTION diff --git a/docs/memflush.rst b/docs/memflush.rst index 635c7f76..88982259 100644 --- a/docs/memflush.rst +++ b/docs/memflush.rst @@ -1,6 +1,6 @@ ---------------------------------------- +======================================= memflush - flush all data from a server ---------------------------------------- +======================================= Reset a server or list of servers @@ -10,13 +10,9 @@ Reset a server or list of servers SYNOPSIS -------- +.. program:: memflush - -.. code-block:: perl - - memflush [options] - - +.. option:: --help ----------- DESCRIPTION @@ -32,18 +28,18 @@ environment variable \ ``MEMCACHED_SERVERS``\ . For a full list of operations run the tool with the \ **--help**\ option. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** +------ AUTHOR -****** +------ Brian Aker, @@ -55,6 +51,4 @@ Mark Atwood SEE ALSO -------- - memcached(1) libmemcached(3) - diff --git a/docs/memrm.rst b/docs/memrm.rst index df40ed3c..eab53ba0 100644 --- a/docs/memrm.rst +++ b/docs/memrm.rst @@ -12,9 +12,9 @@ SYNOPSIS -.. code-block:: perl +.. program:: memrm - memrm [options] key key ... +.. option:: --help diff --git a/docs/memslap.rst b/docs/memslap.rst index 62cf2a3a..134cdf2d 100644 --- a/docs/memslap.rst +++ b/docs/memslap.rst @@ -1,9 +1,6 @@ -======= -memslap -======= - - -memslap - Load testing and benchmarking tool for memcached +================================================= +memslap - Load testing and benchmarking a server +================================================= -------- @@ -33,4 +30,4 @@ SEE ALSO -------- -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` +:manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/memstat.rst b/docs/memstat.rst index 78e369bb..bed68398 100644 --- a/docs/memstat.rst +++ b/docs/memstat.rst @@ -1,6 +1,6 @@ -======= -memstat -======= +========================================= +memstat - Gather statistics from a server +========================================= memstat - Display the operating status of a single or group of memcached servers @@ -10,13 +10,9 @@ memstat - Display the operating status of a single or group of memcached servers SYNOPSIS -------- +.. program:: memstat - -.. code-block:: perl - - memstat [options] - - +.. option:: --help ----------- DESCRIPTION @@ -34,9 +30,9 @@ etc..). For a full list of operations run the tool with the \ **--help**\ option. -**** +---- HOME -**** +---- To find out more information please check: -- 2.30.2