Updates for documentation style/etc.
authorBrian Aker <brian@tangent.org>
Fri, 8 Apr 2011 22:12:11 +0000 (15:12 -0700)
committerBrian Aker <brian@tangent.org>
Fri, 8 Apr 2011 22:12:11 +0000 (15:12 -0700)
40 files changed:
docs/hashkit_create.rst
docs/hashkit_functions.rst
docs/hashkit_value.rst
docs/index.rst
docs/libmemcached.rst
docs/libmemcached_examples.rst
docs/libmemcachedutil.rst
docs/memcached_analyze.rst
docs/memcached_auto.rst
docs/memcached_behavior.rst
docs/memcached_callback.rst
docs/memcached_create.rst
docs/memcached_delete.rst
docs/memcached_dump.rst
docs/memcached_flush.rst
docs/memcached_flush_buffers.rst
docs/memcached_generate_hash_value.rst
docs/memcached_get.rst
docs/memcached_memory_allocators.rst
docs/memcached_pool.rst
docs/memcached_quit.rst
docs/memcached_result_st.rst
docs/memcached_sasl.rst
docs/memcached_server_st.rst
docs/memcached_servers.rst
docs/memcached_set.rst
docs/memcached_stats.rst
docs/memcached_strerror.rst
docs/memcached_user_data.rst
docs/memcached_verbosity.rst
docs/memcached_version.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/memstat.rst

index 6679f88e240b94c11645a293e3bb63079d1559d9..91687e0e31374bdf1a0118ece9341e3cb1de48ac 100644 (file)
@@ -1,24 +1,22 @@
-.. highlight:: perl
-
-
-hashkit_create, hashkit_clone, hashkit_free, hashkit_is_allocated
-*****************************************************************
+============================
+Creating a hashkit structure
+============================
 
 
 Create and destroy hashkit objects
 
 
-*******
+-------
 LIBRARY
-*******
+-------
 
 
 C Library for hashing algorithms (libhashkit, -lhashkit)
 
 
-********
+--------
 SYNOPSIS
-********
+--------
 
 
 
@@ -36,9 +34,9 @@ SYNOPSIS
 
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 The hashkit_create() function initializes a hashkit object for use. If
@@ -57,9 +55,9 @@ The hashkit_is_allocated() reports where the memory was allocated
 for a hashkit object.
 
 
-************
+------------
 RETURN VALUE
-************
+------------
 
 
 hashkit_create() and hashkit_clone() will return NULL on failure or
@@ -70,19 +68,10 @@ object was allocated inside of hashkit_create() or hashkit_clone(),
 otherwise it is false and was user-supplied memory.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-
-
-******
-AUTHOR
-******
-
-
-Brian Aker, <brian@tangent.org>
-
index a0368839228672bf40e3289b610fa14b558ed11f..12a1048eaac0c5cbaf09a675c6d1b34f26d786d7 100644 (file)
@@ -1,24 +1,22 @@
-.. highlight:: perl
-
-
-hashkit_default, hashkit_fnv1_64, hashkit_fnv1a_64, hashkit_fnv1_32, hashkit_fnv1a_32, hashkit_crc32, hashkit_hsieh, hashkit_murmur, hashkit_jenkins, hashkit_md5
-*****************************************************************************************************************************************************************
+================
+Available Hashes
+================
 
 
 Various hash functions to use for calculating values for keys
 
 
-*******
+-------
 LIBRARY
-*******
+-------
 
 
 C Library for hashing algorithms (libhashkit, -lhashkit)
 
 
-********
+--------
 SYNOPSIS
-********
+--------
 
 
 
@@ -39,9 +37,9 @@ SYNOPSIS
 
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 These functions generate hash values from a key using a variety of
@@ -52,34 +50,26 @@ The hashkit_hsieh() is only available if the library is built with
 the appropriate flag enabled.
 
 
-************
+------------
 RETURN VALUE
-************
+------------
 
 
 A 32-bit hash value.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 
 
-******
-AUTHOR
-******
-
-
-Brian Aker, <brian@tangent.org>
-
-
-********
+--------
 SEE ALSO
