Merge in update such that trunk tree no longer commits manpages.
[m6w6/libmemcached] / docs / memcached_version.rst
index 334e09be3aa7837509bbc864c98aeddedfbaf051..ae983f4c49d81adbb2abeec9dbbf0ef9506bbf09 100644 (file)
@@ -1,56 +1,39 @@
-.. highlight:: perl
+=======================================================
+Getting version information about the client and server
+=======================================================
 
-
-memcached_lib_version, memcached_version
-****************************************
-
-
-Get library version
-
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
-
-********
+--------
 SYNOPSIS
-********
+--------
 
+#include <libmemcached/memcached.h>
 
+.. c:function:: const char * memcached_lib_version (void) 
 
-.. code-block:: perl
+.. c:function:: memcached_return_t memcached_version (memcached_st *ptr)
 
-   #include <libmemcached/memcached.h>
-   const char *
-     memcached_lib_version (void) 
-   memcached_return_t
-     memcached_version (memcached_st *ptr)
+
+Compile and link with -lmemcached
 
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 memcached_lib_version() is used to return a simple version string representing
-the libmemcached version (version of the client library, not server)
+the libmemcached version (client library version, not server version)
 
 memcached_version() is used to set the major, minor, and micro versions of each
 memcached server being used by the memcached_st connection structure. It returns the 
 memcached server return code.
 
 
-******
+------
 RETURN
-******
+------
 
 
 A string with the version of libmemcached driver is returned from
@@ -63,26 +46,18 @@ will be returned. 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>
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
-********
+--------
 SEE ALSO
-********
+--------
 
 
 memcached(1) libmemcached(3) memcached_strerror(3)