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