summaryrefslogtreecommitdiff
path: root/docs/source/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/index.rst')
-rw-r--r--docs/source/index.rst159
1 files changed, 159 insertions, 0 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 00000000..c3cca3be
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,159 @@
+=========================================
+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
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+