X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Findex.rst;h=c3cca3bee690c39889c6e1257d6c02774df58134;hb=983523c4536f12781533124cb8a00a4291b8cf79;hp=00a437d80c51afeccb542a85e6a6fab238f4cb66;hpb=e668c212d13197abf5d8e2ddc7916057c94325b6;p=m6w6%2Flibmemcached diff --git a/docs/index.rst b/docs/index.rst index 00a437d8..c3cca3be 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,35 +6,104 @@ Welcome to the libmemcached documentation Libmemcached ------------ + +###### +Basics +###### + + .. toctree:: :maxdepth: 1 libmemcached + versioning + memcached_create libmemcached_examples libmemcached_configuration - memcached_analyze + libmemcached/memcached_last_error_message + +################# +Working with data +################# + +.. toctree:: + :maxdepth: 1 + memcached_auto - memcached_behavior - memcached_callback - memcached_create memcached_delete - memcached_dump + libmemcached/memcached_exist memcached_flush_buffers memcached_flush - memcached_generate_hash_value 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 - memcached_result_st + libmemcached/memcached_return_t memcached_sasl - memcached_servers memcached_server_st - memcached_set - memcached_stats + memcached_servers memcached_strerror + error_messages memcached_user_data - memcached_verbosity - memcached_version + 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 @@ -53,16 +122,20 @@ Client Applications .. toctree:: :maxdepth: 1 - memcapable - memcat - memcp - memdump - memerror - memflush - memrm - memslap - memaslap - memstat + 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 @@ -76,6 +149,7 @@ Libhashkit hashkit_functions hashkit_value +================== Indices and tables ==================