X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_stat.3;h=1ca317fdf173bc0dfa920b653b146cce63b9dc3b;hb=995b0b293b47e2a45de776202938d365d3775319;hp=7d5b82c7febf4a11517209b643101275a8d5b574;hpb=f285e1b3821f56a8983b5ce9fb1a0070e7bb0a1c;p=m6w6%2Flibmemcached

diff --git a/docs/man/memcached_stat.3 b/docs/man/memcached_stat.3
index 7d5b82c7..1ca317fd 100644
--- a/docs/man/memcached_stat.3
+++ b/docs/man/memcached_stat.3
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_STAT" "3" "April 07, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_STAT" "3" "September 26, 2011" "0.53" "libmemcached"
 .SH NAME
 memcached_stat \- libmemcached Documentation
 .
@@ -32,73 +32,49 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .
 .sp
 Get memcached statistics
-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcached, \-lmemcached)
 .SH 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
+.INDENT 0.0
+.TP
+.B memcached_stat_st *memcached_stat (memcached_st *ptr, char *args, memcached_return_t *error);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_stat_servername (memcached_stat_st *stat, char *args, const char *hostname, unsigned int port);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B char * memcached_stat_get_value (memcached_st *ptr, memcached_stat_st *stat, const char *key, memcached_return_t *error);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B char ** memcached_stat_get_keys (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_stat_execute (memcached_st *memc, const char *args, memcached_stat_fn func, void *context);
+.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.
+\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. \fBmemcached_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
+\fBmemcached_stat_execute()\fP 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
 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.
+\fBmemcached_stat()\fP 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\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
+\fBmemcached_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 \fBmemcached_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.
+\fBmemcached_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.
+\fBmemcached_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.
@@ -111,17 +87,17 @@ memory allocated for it.
 .SH HOME
 .sp
 To find out more information please check:
-\fI\%https://launchpad.net/libmemcached\fP
+\fI\%http://libmemcached.org/\fP
 .SH AUTHOR
 .sp
 Brian Aker, <\fI\%brian@tangent.org\fP>
 .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
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
 .\" Generated by docutils manpage writer.
 .\" 
 .