← Back to branch summary

~piotr-sikora/libmemcached/fix-tests-on-openbsd

« back to all changes in this revision

Viewing changes to docs/man/memcached_version.3

Merge in all of build.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/man/memcached_version.3
 
1
.TH "MEMCACHED_VERSION" "3" "April 09, 2011" "0.47" "libmemcached"
 
2
.SH NAME
 
3
memcached_version \- 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
Get library version
 
35
.SH LIBRARY
 
36
.sp
 
37
C Client Library for memcached (libmemcached, \-lmemcached)
 
38
.SS SYNOPSIS
 
39
.sp
 
40
.nf
 
41
.ft C
 
42
#include <libmemcached/memcached.h>
 
43
 
 
44
const char *
 
45
  memcached_lib_version (void)
 
46
 
 
47
 
 
48
memcached_return_t
 
49
  memcached_version (memcached_st *ptr)
 
50
.ft P
 
51
.fi
 
52
.SS DESCRIPTION
 
53
.sp
 
54
memcached_lib_version() is used to return a simple version string representing
 
55
the libmemcached version (version of the client library, not server)
 
56
.sp
 
57
memcached_version() is used to set the major, minor, and micro versions of each
 
58
memcached server being used by the memcached_st connection structure. It returns the
 
59
memcached server return code.
 
60
.SH RETURN
 
61
.sp
 
62
A string with the version of libmemcached driver is returned from
 
63
memcached_lib_version()
 
64
.sp
 
65
A value of type \fBmemcached_return_t\fP is returned from memcached_version()
 
66
On success that value will be \fBMEMCACHED_SUCCESS\fP. If called with the
 
67
\fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior set, the value \fBMEMCACHED_NOT_SUPPORTED\fPwill be returned. Use memcached_strerror() to translate this value to
 
68
a printable string.
 
69
.SH HOME
 
70
.sp
 
71
To find out more information please check:
 
72
\fI\%https://launchpad.net/libmemcached\fP
 
73
.SH AUTHOR
 
74
.sp
 
75
Brian Aker, <\fI\%brian@tangent.org\fP>
 
76
.SS SEE ALSO
 
77
.sp
 
78
memcached(1) libmemcached(3) memcached_strerror(3)
 
79
.SH AUTHOR
 
80
Brian Aker
 
81
.SH COPYRIGHT
 
82
2011, Brian Aker DataDifferential, http://datadifferential.com/
 
83
.\" Generated by docutils manpage writer.
 
84
.\" 
 
85
.