-********
+--------
 
 
 hashkit_create(3) hashkit_value(3) hashkit_set_hash_fn(3)
index ec5d71b6d0b0ea780745567e5280bd07e4821601..e3f4f22cd5edfc45086b611ee743235429c13b8b 100644 (file)
@@ -1,24 +1,22 @@
-.. highlight:: perl
-
-
+=============
 hashkit_value
-*************
+=============
 
 
 Generate a value for the given key
 
 
-*******
+-------
 LIBRARY
-*******
+-------
 
 
 C Library for hashing algorithms (libhashkit, -lhashkit)
 
 
-********
+--------
 SYNOPSIS
-********
+--------
 
 
 
@@ -32,9 +30,9 @@ SYNOPSIS
 
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 The hashkit_value() function generates a 32-bit hash value from the
@@ -43,34 +41,26 @@ object, and distribution type and hash function is used from this
 object while generating the value.
 
 
-************
+------------
 RETURN VALUE
-************
+------------
 
 
 A 32-bit hash value.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 
 
-******
-AUTHOR
-******
-
-
-Brian Aker, <brian@tangent.org>
-
-
-********
+--------
 SEE ALSO
-********
+--------
 
 
 hashkit_create(3) hashkit_set_distribution(3) hashkit_set_hash_fn(3)
index 8db8ebbd81b9801d3745b675367dd3575a0027a4..4b115cdfc15a67e1dabc051fa470144df81d8e50 100644 (file)
@@ -1,21 +1,16 @@
-.. libmemcached documentation master file, created by
-   sphinx-quickstart on Sun Mar  6 12:05:53 2011.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
+========================================
 Welcome to libmemcached's documentation!
 ========================================
 
-Contents:
+------------
+Libmemcached
+------------
 
 .. toctree::
    :maxdepth: 2
 
-   hashkit_create
-   hashkit_functions
-   hashkit_value
-   libmemcached_examples
    libmemcached
+   libmemcached_examples
    libmemcachedutil
    memcached_analyze
    memcached_auto
@@ -51,6 +46,17 @@ Contents:
    memslap
    memstat
 
+----------
+Libhashkit
+----------
+
+.. toctree::
+   :maxdepth: 2
+
+   hashkit_create
+   hashkit_functions
+   hashkit_value
+
 Indices and tables
 ==================
 
index 96fe94e7b2203725c5434b7da2c05a0f8839c2cd..76ad574081887a34c503b3618e178910ce03925d 100644 (file)
@@ -1,24 +1,22 @@
-.. highlight:: perl
-
-
+============
 libmemcached
-************
+============
 
 
 Client library for memcached
 
 
-*******
+-------
 LIBRARY
-*******
+-------
 
 
 C Client Library for memcached (libmemcached, -lmemcached)
 
 
-********
+--------
 SYNOPSIS
-********
+--------
 
 
 
@@ -28,9 +26,9 @@ SYNOPSIS
 
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 "Memcached is a high-performance, distributed memory object caching
@@ -76,9 +74,9 @@ Some features of the library must be enabled through memcached_behavior_set().
 Hope you enjoy it!
 
 
-*********
+---------
 CONSTANTS
-*********
+---------
 
 
 A number of constants have been provided for in the library.
@@ -126,9 +124,9 @@ A number of constants have been provided for in the library.
 
 
 
-*********************
+---------------------
 THREADS AND PROCESSES
-*********************
+---------------------
 
 
 When using threads or forked processes it is important to keep an instance
@@ -138,27 +136,26 @@ memcached_quit(3) on a \ ``memcached_st``\  and then use the resulting cloned
 structure.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 
 
-******
-AUTHOR
-******
-
-
-Brian Aker, <brian@tangent.org>
-
-
-********
+--------
 SEE ALSO
