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