X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_analyze.3;h=3b9c878d4da36eefd7e7d1b081d1a0d6efb83045;hb=20671681ff4e13ed84be72b699f71a90337245cd;hp=d2840a4b8f5ecfdecb8d6fde4288196dd29f83b1;hpb=67456d74f5bd4f354a360d70da503dc58cbe5971;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_analyze.3 b/docs/man/memcached_analyze.3 index d2840a4b..d5dca9e4 100644 --- a/docs/man/memcached_analyze.3 +++ b/docs/man/memcached_analyze.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_ANALYZE" "3" "April 14, 2011" "0.47" "libmemcached" +.TH "MEMCACHED_ANALYZE" "3" "April 09, 2012" "1.0.6" "libmemcached" .SH NAME memcached_analyze \- libmemcached Documentation . @@ -32,40 +32,38 @@ 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 +.UNINDENT +.INDENT 0.0 +.TP +.B \fI\%memcached_analysis_st\fP * memcached_analyze(memcached_st\fI\ *ptr\fP, memcached_stat_st\fI\ *stat\fP, memcached_return_t\fI\ *error\fP) +.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 -\fBmemcached_analysis_st\fP structure. You are responsible for freeing this structure. +\fBlibmemcached\fP has the ability to query a memcached server (or +collection of servers) for their current state. Queries to find state return a +\fI\%memcached_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. +\fI\%memcached_analyze()\fP analyzes useful information based on the +provided servers and sets the result to the \fI\%memcached_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 \fImemstat \-\-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 \fI\%memcached_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 +Any method returning a \fI\%memcached_analysis_st\fP expects you to free the memory allocated for it. .SH HOME .sp