X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Findex.rst;h=67c22628ccda484a29e5b254197f8e10066cd3b1;hb=a1ee4cf8c5fa2119359b40eb2e7933135bcb7700;hp=d52d601c55fe9bce1261e9a74cf5a90c38dd93a3;hpb=9d8ad7151bed36742138f7422307d19d0d64373c;p=m6w6%2Flibmemcached diff --git a/docs/source/index.rst b/docs/source/index.rst index d52d601c..67c22628 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,131 +1,46 @@ -========================================= -Welcome to the libmemcached documentation -========================================= +libmemcached Manual +=================== ------------- -Libmemcached ------------- +`libmemcached` is an open source C/C++ client library and tools for the +memcached server (http://memcached.org/). It has been designed to be light on +memory usage, thread safe, and provide full access to server side methods. -.. toctree:: - :maxdepth: 1 - :caption: Basics - - libmemcached - versioning - memcached_create - libmemcached_examples - libmemcached_configuration - libmemcached/memcached_last_error_message - -.. toctree:: - :maxdepth: 1 - :caption: Working with Data - - memcached_auto - memcached_delete - libmemcached/memcached_exist - memcached_flush_buffers - memcached_flush - memcached_get - memcached_result_st - memcached_set - memcached_append - memcached_cas .. toctree:: - :maxdepth: 1 - :caption: Advanced Topics + :caption: libmemcached + :titlesonly: - libmemcached-1.0/memcached_set_encoding_key - memcached_behavior - memcached_callback - memcached_dump - memcached_generate_hash_value - memcached_memory_allocators - memcached_quit - libmemcached/memcached_return_t - memcached_sasl - memcached_server_st - memcached_servers - memcached_strerror - error_messages - memcached_user_data - memcached_verbosity - memcached_version - libmemcached/defaults + Introduction + libmemcached/index + libmemcached/index_misc .. toctree:: - :titlesonly: - :caption: Interface Versions + :titlesonly: + :caption: libmemcachedutil - libmemcached-1.0/index - libmemcached-1.1/index + Introduction + libmemcachedutil/index .. toctree:: - :titlesonly: - :caption: Deprecated Functions + :titlesonly: + :caption: libhashkit - libmemcached/memcached_fetch + Introduction + libhashkit/index .. toctree:: - :maxdepth: 1 - :caption: Platform Specifics + :maxdepth: 1 + :caption: Client Applications - tap - types + bin/index .. toctree:: - :maxdepth: 1 - :caption: Deriving Statistics from a Server + :caption: Copyright + :hidden: - memcached_analyze - memcached_stats + copyright -.. toctree:: - :maxdepth: 1 - :caption: Libmemcachedutil - - libmemcachedutil - memcached_pool - -.. toctree:: - :maxdepth: 1 - :caption: Client Applications - - bin/memcapable - bin/memcat - bin/memcp - bin/memdump - bin/memerror - bin/memflush - bin/memrm - bin/memslap - bin/memaslap - bin/memstat - bin/memexist.rst - bin/memparse.rst - bin/memping.rst - bin/memtouch.rst - -.. toctree:: - :maxdepth: 1 - :caption: Libhashkit - - libhashkit - hashkit_create - hashkit_function - hashkit_functions - hashkit_value - -================== -Indices and tables -================== - -* :ref:`genindex` -* :ref:`search` - -.. toctree:: - :caption: Copyright - :hidden: +Index +----- - copyright +:ref:`genindex`