Update docs, and syncronize libtest.
[m6w6/libmemcached] / 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 memcached_create
20 libmemcached_examples
21 libmemcached_configuration
22 error_messages
23
24
25 #################
26 Working with data
27 #################
28
29 .. toctree::
30 :maxdepth: 1
31
32 memcached_auto
33 memcached_delete
34 memcached_flush_buffers
35 memcached_flush
36 memcached_get
37 memcached_result_st
38 memcached_set
39 memcached_append
40 memcached_cas
41
42
43 ###############
44 Advanced Topics
45 ###############
46
47 .. toctree::
48 :maxdepth: 1
49
50 memcached_behavior
51 memcached_callback
52 memcached_dump
53 memcached_generate_hash_value
54 memcached_memory_allocators
55 memcached_quit
56 libmemcached/memcached_return_t
57 memcached_sasl
58 memcached_server_st
59 memcached_servers
60 memcached_strerror
61 memcached_user_data
62 memcached_verbosity
63 memcached_version
64
65
66 ####################
67 Deprecated Functions
68 ####################
69
70 .. toctree::
71 :titlesonly:
72
73 libmemcached/memcached_fetch
74
75 #################
76 Platform Specific
77 #################
78
79 .. toctree::
80 :maxdepth: 1
81
82 tap
83
84 #################################
85 Deriving statistics from a server
86 #################################
87
88 .. toctree::
89 :maxdepth: 1
90
91 memcached_analyze
92 memcached_stats
93
94 ----------------
95 Libmemcachedutil
96 ----------------
97
98 .. toctree::
99 :maxdepth: 1
100
101 libmemcachedutil
102 memcached_pool
103
104 -------------------
105 Client Applications
106 -------------------
107
108 .. toctree::
109 :maxdepth: 1
110
111 bin/memcapable
112 bin/memcat
113 bin/memcp
114 bin/memdump
115 bin/memerror
116 bin/memflush
117 bin/memrm
118 bin/memslap
119 bin/memaslap
120 bin/memstat
121
122 ----------
123 Libhashkit
124 ----------
125
126 .. toctree::
127 :maxdepth: 1
128
129 libhashkit
130 hashkit_create
131 hashkit_functions
132 hashkit_value
133
134 ==================
135 Indices and tables
136 ==================
137
138 * :ref:`genindex`
139 * :ref:`modindex`
140 * :ref:`search`
141