Update documentation.
[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 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 memcached_sasl
57 memcached_server_st
58 memcached_servers
59 memcached_strerror
60 memcached_user_data
61 memcached_verbosity
62 memcached_version
63
64 #################
65 Platform Specific
66 #################
67
68 .. toctree::
69 :maxdepth: 1
70
71 tap
72
73 #################################
74 Deriving statistics from a server
75 #################################
76
77 .. toctree::
78 :maxdepth: 1
79
80 memcached_analyze
81 memcached_stats
82
83 ----------------
84 Libmemcachedutil
85 ----------------
86
87 .. toctree::
88 :maxdepth: 1
89
90 libmemcachedutil
91 memcached_pool
92
93 -------------------
94 Client Applications
95 -------------------
96
97 .. toctree::
98 :maxdepth: 1
99
100 memcapable
101 memcat
102 memcp
103 memdump
104 memerror
105 memflush
106 memrm
107 memslap
108 memaslap
109 memstat
110
111 ----------
112 Libhashkit
113 ----------
114
115 .. toctree::
116 :maxdepth: 1
117
118 libhashkit
119 hashkit_create
120 hashkit_functions
121 hashkit_value
122
123 ==================
124 Indices and tables
125 ==================
126
127 * :ref:`genindex`
128 * :ref:`modindex`
129 * :ref:`search`
130