Merge in updates to doc/build of memaslap.
[awesomized/libmemcached] / docs / man / memcached_analyze.3
1 .TH "MEMCACHED_ANALYZE" "3" "June 02, 2011" "0.47" "libmemcached"
2 .SH NAME
3 memcached_analyze \- 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 Analyze server information
35 .SH SYNOPSIS
36 .sp
37 #include <libmemcached/memcached.h>
38 .INDENT 0.0
39 .TP
40 .B memcached_analysis_st * memcached_analyze (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error);
41 .UNINDENT
42 .sp
43 Compile and link with \-lmemcached
44 .SH DESCRIPTION
45 .sp
46 libmemcached(3) has the ability to query a memcached server (or collection
47 of servers) for their current state. Queries to find state return a
48 \fBmemcached_analysis_st\fP structure. You are responsible for freeing this structure.
49 .sp
50 memcached_analyze() analyzes useful information based on the provided servers
51 and sets the result to the \fBmemcached_analysis_st\fP structure. The return value
52 must be freed by the calling application.
53 .sp
54 A command line tool, memstat(1) with the option \-\-analyze, is provided so that
55 you do not have to write an application to use this method.
56 .SH RETURN
57 .sp
58 A pointer to the allocated \fBmemcached_analysis_st\fP structure on success and
59 a NULL pointer on failure. You may inspect the error detail by checking the
60 \fBmemcached_return_t\fP value.
61 .sp
62 Any method returning a \fBmemcached_analysis_st\fP expects you to free the
63 memory allocated for it.
64 .SH HOME
65 .sp
66 To find out more information please check:
67 \fI\%http://libmemcached.org/\fP
68 .SH SEE ALSO
69 .sp
70 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
71 .SH AUTHOR
72 Brian Aker
73 .SH COPYRIGHT
74 2011, Brian Aker DataDifferential, http://datadifferential.com/
75 .\" Generated by docutils manpage writer.
76 .\"
77 .