X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_analyze.rst;h=56fbf1f3edf378c38cb946cba24d107992ff7500;hb=2aacfe6223ea5ff3656c900041a0f7ed847c2bf1;hp=cd8f36fb4bb787a556f88469986ec09bafd03e3e;hpb=c4dbc7e56b01545e25bc95ba122c79d4a2631a99;p=awesomized%2Flibmemcached diff --git a/docs/memcached_analyze.rst b/docs/memcached_analyze.rst index cd8f36fb..56fbf1f3 100644 --- a/docs/memcached_analyze.rst +++ b/docs/memcached_analyze.rst @@ -1,42 +1,27 @@ -.. highlight:: perl +================= +Anaylzing servers +================= -**** -NAME -**** +Analyze server information -memcached_analyze - Analyze server information - - -******* -LIBRARY -******* - - -C Client Library for memcached (libmemcached, -lmemcached) - - -******** +-------- SYNOPSIS -******** +-------- +.. index:: object: memcached_analysis_st -.. code-block:: perl - - #include +#include - memcached_analysis_st * - memcached_analyze (memcached_st *ptr, - memcached_stat_st *stat, - memcached_return_t *error); - +.. c:function:: memcached_analysis_st * memcached_analyze (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error); +Compile and link with -lmemcached -*********** +----------- DESCRIPTION -*********** +----------- libmemcached(3) has the ability to query a memcached server (or collection @@ -51,9 +36,9 @@ A command line tool, memstat(1) with the option --analyze, is provided so that you do not have to write an application to use this method. -****** +------ RETURN -****** +------ A pointer to the allocated \ ``memcached_analysis_st``\ structure on success and @@ -64,27 +49,19 @@ Any method returning a \ ``memcached_analysis_st``\ expects you to free the memory allocated for it. -**** +---- HOME -**** +---- To find out more information please check: -`https://launchpad.net/libmemcached `_ - - -****** -AUTHOR -****** - - -Toru Maesaka, +`http://libmemcached.org/ `_ -******** +-------- SEE ALSO -******** +-------- -memcached(1) libmemcached(3) memcached_strerror(3) +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`