X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_analyze.3;h=a9e89d5e38d484f86c585ca3a1fa630e02b26699;hb=7e82821d8a754c19d7e9e8e2baa767dd7f92286d;hp=a403c9bce6d064709b7ae73e8e850d3ad52b7856;hpb=1054bac0d64844c968d1dcb6d5478315bfd4d7a8;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_analyze.3 b/docs/man/memcached_analyze.3 index a403c9bc..a9e89d5e 100644 --- a/docs/man/memcached_analyze.3 +++ b/docs/man/memcached_analyze.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_ANALYZE" "3" "October 26, 2011" "1.0.2" "libmemcached" +.TH "MEMCACHED_ANALYZE" "3" "May 10, 2012" "1.0.7" "libmemcached" .SH NAME memcached_analyze \- libmemcached Documentation . @@ -37,7 +37,11 @@ Analyze server information #include .INDENT 0.0 .TP -.B memcached_analysis_st * memcached_analyze (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error); +.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 @@ -45,21 +49,21 @@ Compile and link with \-lmemcached .sp \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. +\fI\%memcached_analysis_st\fP structure. You are responsible for freeing this structure. .sp -\fBmemcached_analyze()\fP analyzes useful information based on the -provided servers and sets the result to the \fBmemcached_analysis_st\fP +\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, \fBmemstat()\fP with the option \fI\-\-analyze\fP, +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 +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