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

[m6w6/libmemcached] / docs / memcached_analyze.rst

diff --git a/docs/memcached_analyze.rst b/docs/memcached_analyze.rst
index 28f7f7491b583138633681128bdd1fc1ac59afad..56fbf1f3edf378c38cb946cba24d107992ff7500 100644 (file)
--- a/docs/memcached_analyze.rst
+++ b/docs/memcached_analyze.rst
@@ -1,41 +1,27 @@
-.. highlight:: perl
-
-
-memcached_analyze
-*****************
+=================
+Anaylzing servers
+=================
 
 
 Analyze server information
 
 
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
-
-********
+--------
 SYNOPSIS
-********
+--------
 
+.. index:: object: memcached_analysis_st
 
 
-.. code-block:: perl
-
-   #include <memcached.h>
+#include <libmemcached/memcached.h>
  
-   memcached_analysis_st *
-     memcached_analyze (memcached_st *ptr,
-                        memcached_stat_st *stat,
-                        memcached_return_t *error);
-
+.. c:function::  memcached_analysis_st * memcached_analyze (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error);
 
+Compile and link with -lmemcached
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 libmemcached(3) has the ability to query a memcached server (or collection
@@ -50,9 +36,9 @@ A command line tool, memstat(1) with the option --analyze, is provided so that
 you do not have to write an application to use this method.
 
 
-******
+------
 RETURN
-******
+------
 
 
 A pointer to the allocated \ ``memcached_analysis_st``\  structure on success and
@@ -63,27 +49,19 @@ Any method returning a \ ``memcached_analysis_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>`_
-
-
-******
-AUTHOR
-******
-
-
-Toru Maesaka, <dev@torum.net>
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
-********
+--------
 SEE ALSO
-********
+--------
 
 
-memcached(1) libmemcached(3) memcached_strerror(3)
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`