Add docs for tap, and update all other documentation.
[m6w6/libmemcached] / docs / man / libmemcachedutil.3
1 .TH "LIBMEMCACHEDUTIL" "3" "April 11, 2011" "0.47" "libmemcached"
2 .SH NAME
3 libmemcachedutil \- libmemcached Documentation
4 .
5 .nr rst2man-indent-level 0
6 .
7 .de1 rstReportMargin
8 \\$1 \\n[an-margin]
9 level \\n[rst2man-indent-level]
10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
11 -
12 \\n[rst2man-indent0]
13 \\n[rst2man-indent1]
14 \\n[rst2man-indent2]
15 ..
16 .de1 INDENT
17 .\" .rstReportMargin pre:
18 . RS \\$1
19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20 . nr rst2man-indent-level +1
21 .\" .rstReportMargin post:
22 ..
23 .de UNINDENT
24 . RE
25 .\" indent \\n[an-margin]
26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27 .nr rst2man-indent-level -1
28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
30 ..
31 .\" Man page generated from reStructeredText.
32 .
33 .sp
34 Utility library for libmemcached
35 .SH LIBRARY
36 .sp
37 C Client Library containing utility functions for libmemcached (libmemcachedutil, \-lmemcachedutil \-lmemcached)
38 .SH SYNOPSIS
39 .sp
40 .nf
41 .ft C
42 cc [ flag ... ] file ... \-lmemcachedutil
43
44 #include <libmemcached/memcached_util.h>
45 .ft P
46 .fi
47 .SH DESCRIPTION
48 .sp
49 \fBlibmemcachedutil\fP is a small and thread\-safe client library that provides
50 extra functionality built on top of \fBlibmemcached\fP.
51 .SH THREADS
52 .sp
53 Do not try to access an instance of \fBmemcached_st\fP from multiple threads
54 at the same time. If you want to access memcached from multiple threads
55 you should either clone the \fBmemcached_st\fP, or use the memcached pool
56 implementation. see memcached_pool_create(3).
57 .SH HOME
58 .sp
59 To find out more information please check:
60 \fI\%https://launchpad.net/libmemcached\fP
61 .SH SEE ALSO
62 .sp
63 \fIlibmemcached(3)\fP
64 \fImemcached_pool_create(3)\fP \fImemcached_pool_destroy(3)\fP \fImemcached_pool_pop(3)\fP \fImemcached_pool_push(3)\fP
65 .SH AUTHOR
66 Brian Aker
67 .SH COPYRIGHT
68 2011, Brian Aker DataDifferential, http://datadifferential.com/
69 .\" Generated by docutils manpage writer.
70 .\"
71 .