Merge from build tree.
[awesomized/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 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 libmemcached-1.0/memcached_set_encoding_key
52 memcached_behavior
53 memcached_callback
54 memcached_dump
55 memcached_generate_hash_value
56 memcached_memory_allocators
57 memcached_quit
58 libmemcached/memcached_return_t
59 memcached_sasl
60 memcached_server_st
61 memcached_servers
62 memcached_strerror
63 error_messages
64 memcached_user_data
65 memcached_verbosity
66 memcached_version
67 libmemcached/defaults
68
69 ##################
70 Interface Versions
71 ##################
72
73 .. toctree::
74 :titlesonly:
75
76 libmemcached-1.0/index
77 libmemcached-1.1/index
78
79 ####################
80 Deprecated Functions
81 ####################
82
83 .. toctree::
84 :titlesonly:
85
86 libmemcached/memcached_fetch
87
88 #################
89 Platform Specific
90 #################
91
92 .. toctree::
93 :maxdepth: 1
94
95 tap
96 types
97
98 #################################
99 Deriving statistics from a server
100 #################################
101
102 .. toctree::
103 :maxdepth: 1
104
105 memcached_analyze
106 memcached_stats
107
108 ----------------
109 Libmemcachedutil
110 ----------------
111
112 .. toctree::
113 :maxdepth: 1
114
115 libmemcachedutil
116 memcached_pool
117
118 -------------------
119 Client Applications
120 -------------------
121
122 .. toctree::
123 :maxdepth: 1
124
125 bin/memcapable
126 bin/memcat
127 bin/memcp
128 bin/memdump
129 bin/memerror
130 bin/memflush
131 bin/memrm
132 bin/memslap
133 bin/memaslap
134 bin/memstat
135 bin/memexist.rst
136 bin/memparse.rst
137 bin/memping.rst
138 bin/memtouch.rst
139
140 ----------
141 Libhashkit
142 ----------
143
144 .. toctree::
145 :maxdepth: 1
146
147 libhashkit
148 hashkit_create
149 hashkit_functions
150 hashkit_value
151
152 ==================
153 Indices and tables
154 ==================
155
156 * :ref:`genindex`
157 * :ref:`modindex`
158 * :ref:`search`
159