X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_analyze.3;h=3b9c878d4da36eefd7e7d1b081d1a0d6efb83045;hb=bc9a024d4d2292b68be5d3a90063ea0193c7770f;hp=85646ecbb5831bceb0167b97deeaee346148d386;hpb=498bcd4bb9f82435b8fb1ce8632732cc4f118bdd;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_analyze.3 b/docs/man/memcached_analyze.3 index 85646ecb..3b9c878d 100644 --- a/docs/man/memcached_analyze.3 +++ b/docs/man/memcached_analyze.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_ANALYZE" "3" "June 02, 2011" "0.47" "libmemcached" +.TH "MEMCACHED_ANALYZE" "3" "September 26, 2011" "0.53" "libmemcached" .SH NAME memcached_analyze \- libmemcached Documentation . @@ -43,21 +43,21 @@ Analyze server information 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.