Merge lp:~tangent-org/libmemcached/1.0-build Build: jenkins-Libmemcached-1.0-60
[awesomized/libmemcached] / docs / memcached_verbosity.rst
index 15264aecf25e80189cab57648073ed7eb5aa9da2..c3ae0d89cc05098d84cdaaa178aafee434d0b0df 100644 (file)
@@ -2,32 +2,19 @@
 Setting the verbosity of a server
 =================================
 
+.. index:: object: memcached_st
 
 Modifiy verbosity of servers
 
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
-
 --------
 SYNOPSIS
 --------
 
+#include <libmemcached/memcached.h>
 
+.. c:function:: memcached_return_t memcached_verbosity (memcached_st *ptr, uint32_t verbosity)
 
-.. code-block:: perl
-
-   #include <libmemcached/memcached.h>
-   memcached_return_t 
-     memcached_verbosity (memcached_st *ptr,
-                          unsigned int verbosity);
-
+Compile and link with -lmemcached
 
 
 -----------
@@ -35,35 +22,29 @@ DESCRIPTION
 -----------
 
 
-memcached_verbosity() modifies the "verbosity" of the
-memcached(1) servers referenced in the \ ``memcached_st``\  parameter.
+:c:func:`memcached_verbosity` modifies the "verbosity" of the
+memcached(1) servers referenced in the :c:type:`memcached_st`  parameter.
 
 
-******
+------
 RETURN
-******
+------
 
 
-A value of type \ ``memcached_return_t``\  is returned
-On success that value will be \ ``MEMCACHED_SUCCESS``\ .
-Use memcached_strerror() to translate this value to a printable string.
+A value of type :c:type:`memcached_return_t` is returned.
 
+On success that value will be :c:type:`MEMCACHED_SUCCESS`.
 
-****
-HOME
-****
-
-
-To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+Use :c:func:`memcached_strerror` to translate this value to a printable string.
 
 
-******
-AUTHOR
-******
+----
+HOME
+----
 
 
-Brian Aker, <brian@tangent.org>
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
 --------
@@ -71,5 +52,5 @@ SEE ALSO
 --------
 
 
-memcached(1) libmemcached(3) memcached_strerror(3)
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`