-.. 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
-********
+--------
-***********
+-----------
DESCRIPTION
-***********
+-----------
The hashkit_create() function initializes a hashkit object for use. If
for a hashkit object.
-************
+------------
RETURN VALUE
-************
+------------
hashkit_create() and hashkit_clone() will return NULL on failure or
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>
-
-.. 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
-********
+--------
-***********
+-----------
DESCRIPTION
-***********
+-----------
These functions generate hash values from a key using a variety of
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)
-.. highlight:: perl
-
-
+=============
hashkit_value
-*************
+=============
Generate a value for the given key
-*******
+-------
LIBRARY
-*******
+-------
C Library for hashing algorithms (libhashkit, -lhashkit)
-********
+--------
SYNOPSIS
-********
+--------
-***********
+-----------
DESCRIPTION
-***********
+-----------
The hashkit_value() function generates a 32-bit hash value from the
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)
-.. 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
memslap
memstat
+----------
+Libhashkit
+----------
+
+.. toctree::
+ :maxdepth: 2
+
+ hashkit_create
+ hashkit_functions
+ hashkit_value
+
Indices and tables
==================
-.. highlight:: perl
-
-
+============
libmemcached
-************
+============
Client library for memcached
-*******
+-------
LIBRARY
-*******
+-------
C Client Library for memcached (libmemcached, -lmemcached)
-********
+--------
SYNOPSIS
-********
+--------
-***********
+-----------
DESCRIPTION
-***********
+-----------
"Memcached is a high-performance, distributed memory object caching
Hope you enjoy it!
-*********
+---------
CONSTANTS
-*********
+---------
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
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)`
-.. 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
finished.
+---------------------
Connecting to servers
-=====================
+---------------------
structures.
+----------------------------
Adding a value to the server
-============================
+----------------------------
It is best practice to always look at the return value of any operation.
+------------------------
Fetching multiple values
-========================
+------------------------
-****
+----
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)`
-.. 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
-***********
+===========
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
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)`
-.. highlight:: perl
-
-
+=================
memcached_analyze
-*****************
+=================
Analyze server information
-*******
+-------
LIBRARY
-*******
+-------
C Client Library for memcached (libmemcached, -lmemcached)
-********
+--------
SYNOPSIS
-********
+--------
-***********
+-----------
DESCRIPTION
-***********
+-----------
libmemcached(3) has the ability to query a memcached server (or collection
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
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)`
********
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
********
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
********
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
********
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
SEE ALSO
********
-
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
********
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
SEE ALSO
********
-
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
********
-memcached(1) libmemcached(3) memcached_strerror(3) memcached_behavior(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
********
-memcached(1) libmemcached(3) memcached_behavior_set(3) libhashkit(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
SEE ALSO
********
-
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
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)`
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)`
SEE ALSO
********
-
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
SEE ALSO
********
-
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
********
-memcached(1) libmemcached(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
-.. highlight:: perl
-
-
-memcached_server_list_free, memcached_server_list_append, memcached_server_list_count, memcached_servers_parse
-**************************************************************************************************************
+=========================
+Managing lists of servers
+=========================
Manage server list
********
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
********
-memcached(1) libmemcached(3) memcached_strerror(3)
-
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
-.. 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
-********
+--------
-***********
+-----------
DESCRIPTION
-***********
+-----------
memcached_set(), memcached_add(), and memcached_replace() are all used to
will be returned.
-******
+------
RETURN
-******
+------
All methods return a value of type \ ``memcached_return_t``\ .
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)
-.. 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
-.. highlight:: perl
-
-
-memcached_strerror
-******************
-
-
-Get error string
+================================================
+Coverting Errors, memcached_return_t, to strings
+================================================
*******
-.. highlight:: perl
-
-
-memcached_set_user_data, memcached_get_user_data
-************************************************
+==============================================
+Storing custom user information in the client.
+==============================================
Manage user specific data
-.. highlight:: perl
-
-
-memcached_verbosity
-*******************
+=================================
+Setting the verbosity of a server
+=================================
Modifiy verbosity of servers
-.. highlight:: perl
-
-
-memcached_lib_version, memcached_version
-****************************************
+=======================================================
+Getting version information about the client and server
+=======================================================
Get library version
-.. highlight:: perl
-
-
-memcapable
-**********
+============================================================
+Checking you Memcached server capibilities and compatibility
+============================================================
Check memcached server capabilities
-.. highlight:: perl
-
-
+======
memcat
-******
+======
Copy a set of keys to stdout
-.. highlight:: perl
-
-
+=====
memcp
-*****
+=====
Copies files to a collection of memcached servers
-.. highlight:: perl
-
-
+=======
memdump
-*******
+=======
Dump a list of keys from a server.
-.. highlight:: perl
-
-
+========
memerror
-********
+========
Translate a memcached error code to a string
-.. highlight:: perl
-
-
+========
memflush
-********
+========
Reset a server or list of servers
-.. highlight:: perl
-
-
+=====
memrm
-*****
+=====
memrm - Remove a key(s) from a collection of memcached servers
-.. highlight:: perl
-
-
+=======
memslap
-*******
+=======
memslap - Load testing and benchmarking tool for memcached
-.. highlight:: perl
-
-
+=======
memstat
-*******
+=======
memstat - Display the operating status of a single or group of memcached servers
`http://launchpad.org/libmemcached <http://launchpad.org/libmemcached>`_
-******
-AUTHOR
-******
-
-
-Brian Aker, <brian@tangent.org>
-
-Mark Atwood, <mark@fallenpegasus.com>
-
-
********
SEE ALSO
********