X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_analyze.3;h=a403c9bce6d064709b7ae73e8e850d3ad52b7856;hb=9169cee9ec0f231b3117a0d5a7840d2067f29610;hp=310d4b5d5a1fef85cbfa6da75018d5478b4e5a6b;hpb=41543e45ff7aca5456c9279bc0403ecdc35f7b6e;p=awesomized%2Flibmemcached diff --git a/docs/man/memcached_analyze.3 b/docs/man/memcached_analyze.3 index 310d4b5d..a403c9bc 100644 --- a/docs/man/memcached_analyze.3 +++ b/docs/man/memcached_analyze.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_ANALYZE" "3" "April 13, 2011" "0.47" "libmemcached" +.TH "MEMCACHED_ANALYZE" "3" "October 26, 2011" "1.0.2" "libmemcached" .SH NAME memcached_analyze \- libmemcached Documentation . @@ -32,38 +32,32 @@ 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.