This add AES support.

[m6w6/libmemcached] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index b8931239d8b2982c47b02823a762a5455e8946ec..c3cca3bee690c39889c6e1257d6c02774df58134 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,138 +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 the libmemcached documentation
+=========================================
 
-Welcome to libmemcached's documentation!
-========================================
+------------
+Libmemcached
+------------
+
+
+######
+Basics
+######
 
-Contents:
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
-   hashkit_clone
-   hashkit_create
-   hashkit_functions
-   hashkit_value
-   hashkit_crc32
-   hashkit_fnv1_32
-   hashkit_fnv1_64
-   hashkit_fnv1a_32
-   hashkit_fnv1a_64
-   hashkit_free
-   hashkit_hsieh
-   hashkit_is_allocated
-   hashkit_jenkins
-   hashkit_md5
-   hashkit_murmur
-   memcached_destroy_sasl_auth_data
-   memcached_get_sasl_callbacks
-   memcached_sasl_set_auth_data
-   memcached_set_sasl_callbacks
    libmemcached
+   versioning
+   memcached_create
    libmemcached_examples
-   libmemcachedutil
-   memcached_add
-   memcached_add_by_key
-   memcached_analyze
-   memcached_append
-   memcached_append_by_key
+   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_behavior_get
-   memcached_behavior_set
    memcached_callback
-   memcached_callback_get
-   memcached_callback_set
-   memcached_cas
-   memcached_cas_by_key
-   memcached_clone
-   memcached_create
-   memcached_decrement
-   memcached_decrement_with_initial
-   memcached_delete
-   memcached_delete_by_key
    memcached_dump
-   memcached_fetch
-   memcached_fetch_execute
-   memcached_fetch_result
-   memcached_flush
-   memcached_flush_buffers
-   memcached_free
    memcached_generate_hash_value
-   memcached_get
-   memcached_get_by_key
-   memcached_get_memory_allocators
-   memcached_get_user_data
-   memcached_increment
-   memcached_increment_with_initial
-   memcached_lib_version
    memcached_memory_allocators
-   memcached_mget
-   memcached_mget_by_key
-   memcached_mget_execute
-   memcached_mget_execute_by_key
-   memcached_pool
-   memcached_pool_behavior_get
-   memcached_pool_behavior_set
-   memcached_pool_create
-   memcached_pool_destroy
-   memcached_pool_push
-   memcached_pool_rst
-   memcached_prepend
-   memcached_prepend_by_key
    memcached_quit
-   memcached_replace
-   memcached_replace_by_key
-   memcached_result_cas
-   memcached_result_create
-   memcached_result_flags
-   memcached_result_free
-   memcached_result_key_length
-   memcached_result_key_value
-   memcached_result_length
-   memcached_result_st
-   memcached_result_value
+   libmemcached/memcached_return_t
    memcached_sasl
-   memcached_server_add
-   memcached_server_add_unix_socket
-   memcached_server_count
-   memcached_server_cursor
-   memcached_server_list
-   memcached_server_list_append
-   memcached_server_list_count
-   memcached_server_list_free
-   memcached_server_push
    memcached_server_st
    memcached_servers
-   memcached_servers_parse
-   memcached_servers_reset
-   memcached_set
-   memcached_set_by_key
-   memcached_set_memory_allocators
-   memcached_set_memory_allocators_context
-   memcached_set_user_data
-   memcached_stat
-   memcached_stat_execute
-   memcached_stat_get_keys
-   memcached_stat_get_value
-   memcached_stat_servername
-   memcached_stats
    memcached_strerror
+   error_messages
    memcached_user_data
-   memcached_verbosity
-   memcached_version
-   memcapable
-   memcat
-   memcp
-   memdump
-   memerror
-   memflush
-   memrm
-   memslap
-   memstat
+   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
 ==================