Merge in update such that trunk tree no longer commits manpages.

[m6w6/libmemcached] / docs / memcached_stats.rst

diff --git a/docs/memcached_stats.rst b/docs/memcached_stats.rst
index 5fa154428ea0a2a46fc8cd1e1578f50cb3129904..56cce256f856c676aa9540896cee34fd9c6f042d 100644 (file)
--- a/docs/memcached_stats.rst
+++ b/docs/memcached_stats.rst
@@ -5,52 +5,26 @@ Working with statistical information from a server
 
 Get memcached statistics
 
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
+.. index:: object: memcached_st
 
 
 --------
 SYNOPSIS
 --------
 
+#include <libmemcached/memcached.h>
+
+.. c:function:: memcached_stat_st *memcached_stat (memcached_st *ptr, char *args, memcached_return_t *error);
+
+.. 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);
 
-.. code-block:: perl
-
-   #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);
+.. 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
@@ -77,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.
@@ -103,18 +77,18 @@ 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>