Merging bzr://gaz.tangent.org/libmemcached/build/ to Build branch

[m6w6/libmemcached] / docs / man / memcached_analyze.3

diff --git a/docs/man/memcached_analyze.3 b/docs/man/memcached_analyze.3
index ff4a282955cd153f342934699b8f7c812c877812..6947b2d205912039caff43197f96c57b8866db95 100644 (file)
--- a/docs/man/memcached_analyze.3
+++ b/docs/man/memcached_analyze.3
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_ANALYZE" "3" "October 18, 2011" "1.01" "libmemcached"
+.TH "MEMCACHED_ANALYZE" "3" "April 27, 2012" "1.0.6" "libmemcached"

 .SH NAME
 memcached_analyze \- libmemcached Documentation
 .
 .SH NAME
 memcached_analyze \- libmemcached Documentation
 .


@@ -37,7 +37,11 @@ Analyze server information
 #include <libmemcached/memcached.h>
 .INDENT 0.0
 .TP
 #include <libmemcached/memcached.h>
 .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
 .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
 .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
 .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
 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
 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
 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
 memory allocated for it.
 .SH HOME
 .sp