Replace pod docs with sphinx docs.

[awesomized/libmemcached] / docs / memcached_quit.rst

diff --git a/docs/memcached_quit.rst b/docs/memcached_quit.rst
new file mode 100644 (file)
index 0000000..cf5abdb
--- /dev/null
+++ b/docs/memcached_quit.rst
@@ -0,0 +1,83 @@
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+memcached_quit - Disconnect from all servers
+
+
+*******
+LIBRARY
+*******
+
+
+C Client Library for memcached (libmemcached, -lmemcached)
+
+
+********
+SYNOPSIS
+********
+
+
+
+.. code-block:: perl
+
+   #include <memcached.h>
+ 
+   void memcached_quit (memcached_st *ptr);
+
+
+
+***********
+DESCRIPTION
+***********
+
+
+memcached_quit() will disconnect you from all currently connected servers.
+It will also reset the state of the connection (ie, any memcached_fetch() you
+are in the middle of will be terminated). This function is called
+automatically when you call memcached_free() on the \ ``memcached_st``\  structure.
+
+You do not need to call this on your own. All operations to change server
+hashes and parameters will handle connections to the server for you. This
+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
+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)
+