X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_stats.3;h=1d0588b00ffa3cf24af7a3ed182da09323acc090;hb=bce9a74e8addd1085b2e751508bf9ab0c2e84e45;hp=60a558284c954c68403df3d9ce93f14d4c6591c7;hpb=41543e45ff7aca5456c9279bc0403ecdc35f7b6e;p=m6w6%2Flibmemcached

diff --git a/docs/man/memcached_stats.3 b/docs/man/memcached_stats.3
index 60a55828..b76e9e28 100644
--- a/docs/man/memcached_stats.3
+++ b/docs/man/memcached_stats.3
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_STATS" "3" "April 13, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_STATS" "3" "May 03, 2012" "1.0.7" "libmemcached"
 .SH NAME
 memcached_stats \- libmemcached Documentation
 .
@@ -32,73 +32,57 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .
 .sp
 Get memcached statistics
-.SH LIBRARY
+.SH SYNOPSIS
 .sp
-C Client Library for memcached (libmemcached, \-lmemcached)
-.SS SYNOPSIS
-.sp
-.nf
-.ft C
 #include <libmemcached/memcached.h>
-
-memcached_stat_st *memcached_stat (memcached_st *ptr,
-                                   char *args,
-                                   memcached_return_t *error);
-
-memcached_return_t memcached_stat_servername (memcached_stat_st *stat,
-                                              char *args,
-                                              const char *hostname,
-                                              unsigned int port);
-
-char *
-  memcached_stat_get_value (memcached_st *ptr,
-                            memcached_stat_st *stat,
-                            const char *key,
-                            memcached_return_t *error);
-
-char **
-  memcached_stat_get_keys (memcached_st *ptr,
-                           memcached_stat_st *stat,
-                           memcached_return_t *error);
-
-memcached_return_t
-  memcached_stat_execute (memcached_st *memc,
-                          const char *args,
-                          memcached_stat_fn func,
-                          void *context);
-.ft P
-.fi
-.SS DESCRIPTION
+.INDENT 0.0
+.TP
+.B memcached_stat_st
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t (*memcached_stat_fn)(memcached_server_instance_st\fI\ server\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, void\fI\ *context\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \fI\%memcached_stat_st\fP *memcached_stat(memcached_st\fI\ *ptr\fP, char\fI\ *args\fP, memcached_return_t\fI\ *error\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_stat_servername(\fI\%memcached_stat_st\fP\fI\ *stat\fP, char\fI\ *args\fP, const char\fI\ *hostname\fP, in_port_t\fI\ port\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B char * memcached_stat_get_value(memcached_st\fI\ *ptr\fP, \fI\%memcached_stat_st\fP\fI\ *stat\fP, const char\fI\ *key\fP, memcached_return_t\fI\ *error\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B char ** memcached_stat_get_keys(memcached_st\fI\ *ptr\fP, \fI\%memcached_stat_st\fP\fI\ *stat\fP, memcached_return_t\fI\ *error\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_stat_execute(memcached_st\fI\ *memc\fP, const char\fI\ *args\fP, \fI\%memcached_stat_fn\fP\fI\ func\fP, void\fI\ *context\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_stat_st\fP structure. You are responsible for freeing this structure.
-While it is possible to access the structure directly it is not advisable.
-<memcached_stat_get_value() has been provided to query the structure.
+\fI\%memcached_stat_st\fP structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. \fI\%memcached_stat_get_value()\fP has been provided to query the structure.
 .sp
-memcached_stat_execute() uses the servers found in \fBmemcached_stat_st\fP and
-executes a "stat" command on each server. args is an optional argument that
-can be passed in to modify the behavior of "stats". You will need to supply
-a callback function that will be supplied each pair of values returned by
+\fI\%memcached_stat_execute()\fP uses the servers found in \fI\%memcached_stat_st\fP and executes a "stat" command on each server. args is an optional argument that can be passed in to modify the behavior of "stats". You will need to supply a callback function that will be supplied each pair of values returned by
 the memcached server.
 .sp
-memcached_stat() fetches an array of \fBmemcached_stat_st\fP structures containing
-the state of all available memcached servers. The return value must be freed
-by the calling application. If called with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fPbehavior set, a NULL value is returned and the error parameter is set to
-\fBMEMCACHED_NOT_SUPPORTED\fP.
+\fI\%memcached_stat()\fP fetches an array of \fI\%memcached_stat_st\fP structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior set, a NULL value is returned and the error parameter is set to \fBMEMCACHED_NOT_SUPPORTED\fP.
 .sp
-memcached_stat_servername() can be used standalone without a \fBmemcached_st\fP to
-obtain the state of a particular server.  "args" is used to define a
-particular state object (a list of these are not provided for by either
-the memcached_stat_get_keys() call nor are they defined in the memcached
-protocol). You must specify the hostname and port of the server you want to
+\fI\%memcached_stat_servername()\fP can be used standalone without a \fBmemcached_st\fP to obtain the state of a particular server.  "args" is used to define a particular state object (a list of these are not provided for by either
+the \fI\%memcached_stat_get_keys()\fP call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
 obtain information on.
 .sp
-memcached_stat_get_value() returns the value of a particular state key. You
-specify the key you wish to obtain.  The key must be null terminated.
+\fI\%memcached_stat_get_value()\fP returns the value of a particular state key. You specify the key you wish to obtain.  The key must be null terminated.
 .sp
-memcached_stat_get_keys() returns a list of keys that the server has state
-objects on. You are responsible for freeing this list.
+\fI\%memcached_stat_get_keys()\fP returns a list of keys that the server has state objects on. You are responsible for freeing this list.
 .sp
 A command line tool, memstat(1), is provided so that you do not have to write
 an application to do this.
@@ -106,7 +90,7 @@ an application to do this.
 .sp
 Varies, see particular functions.
 .sp
-Any method returning a \fBmemcached_stat_st\fP expects you to free the
+Any method returning a \fI\%memcached_stat_st\fP expects you to free the
 memory allocated for it.
 .SH HOME
 .sp
@@ -115,9 +99,9 @@ To find out more information please check:
 .SH AUTHOR
 .sp
 Brian Aker, <\fI\%brian@tangent.org\fP>
-.SS SEE ALSO
+.SH SEE ALSO
 .sp
-memcached(1) libmemcached(3) memcached_strerror(3)
+\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT