Merge in cleanup on the parser API.
[m6w6/libmemcached] / docs / memcached_quit.rst
index aedcac428fce7600c376cb64b19a8bac89f7b385..58c9f8ebabcf34317966b75a877528d7f73a6608 100644 (file)
@@ -1,38 +1,21 @@
-.. highlight:: perl
+====================================
+Disconnecting a client from a server
+====================================
 
 
-memcached_quit
-**************
-
-
-Disconnect from all servers
-
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
-
-********
+--------
 SYNOPSIS
-********
-
-
-
-.. code-block:: perl
+--------
 
-   #include <memcached.h>
+#include <libmemcached/memcached.h>
  
-   void memcached_quit (memcached_st *ptr);
+.. c:function:: void memcached_quit (memcached_st *ptr);
 
+Compile and link with -lmemcached
 
-
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 memcached_quit() will disconnect you from all currently connected servers.
@@ -46,9 +29,9 @@ function is provided mainly so that you can timeout your connections or
 reset connections during the middle of a memcached_fetch().
 
 
-******
+------
 RETURN
-******
+------
 
 
 A value of type \ ``memcached_return``\  is returned
@@ -56,27 +39,25 @@ On success that value will be \ ``MEMCACHED_SUCCESS``\ .
 Use memcached_strerror() to translate this value to a printable string.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 
 
-******
+------
 AUTHOR
-******
+------
 
 
 Brian Aker, <brian@tangent.org>
 
 
-********
+--------
 SEE ALSO
-********
-
-
-memcached(1) libmemcached(3) memcached_strerror(3)
+--------
 
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`