git.m6w6.name Git - m6w6/libmemcached/blob - docs/index.rst

   1 =========================================
   2 Welcome to the libmemcached documentation
   3 =========================================
   4
   5 ------------
   6 Libmemcached
   7 ------------
   8
   9
  10 ######
  11 Basics
  12 ######
  13
  14
  15 .. toctree::
  16    :maxdepth: 1
  17
  18    libmemcached
  19    versioning
  20    memcached_create
  21    libmemcached_examples
  22    libmemcached_configuration
  23    libmemcached/memcached_last_error_message
  24
  25 #################
  26 Working with data
  27 #################
  28
  29 .. toctree::
  30    :maxdepth: 1
  31
  32    memcached_auto
  33    memcached_delete
  34    libmemcached/memcached_exist
  35    memcached_flush_buffers
  36    memcached_flush
  37    memcached_get
  38    memcached_result_st
  39    memcached_set
  40    memcached_append
  41    memcached_cas
  42
  43
  44 ###############
  45 Advanced Topics
  46 ###############
  47
  48 .. toctree::
  49    :maxdepth: 1
  50
  51    memcached_behavior
  52    memcached_callback
  53    memcached_dump
  54    memcached_generate_hash_value
  55    memcached_memory_allocators
  56    memcached_quit
  57    libmemcached/memcached_return_t
  58    memcached_sasl
  59    memcached_server_st
  60    memcached_servers
  61    memcached_strerror
  62    error_messages
  63    memcached_user_data
  64    memcached_verbosity
  65    memcached_version
  66
  67 ##################
  68 Interface Versions
  69 ##################
  70
  71 .. toctree::
  72    :titlesonly:
  73
  74    libmemcached-1.0/index
  75    libmemcached-1.1/index
  76
  77 ####################
  78 Deprecated Functions
  79 ####################
  80
  81 .. toctree::
  82    :titlesonly:
  83
  84    libmemcached/memcached_fetch
  85
  86 #################
  87 Platform Specific
  88 #################
  89
  90 .. toctree::
  91    :maxdepth: 1
  92
  93    tap
  94
  95 #################################
  96 Deriving statistics from a server
  97 #################################
  98
  99 .. toctree::
 100    :maxdepth: 1
 101
 102    memcached_analyze
 103    memcached_stats
 104
 105 ----------------
 106 Libmemcachedutil
 107 ----------------
 108
 109 .. toctree::
 110    :maxdepth: 1
 111
 112    libmemcachedutil
 113    memcached_pool
 114
 115 -------------------
 116 Client Applications
 117 -------------------
 118
 119 .. toctree::
 120    :maxdepth: 1
 121
 122    bin/memcapable
 123    bin/memcat
 124    bin/memcp
 125    bin/memdump
 126    bin/memerror
 127    bin/memflush
 128    bin/memrm
 129    bin/memslap
 130    bin/memaslap
 131    bin/memstat
 132    bin/memexist.rst
 133    bin/memparse.rst
 134    bin/memping.rst
 135    bin/memtouch.rst
 136
 137 ----------
 138 Libhashkit
 139 ----------
 140
 141 .. toctree::
 142    :maxdepth: 1
 143
 144    libhashkit
 145    hashkit_create
 146    hashkit_functions
 147    hashkit_value
 148
 149 ==================
 150 Indices and tables
 151 ==================
 152
 153 * :ref:`genindex`
 154 * :ref:`modindex`
 155 * :ref:`search`
 156