X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_analyze.3;h=ff4a282955cd153f342934699b8f7c812c877812;hb=2ba52818375fa389a777cf3a2ab3a0249d8a7864;hp=1799163b4ba21fbce285c635da1d90e6a2915d90;hpb=1c5912a525fe2b06a185f97bb078ca6f782da3a4;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_analyze.3 b/docs/man/memcached_analyze.3 index 1799163b..ff4a2829 100644 --- a/docs/man/memcached_analyze.3 +++ b/docs/man/memcached_analyze.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_ANALYZE" "3" "April 08, 2011" "0.47" "libmemcached" +.TH "MEMCACHED_ANALYZE" "3" "October 18, 2011" "1.01" "libmemcached" .SH NAME memcached_analyze \- libmemcached Documentation . @@ -32,55 +32,46 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] . .sp Analyze server information -.SH LIBRARY -.sp -C Client Library for memcached (libmemcached, \-lmemcached) .SH SYNOPSIS .sp -.nf -.ft C #include - -memcached_analysis_st * - memcached_analyze (memcached_st *ptr, - memcached_stat_st *stat, - memcached_return_t *error); -.ft P -.fi +.INDENT 0.0 +.TP +.B memcached_analysis_st * memcached_analyze (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error); +.UNINDENT +.sp +Compile and link with \-lmemcached .SH DESCRIPTION .sp -libmemcached(3) has the ability to query a memcached server (or collection -of servers) for their current state. Queries to find state return a +\fBlibmemcached\fP has the ability to query a memcached server (or +collection of servers) for their current state. Queries to find state return a \fBmemcached_analysis_st\fP structure. You are responsible for freeing this structure. .sp -memcached_analyze() analyzes useful information based on the provided servers -and sets the result to the \fBmemcached_analysis_st\fP structure. The return value -must be freed by the calling application. +\fBmemcached_analyze()\fP analyzes useful information based on the +provided servers and sets the result to the \fBmemcached_analysis_st\fP +structure. The return value must be freed by the calling application. .sp -A command line tool, memstat(1) with the option \-\-analyze, is provided so that -you do not have to write an application to use this method. +A command line tool, \fBmemstat()\fP with the option \fI\-\-analyze\fP, +is provided so that you do not have to write an application to use this method. .SH RETURN .sp -A pointer to the allocated \fBmemcached_analysis_st\fP structure on success and -a NULL pointer on failure. You may inspect the error detail by checking the -\fBmemcached_return_t\fP value. +A pointer to the allocated \fBmemcached_analysis_st\fP structure on +success and a NULL pointer on failure. You may inspect the error detail by +checking the \fBmemcached_return_t\fP value. .sp Any method returning a \fBmemcached_analysis_st\fP expects you to free the memory allocated for it. .SH HOME .sp To find out more information please check: -\fI\%https://launchpad.net/libmemcached\fP -.SH AUTHOR -.sp -Toru Maesaka, <\fI\%dev@torum.net\fP> +\fI\%http://libmemcached.org/\fP .SH SEE ALSO .sp -memcached(1) libmemcached(3) memcached_strerror(3) +\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" .