-********
-
-
-memcached(1) libmemcached_examples(3) libmemcached(1) memcat(1) memcp(1) memflush(1) memrm(1) memslap(1) memstat(1) memcached_fetch(3) memcached_replace(3) memcached_server_list_free(3) libmemcached_examples(3) memcached_clone(3) memcached_free(3) memcached_server_add(3) memcached_server_push(3) memcached_add(3) memcached_get(3) memcached_server_count(3) memcached_servers_parse(3) memcached_create(3) memcached_increment(3) memcached_server_list(3) memcached_set(3) memcached_decrement(3) memcached_mget(3) memcached_server_list_append(3) memcached_strerror(3) memcached_delete(3) memcached_quit(3) memcached_server_list_count(3) memcached_verbosity(3) memcached_server_add_unix_socket(3) memcached_result_create(3)  memcached_result_free(3)  memcached_result_key_value(3)  memcached_result_key_length(3)  memcached_result_value(3)  memcached_result_length(3)  memcached_result_flags(3)  memcached_result_cas(3) memcached_result_st(3) memcached_append(3) memcached_prepend(3) memcached_fetch_result(3) memerror(1) memcached_get_by_key(3) memcached_mget_by_key(3) memcached_delete_by_key(3) memcached_fetch_execute(3) memcached_callback_get(3) memcached_callback_set(3) memcached_version(3) memcached_lib_version(3) memcached_result_set_value(3) memcached_dump(3) memdump(1) memcached_set_memory_allocators(3) memcached_get_memory_allocators(3) memcached_get_user_data(3) memcached_set_user_data(3)
-
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached_examples(3)` :manpage:`libmemcached(1)` :manpage:`memcat(1)` :manpage:`memcp(1)` :manpage:`memflush(1)` :manpage:`memrm(1)` :manpage:`memslap(1)` :manpage:`memstat(1)` :manpage:`memcached_fetch(3)` :manpage:`memcached_replace(3)` :manpage:`memcached_server_list_free(3)` :manpage:`libmemcached_examples(3)` :manpage:`memcached_clone(3)` :manpage:`memcached_free(3)`
+:manpage:`memcached_server_add(3)` :manpage:`memcached_server_push(3)` :manpage:`memcached_add(3)` :manpage:`memcached_get(3)` :manpage:`memcached_server_count(3)` :manpage:`memcached_servers_parse(3)` :manpage:`memcached_create(3)` :manpage:`memcached_increment(3)` :manpage:`memcached_server_list(3)` :manpage:`memcached_set(3)`
+:manpage:`memcached_decrement(3)` :manpage:`memcached_mget(3)` :manpage:`memcached_server_list_append(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_delete(3)` :manpage:`memcached_quit(3)` :manpage:`memcached_server_list_count(3)` :manpage:`memcached_verbosity(3)` :manpage:`memcached_server_add_unix_socket(3)` :manpage:`memcached_result_create(3)`  :manpage:`memcached_result_free(3)`
+:manpage:`memcached_result_key_value(3)`  :manpage:`memcached_result_key_length(3)`  :manpage:`memcached_result_value(3)`  :manpage:`memcached_result_length(3)`  :manpage:`memcached_result_flags(3)`  
+:manpage:`memcached_result_cas(3)` :manpage:`memcached_result_st(3)` :manpage:`memcached_append(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_fetch_result(3)` 
+:manpage:`memerror(1)` :manpage:`memcached_get_by_key(3)` :manpage:`memcached_mget_by_key(3)` :manpage:`memcached_delete_by_key(3)` 
+:manpage:`memcached_fetch_execute(3)` :manpage:`memcached_callback_get(3)` :manpage:`memcached_callback_set(3)` :manpage:`memcached_version(3)` 
+:manpage:`memcached_lib_version(3)` :manpage:`memcached_result_set_value(3)` :manpage:`memcached_dump(3)` :manpage:`memdump(1)`
+:manpage:`memcached_set_memory_allocators(3)` :manpage:`memcached_get_memory_allocators(3)` :manpage:`memcached_get_user_data(3)` :manpage:`memcached_set_user_data(3)`
index 583d65a954dbf44ba1035150be10f2028b555361..b6d27d5d113bd53c83381bfc4c269120eff6bb5a 100644 (file)
@@ -1,25 +1,23 @@
-.. highlight:: perl
-
-
-libmemcached_examples
-*********************
+=====================
+libmemcached examples
+=====================
 
 
 Examples for libmemcached
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 For full examples, test cases are found in tests/\*.c in the main
 distribution. These are always up to date, and are used for each test run of
 the library.
 
+------------------------------
 Creating and Freeing structure
-==============================
-
+------------------------------
 
 
 .. code-block:: perl
@@ -36,8 +34,9 @@ The above code would create a connection and then free the connection when
 finished.
 
 
+---------------------
 Connecting to servers
-=====================
+---------------------
 
 
 
@@ -70,8 +69,9 @@ You can reuse the \ ``memcached_server_st``\  object with multile \ ``memcached_
 structures.
 
 
+----------------------------
 Adding a value to the server
-============================
+----------------------------
 
 
 
@@ -102,8 +102,9 @@ Adding a value to the server
 It is best practice to always look at the return value of any operation.
 
 
+------------------------
 Fetching multiple values
-========================
+------------------------
 
 
 
@@ -136,27 +137,19 @@ Notice that you freed values returned from memcached_fetch(). The define
 
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 
 
-******
-AUTHOR
-******
-
-
-Brian Aker, <brian@tangent.org>
-
-
-********
+--------
 SEE ALSO
-********
+--------
 
 
-memcached(1)
+:manpage:`memcached(1)`
 
index c9bf1b9fe887a58f578b4d8b5c3ecf65523ca903..046108da0b9670d3171fcdcb58bc96c40091d8fa 100644 (file)
@@ -1,25 +1,22 @@
-.. highlight:: perl
-
-
+================
 libmemcachedutil
-****************
+================
 
 
-libmemcachedutil - Utility library for libmemcached
+Utility library for libmemcached
 
 
-*******
+=======
 LIBRARY
-*******
+=======
 
 
 C Client Library containing utility functions for libmemcached (libmemcachedutil, -lmemcachedutil)
 
 
-********
+========
 SYNOPSIS
-********
-
+========
 
 
 .. code-block:: perl
@@ -30,18 +27,18 @@ SYNOPSIS
 
 
 
-***********
+===========
 DESCRIPTION
-***********
+===========
 
 
 \ **libmemcachedutil**\  is a small and thread-safe client library that provides
 extra functionality built on top of \ **libmemcached**\ .
 
 
-*******
+=======
 THREADS
-*******
+=======
 
 
 Do not try to access an instance of \ ``memcached_st``\  from multiple threads
@@ -50,27 +47,20 @@ you should either clone the \ ``memcached_st``\ , or use the memcached pool
 implementation. see memcached_pool_create(3).
 
 
-****
+====
 HOME
-****
+====
 
 
 To find out more information please check:
 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 
 
-******
-AUTHOR
-******
-
-
-Trond Norbye, <trond.norbye@gmail.com>
-
-
-********
+========
 SEE ALSO
-********
+========
 
 
-libmemcached(3) memcached_pool_create(3) memcached_pool_destroy(3) memcached_pool_pop(3) memcached_pool_push(3)
+:manpage:`libmemcached(3)`
+:manpage:`memcached_pool_create(3)` :manpage:`memcached_pool_destroy(3)` :manpage:`memcached_pool_pop(3)` :manpage:`memcached_pool_push(3)`
 
index da30e1414373455bf2687f4d215a633665909545..c177be92455f6ddbd769a2e6581fe625de52e6d4 100644 (file)
@@ -1,24 +1,22 @@
-.. highlight:: perl
-
-
+=================
 memcached_analyze
-*****************
+=================
 
 
 Analyze server information
 
 
-*******
+-------
 LIBRARY
-*******
+-------
 
 
 C Client Library for memcached (libmemcached, -lmemcached)
 
 
-********
+--------
 SYNOPSIS
-********
+--------
 
 
 
@@ -33,9 +31,9 @@ SYNOPSIS
 
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 libmemcached(3) has the ability to query a memcached server (or collection
@@ -50,9 +48,9 @@ A command line tool, memstat(1) with the option --analyze, is provided so that
 you do not have to write an application to use this method.
 
 
-******
+------
 RETURN
-******
+------
 
 
 A pointer to the allocated \ ``memcached_analysis_st``\  structure on success and
@@ -63,27 +61,19 @@ Any method returning a \ ``memcached_analysis_st``\  expects you to free the
 memory allocated for it.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 
 
-******
-AUTHOR
-******
-
-
-Toru Maesaka, <dev@torum.net>
-
-
-********
+--------
 SEE ALSO
-********
+--------
 
 
-memcached(1) libmemcached(3) memcached_strerror(3)
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
 
index d92f1f882583ec79de018ec8c701f4195287e422..31ff6178df30dc53d97efe4cb298547ea654ec07 100644 (file)
@@ -167,5 +167,4 @@ SEE ALSO
 ********
 
 
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
index cc4cf687da00c88bc0a5cae3bb13baa7346dec3a..96e3213de69cfb70d04c5a53029d201740dd4bf3 100644 (file)
@@ -401,5 +401,4 @@ SEE ALSO
 ********
 
 
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
index 43708b695c424740c224478d54dcfa86f3f5977b..ac1760abd17932d18dbdd680cff8fb567c1924a0 100644 (file)
@@ -169,5 +169,4 @@ SEE ALSO
 ********
 
 
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
index 1beff43c507d6274d4a6c919d1dc98643c484a1c..ace146cbf8fa918480cef3272238f5a1ddd84e2a 100644 (file)
@@ -98,5 +98,4 @@ SEE ALSO
 ********
 
 
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
index dcec549f633538d86e4eb195004f4eb6328f82be..440cf22cf7c340558a16b748934c63f5cc35dc3b 100644 (file)
@@ -91,6 +91,4 @@ Brian Aker, <brian@tangent.org>
 SEE ALSO
 ********
 
-
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
index 59bd7d546e86a38c941567b7af2863014ea58713..1a28091a7e7dd1164ff5376d4f26cf789cd0ae41 100644 (file)
@@ -84,5 +84,4 @@ SEE ALSO
 ********
 
 
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
index 41ca369620863ef2a9c09439c7c39ac0cb8c0689..95911809fd4b64cf6c5e52d900d1a10a8208f855 100644 (file)
@@ -76,6 +76,4 @@ Brian Aker, <brian@tangent.org>
 SEE ALSO
 ********
 
-
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
index e2067c157724a2fa3d54831f0e5e92a71e08959e..2abb0e092cc860f334a56a8c85884809515434ac 100644 (file)
@@ -73,5 +73,4 @@ SEE ALSO
 ********
 
 
-memcached(1) libmemcached(3) memcached_strerror(3) memcached_behavior(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
index 0cefabb54ce65555378604da5b64e8f5683880f7..6eb7cf17bdbf1f244da185dd865da788d2d43f66 100644 (file)
@@ -91,5 +91,4 @@ SEE ALSO
 ********
 
 
-memcached(1) libmemcached(3) memcached_behavior_set(3) libhashkit(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
index 27ec765c9c1839197f7582b0d33ba8445a439793..9c90dc680107fad607e5f367801b7ba8fd86cbc5 100644 (file)
@@ -205,6 +205,4 @@ Brian Aker, <brian@tangent.org>
 SEE ALSO
 ********
 
-
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
index 5de7fb67db8336c27d9c86e8a9074344ae930572..540565aefdcff326e7bc67d8f749259fdbeb619a 100644 (file)
@@ -132,6 +132,4 @@ Brian Aker, <brian@tangent.orf<gt>
 SEE ALSO
 ********
 
-
-memcached(1) libmemcached(3) memcached_get_user_data(3) memcached_set_user_data(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
index ed5539eb6d3fb9116bca3ca4ac70248c02a6673b..bef768df2095708e4f0b941dc9ef0ada3ab73332 100644 (file)
@@ -129,6 +129,4 @@ Trond Norbye, <trond.norbye@gmail.com>
 SEE ALSO
 ********
 
-
-memcached(1) libmemcached(3) memcached_create(3) memcached_free(3) libmemcachedutil(3) memcached_behavior_get(3) memcached_behavior_set(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
index 974f4a50069f36459e9df776c9070ef38e379e3b..99a91fb68330331d1c21d6fc864831d8d092a2a2 100644 (file)
@@ -77,6 +77,4 @@ Brian Aker, <brian@tangent.org>
 SEE ALSO
 ********
 
-
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
index 7eba66da85c59f67a9ed9c97cc68a2b0031b1c3e..c96c46053a43afc3fecabf620e9fae9b17c2757b 100644 (file)
@@ -141,6 +141,4 @@ Brian Aker, <brian@tangent.org>
 SEE ALSO
 ********
 
-
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
index 3e3b7789e79c92688f008214caadc97d1685f0ba..155d64df3edbb6b2a6ca452931c33b30a3318a85 100644 (file)
@@ -93,5 +93,4 @@ SEE ALSO
 ********
 
 
-memcached(1) libmemcached(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
index 67f4f3c1dcd32e10622480634dc4851025758361..9c7a9e311ed1d746809e65a0fa8f5be116c8124c 100644 (file)
@@ -1,8 +1,6 @@
-.. highlight:: perl
-
-
-memcached_server_list_free, memcached_server_list_append, memcached_server_list_count, memcached_servers_parse
-**************************************************************************************************************
+=========================
+Managing lists of servers
+=========================
 
 
 Manage server list
@@ -113,5 +111,4 @@ SEE ALSO
 ********
 
 
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
index d7aa521dfcee33ad058580756f3ca38266c7d01d..f2a6d259dc2eb8164dab8878f38abe17d977e165 100644 (file)
@@ -148,5 +148,4 @@ SEE ALSO
 ********
 
 
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
index d0dbbd267c652476568c4011415e366673b9c7d6..9a5e58ad575ec25e8067522f6a2d37db8e441f89 100644 (file)
@@ -1,24 +1,22 @@
-.. highlight:: perl
-
-
-memcached_set, memcached_add, memcached_replace
-***********************************************
+==========================
+Storing and Replacing Data
+==========================
 
 
 Store value on server
 
 
-*******
+-------
 LIBRARY
-*******
+-------
 
 
 C Client Library for memcached (libmemcached, -lmemcached)
 
 
-********
+--------
 SYNOPSIS
-********
+--------
 
 
 
@@ -119,9 +117,9 @@ SYNOPSIS
 
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 memcached_set(), memcached_add(), and memcached_replace() are all used to
@@ -182,9 +180,9 @@ total size of the command, including overhead, exceeds 1400 bytes, a \ ``MEMCACH
 will be returned.
 
 
-******
+------
 RETURN
-******
+------
 
 
 All methods return a value of type \ ``memcached_return_t``\ .
@@ -195,26 +193,18 @@ For memcached_replace() and memcached_add(), \ ``MEMCACHED_NOTSTORED``\  is a
 legitmate error in the case of a collision.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 
 
-******
-AUTHOR
-******
-
-
-Brian Aker, <brian@tangent.org>
-
-
-********
+--------
 SEE ALSO
-********
+--------
 
 
 memcached(1) libmemached(3) memcached_strerror(3)
index ee5103e73db8c157f5332ac59d89bdd83a27e937..4a5fbdb590fcff1679054858126a76539096fa84 100644 (file)
@@ -1,8 +1,6 @@
-.. highlight:: perl
-
-
-memcached_stat, memcached_stat_servername, memcached_stat_get_value, memcached_stat_get_keys
-********************************************************************************************
+==================================================
+Working with statistical information from a server
+==================================================
 
 
 Get memcached statistics
index 7848a59c567f96346755c19da8b22fe1641512d3..18e21c60101086b0b09f50e3b1b7b3fe0f23490a 100644 (file)
@@ -1,11 +1,6 @@
-.. highlight:: perl
-
-
-memcached_strerror
-******************
-
-
-Get error string
+================================================
+Coverting Errors, memcached_return_t, to strings
+================================================
 
 
 *******
index 1fd9d334938fb753621c14f8a11fe4c962d8e8c4..2032cbd375f428f3339718762b2841043d988262 100644 (file)
@@ -1,8 +1,6 @@
-.. highlight:: perl
-
-
-memcached_set_user_data, memcached_get_user_data
-************************************************
+==============================================
+Storing custom user information in the client.
+==============================================
 
 
 Manage user specific data
index c040924417be3153204f097511189552f438224e..0e751a02903b1b433f3795220114041a7d2d4cc5 100644 (file)
@@ -1,8 +1,6 @@
-.. highlight:: perl
-
-
-memcached_verbosity
-*******************
+=================================
+Setting the verbosity of a server
+=================================
 
 
 Modifiy verbosity of servers
index 334e09be3aa7837509bbc864c98aeddedfbaf051..f00bef4ec68da23c4db027b04b922ad37cbb39b8 100644 (file)
@@ -1,8 +1,6 @@
-.. highlight:: perl
-
-
-memcached_lib_version, memcached_version
-****************************************
+=======================================================
+Getting version information about the client and server
+=======================================================
 
 
 Get library version
index b06d69a5d14307d26859a03d5aca4f74f4c1b88e..65dbd2092f78a5bfc59b637e536f1d44f4851c1f 100644 (file)
@@ -1,8 +1,6 @@
-.. highlight:: perl
-
-
-memcapable
-**********
+============================================================
+Checking you Memcached server capibilities and compatibility
+============================================================
 
 
 Check memcached server capabilities
index 35d68340987d52c04ebd14fbb47c00e64de95063..5203b1447fdc0d204b82faa8480f7dcef09f3362 100644 (file)
@@ -1,8 +1,6 @@
-.. highlight:: perl
-
-
+======
 memcat
-******
+======
 
 
 Copy a set of keys to stdout
index 0a9146d8425fe2ef4c951599dee42ebd44c8dd5a..222877be3439117afbc2b8c0c8b9c30321b61229 100644 (file)
@@ -1,8 +1,6 @@
-.. highlight:: perl
-
-
+=====
 memcp
-*****
+=====
 
 
 Copies files to a collection of memcached servers
index 7153174975ad857fb3e031b78fdc5650b6537933..2580b6931cb17864a952ca47b55cdebc84105aa2 100644 (file)
@@ -1,8 +1,6 @@
-.. highlight:: perl
-
-
+=======
 memdump
-*******
+=======
 
 
 Dump a list of keys from a server.
index 029f78dda032f79e9da584fa20999021747bda5b..9c49ff9e24b2430ffe8770bcef60f2be74d290e0 100644 (file)
@@ -1,8 +1,6 @@
-.. highlight:: perl
-
-
+========
 memerror
-********
+========
 
 
 Translate a memcached error code to a string
index b0827853756d2e6ab37250f8fa3a91d29a0e6f98..e83f6b1f47f7cb9684ee1066867dd31d0e2e9e7f 100644 (file)
@@ -1,8 +1,6 @@
-.. highlight:: perl
-
-
+========
 memflush
-********
+========
 
 
 Reset a server or list of servers
index 6d68572dde2958d7868ced77e6d51326cdcf4e26..1b2c5314aad8bcd2f3a1382c101d18b40f9a4949 100644 (file)
@@ -1,8 +1,6 @@
-.. highlight:: perl
-
-
+=====
 memrm
-*****
+=====
 
 
 memrm - Remove a key(s) from a collection of memcached servers
index 00d251784794642e11bbc7f5ab14e0ab8ffaad41..0f180ea5a32fb74b1db3fa4d99bd9a86ac757319 100644 (file)
@@ -1,8 +1,6 @@
-.. highlight:: perl
-
-
+=======
 memslap
-*******
+=======
 
 
 memslap - Load testing and benchmarking tool for memcached
index 99d46e8e130f3d4a6e7cb912db2cfaa86fbbd883..b22a47f90e03c37d6d12238b562e5e3bb8bec74d 100644 (file)
@@ -1,8 +1,6 @@
-.. highlight:: perl
-
-
+=======
 memstat
-*******
+=======
 
 
 memstat - Display the operating status of a single or group of memcached servers
@@ -45,16 +43,6 @@ To find out more information please check:
 `http://launchpad.org/libmemcached <http://launchpad.org/libmemcached>`_
 
 
-******
-AUTHOR
-******
-
-
-Brian Aker, <brian@tangent.org>
-
-Mark Atwood, <mark@fallenpegasus.com>
-
-
 ********
 SEE ALSO
 ********