X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_version.rst;h=20b8b25a20150943bcf2e0f7f238ab5d0476ae1c;hb=bcf4f7d33fd0b0cb5bb599b300aa043effc62a33;hp=a670c78f8e3280c475dd4c9b405675b43e03d559;hpb=0f16555031c7f44d1acd034ff74e628c51a72dac;p=m6w6%2Flibmemcached diff --git a/docs/memcached_version.rst b/docs/memcached_version.rst index a670c78f..20b8b25a 100644 --- a/docs/memcached_version.rst +++ b/docs/memcached_version.rst @@ -2,34 +2,19 @@ Getting version information about the client and server ======================================================= - -Get library version - - -******* -LIBRARY -******* - - -C Client Library for memcached (libmemcached, -lmemcached) - - + -------- SYNOPSIS -------- +#include +.. c:function:: const char * memcached_lib_version (void) -.. code-block:: perl +.. c:function:: memcached_return_t memcached_version (memcached_st *ptr) - #include - - const char * - memcached_lib_version (void) - - - memcached_return_t - memcached_version (memcached_st *ptr) + +Compile and link with -lmemcached @@ -38,50 +23,41 @@ DESCRIPTION ----------- -memcached_lib_version() is used to return a simple version string representing -the libmemcached version (client library version, not server version) +:c:func:`memcached_lib_version` is used to return a simple version string representing 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. +:c:func:`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 -****** +------ + + +:c:func:`memcached_lib_version` returns a string with the version of the libmemcached driver. + +A value of :c:type:`memcached_return_t` is returned from :c:func:'memcached_version' +On success that value will be :c:type:`MEMCACHED_SUCCESS`. -A string with the version of libmemcached driver is returned from -memcached_lib_version() +If called with the :c:func:`MEMCACHED_BEHAVIOR_USE_UDP` behavior set, the value :c:type:`MEMCACHED_NOT_SUPPORTED` will be returned. -A value of type \ ``memcached_return_t``\ is returned from memcached_version() -On success that value will be \ ``MEMCACHED_SUCCESS``\ . If called with the -\ ``MEMCACHED_BEHAVIOR_USE_UDP``\ behavior set, the value \ ``MEMCACHED_NOT_SUPPORTED``\ -will be returned. Use memcached_strerror() to translate this value to +Use :c:func:`memcached_strerror` to translate this value to a printable string. -**** +---- HOME -**** +---- To find out more information please check: `http://libmemcached.org/ `_ -****** -AUTHOR -****** - - -Brian Aker, - - -------- SEE ALSO -------- -memcached(1) libmemcached(3) memcached_strerror(3) +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`