X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Findex.rst;h=c3cca3bee690c39889c6e1257d6c02774df58134;hb=983523c4536f12781533124cb8a00a4291b8cf79;hp=316eba0229ca739704de9e080ab0fcba11af58b3;hpb=1eae35aca01e152e10113cd97b7571ebd6eb5bd9;p=m6w6%2Flibmemcached diff --git a/docs/index.rst b/docs/index.rst index 316eba02..c3cca3be 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,56 +1,155 @@ -.. 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: - -.. toctree:: - :maxdepth: 2 - - hashkit_create.rst - hashkit_functions.rst - hashkit_value.rst - libmemcached_examples.rst - libmemcached.rst - libmemcachedutil.rst - memcached_analyze.rst - memcached_auto.rst - memcached_behavior.rst - memcached_callback.rst - memcached_create.rst - memcached_delete.rst - memcached_dump.rst - memcached_flush_buffers.rst - memcached_flush.rst - memcached_generate_hash_value.rst - memcached_get.rst - memcached_memory_allocators.rst - memcached_pool.rst - memcached_quit.rst - memcached_result_st.rst - memcached_sasl.rst - memcached_servers.rst - memcached_server_st.rst - memcached_set.rst - memcached_stats.rst - memcached_strerror.rst - memcached_user_data.rst - memcached_verbosity.rst - memcached_version.rst - memcapable.rst - memcat.rst - memcp.rst - memdump.rst - memerror.rst - memflush.rst - memrm.rst - memslap.rst - memstat.rst +========================================= +Welcome to the libmemcached documentation +========================================= +------------ +Libmemcached +------------ + + +###### +Basics +###### + + +.. toctree:: + :maxdepth: 1 + + libmemcached + versioning + memcached_create + libmemcached_examples + libmemcached_configuration + libmemcached/memcached_last_error_message + +################# +Working with data +################# + +.. toctree:: + :maxdepth: 1 + + memcached_auto + memcached_delete + libmemcached/memcached_exist + memcached_flush_buffers + memcached_flush + memcached_get + memcached_result_st + memcached_set + memcached_append + memcached_cas + + +############### +Advanced Topics +############### + +.. toctree:: + :maxdepth: 1 + + 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 + +################## +Interface Versions +################## + +.. toctree:: + :titlesonly: + + libmemcached-1.0/index + libmemcached-1.1/index + +#################### +Deprecated Functions +#################### + +.. toctree:: + :titlesonly: + + libmemcached/memcached_fetch + +################# +Platform Specific +################# + +.. toctree:: + :maxdepth: 1 + + tap + types + +################################# +Deriving statistics from a server +################################# + +.. toctree:: + :maxdepth: 1 + + memcached_analyze + memcached_stats + +---------------- +Libmemcachedutil +---------------- + +.. toctree:: + :maxdepth: 1 + + libmemcachedutil + memcached_pool + +------------------- +Client Applications +------------------- + +.. toctree:: + :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 + +---------- +Libhashkit +---------- + +.. toctree:: + :maxdepth: 1 + + libhashkit + hashkit_create + hashkit_functions + hashkit_value + +================== Indices and tables ==================