X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_stats.rst;h=56cce256f856c676aa9540896cee34fd9c6f042d;hb=e7855e43bbc4dd0a5e8fcbfd4888181001dcd1ec;hp=7fd47232e071b6929303fd34ca2935085755d6c8;hpb=df85b48564e1d418669d03814c6ac8f4bc82aab7;p=awesomized%2Flibmemcached

diff --git a/docs/memcached_stats.rst b/docs/memcached_stats.rst
index 7fd47232..56cce256 100644
--- a/docs/memcached_stats.rst
+++ b/docs/memcached_stats.rst
@@ -1,62 +1,34 @@
-.. highlight:: perl
+==================================================
+Working with statistical information from a server
+==================================================
 
 
-memcached_stat, memcached_stat_servername, memcached_stat_get_value, memcached_stat_get_keys
-********************************************************************************************
+Get memcached statistics
 
+.. index:: object: memcached_st
 
-Get memcached statistics
 
+--------
+SYNOPSIS
+--------
 
-*******
-LIBRARY
-*******
+#include <libmemcached/memcached.h>
 
+.. c:function:: memcached_stat_st *memcached_stat (memcached_st *ptr, char *args, memcached_return_t *error);
 
-C Client Library for memcached (libmemcached, -lmemcached)
+.. c:function:: memcached_return_t memcached_stat_servername (memcached_stat_st *stat, char *args, const char *hostname, unsigned int port);
 
+.. c:function:: char * memcached_stat_get_value (memcached_st *ptr, memcached_stat_st *stat, const char *key, memcached_return_t *error);
 
-********
-SYNOPSIS
-********
-
-
-
-.. code-block:: perl
-
-   #include <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);
-
-
-
-***********
+.. c:function:: char ** memcached_stat_get_keys (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error);
+
+.. c:function:: memcached_return_t memcached_stat_execute (memcached_st *memc, const char *args, memcached_stat_fn func, void *context);
+
+Compile and link with -lmemcached
+
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 libmemcached(3) has the ability to query a memcached server (or collection
@@ -79,24 +51,24 @@ behavior set, a NULL value is returned and the error parameter is set to
 
 memcached_stat_servername() can be used standalone without a \ ``memcached_st``\  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
-obtain information on.
+particular state object (a list of these are not provided for by either the
+:c:func:`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 obtain information on.
 
 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.
 
-memcached_stat_get_keys() returns a list of keys that the server has state
-objects on. You are responsible for freeing this list.
+:c:func:`memcached_stat_get_keys()` returns a list of keys that the server
+has state objects on. You are responsible for freeing this list.
 
 A command line tool, memstat(1), is provided so that you do not have to write
 an application to do this.
 
 
-******
+------
 RETURN
-******
+------
 
 
 Varies, see particular functions.
@@ -105,26 +77,26 @@ Any method returning a \ ``memcached_stat_st``\  expects you to free the
 memory allocated for it.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
-******
+------
 AUTHOR
-******
+------
 
 
 Brian Aker, <brian@tangent.org>
 
 
-********
+--------
 SEE ALSO
-********
+--------
 
 
 memcached(1) libmemcached(3) memcached_strerror(3)