X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Findex.rst;h=e82ffb8f15a15d5e6acaec11c8f67e807d61e174;hb=c30ef1a4575868312dbd6251b54eb66f39d38783;hp=3a4e1c615b20d62ea3f8954519ae10a66748c457;hpb=2b74f2de5a5893e466f64e449e8b7f8e52e17eb7;p=awesomized%2Flibmemcached diff --git a/docs/source/index.rst b/docs/source/index.rst index 3a4e1c61..e82ffb8f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,130 +1,28 @@ -========================================= -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 - - 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 - -.. toctree:: - :titlesonly: - :caption: Interface Versions - - libmemcached-1.0/index - libmemcached-1.1/index - -.. toctree:: - :titlesonly: - :caption: Deprecated Functions - - libmemcached/memcached_fetch - -.. toctree:: - :maxdepth: 1 - :caption: Platform Specifics - - tap - types - -.. toctree:: - :maxdepth: 1 - :caption: Deriving Statistics from a Server - - memcached_analyze - memcached_stats .. toctree:: - :maxdepth: 1 - :caption: Libmemcachedutil + :titlesonly: - libmemcachedutil - memcached_pool + Introduction + libmemcached/index + libmemcachedutil API + libhashkit API + bin/index + libmemcached/index_misc .. toctree:: - :maxdepth: 1 - :caption: Client Applications + :maxdepth: 1 - 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 + changelogs + copyright -.. toctree:: - :maxdepth: 1 - :caption: Libhashkit - - libhashkit - hashkit_create - hashkit_functions - hashkit_value - -================== -Indices and tables -================== - -* :ref:`genindex` -* :ref:`search` - -.. toctree:: - :caption: Copyright - :hidden: +Index +----- - copyright +:ref:`genindex`