← Back to branch summary

~brianaker/libmemcached/1164440

« back to all changes in this revision

Viewing changes to docs/man/memcached_version.3

  • Committer: Brian Aker
  • Date: 2012-09-30 23:57:30 UTC
  • mto: This revision was merged to the branch mainline in revision 1073.
  • Revision ID: brian@tangent.org-20120930235730-jl3k607syliahnl0
Fix how we do manpages.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/man/memcached_version.3
1
 
.TH "MEMCACHED_VERSION" "3" "September 16, 2012" "1.0.10" "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
 
.SH SYNOPSIS
34
 
.sp
35
 
#include <libmemcached/memcached.h>
36
 
.INDENT 0.0
37
 
.TP
38
 
.B const char * memcached_lib_version(void)
39
 
.UNINDENT
40
 
.INDENT 0.0
41
 
.TP
42
 
.B memcached_return_t memcached_version(memcached_st\fI\ *ptr\fP)
43
 
.UNINDENT
44
 
.sp
45
 
Compile and link with \-lmemcached
46
 
.SH DESCRIPTION
47
 
.sp
48
 
\fI\%memcached_lib_version()\fP is used to return a simple version string representing the libmemcached version (client library version, not server version)
49
 
.sp
50
 
\fI\%memcached_version()\fP is used to set the major, minor, and micro versions of each memcached server being used by the memcached_st connection structure. It returns the memcached server return code.
51
 
.SH RETURN
52
 
.sp
53
 
\fI\%memcached_lib_version()\fP returns a string with the version of the libmemcached driver.
54
 
.sp
55
 
A value of \fBmemcached_return_t\fP is returned from :c:func:\(aqmemcached_version\(aq
56
 
.sp
57
 
On success that value will be \fBMEMCACHED_SUCCESS\fP.
58
 
.sp
59
 
If called with the \fBMEMCACHED_BEHAVIOR_USE_UDP()\fP behavior set, the value \fBMEMCACHED_NOT_SUPPORTED\fP will be returned.
60
 
.sp
61
 
Use \fBmemcached_strerror()\fP to translate this value to
62
 
a printable string.
63
 
.SH HOME
64
 
.sp
65
 
To find out more information please check:
66
 
\fI\%http://libmemcached.org/\fP
67
 
.SH SEE ALSO
68
 
.sp
69
 
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
70
 
.SH AUTHOR
71
 
Brian Aker
72
 
.SH COPYRIGHT
73
 
2011-2012, Brian Aker DataDifferential, http://datadifferential.com/
74
 
.\" Generated by docutils manpage writer.
75
 
.\" 
76
 
.