X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_stat_get_keys.3;h=9c63ffde18471e0af151b929ef8fa11309f0197a;hb=c87f1a554cce74ac1ba3d4e7e9c2a1d2904e4766;hp=e03b7dfc5aa16833d366a1110edd7416f565c28c;hpb=86be0943416087ba738c28ddbde8cdcbd62ad777;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_stat_get_keys.3 b/docs/man/memcached_stat_get_keys.3 index e03b7dfc..9c63ffde 100644 --- a/docs/man/memcached_stat_get_keys.3 +++ b/docs/man/memcached_stat_get_keys.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_STAT_GET_KEYS" "3" "April 13, 2011" "0.47" "libmemcached" +.TH "MEMCACHED_STAT_GET_KEYS" "3" "June 17, 2011" "0.49" "libmemcached" .SH NAME memcached_stat_get_keys \- libmemcached Documentation . @@ -32,43 +32,32 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] . .sp Get memcached statistics -.SH LIBRARY +.SH SYNOPSIS .sp -C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS -.sp -.nf -.ft C #include - -memcached_stat_st *memcached_stat (memcached_st *ptr, - char *args, - memcached_return_t *error); - -memcached_return_t memcached_stat_servername (memcached_stat_st *stat, - char *args, - const char *hostname, - unsigned int port); - -char * - memcached_stat_get_value (memcached_st *ptr, - memcached_stat_st *stat, - const char *key, - memcached_return_t *error); - -char ** - memcached_stat_get_keys (memcached_st *ptr, - memcached_stat_st *stat, - memcached_return_t *error); - -memcached_return_t - memcached_stat_execute (memcached_st *memc, - const char *args, - memcached_stat_fn func, - void *context); -.ft P -.fi -.SS DESCRIPTION +.INDENT 0.0 +.TP +.B memcached_stat_st *memcached_stat (memcached_st *ptr, char *args, memcached_return_t *error); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_stat_servername (memcached_stat_st *stat, char *args, const char *hostname, unsigned int port); +.UNINDENT +.INDENT 0.0 +.TP +.B char * memcached_stat_get_value (memcached_st *ptr, memcached_stat_st *stat, const char *key, memcached_return_t *error); +.UNINDENT +.INDENT 0.0 +.TP +.B char ** memcached_stat_get_keys (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_stat_execute (memcached_st *memc, const char *args, memcached_stat_fn func, void *context); +.UNINDENT +.sp +Compile and link with \-lmemcached +.SH DESCRIPTION .sp libmemcached(3) has the ability to query a memcached server (or collection of servers) for their current state. Queries to find state return a @@ -89,16 +78,16 @@ by the calling application. If called with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fPb .sp memcached_stat_servername() can be used standalone without a \fBmemcached_st\fP to obtain the state of a particular server. "args" is used to define a -particular state object (a list of these are not provided for by either -the memcached_stat_get_keys() call nor are they defined in the memcached -protocol). You must specify the hostname and port of the server you want to -obtain information on. +particular state object (a list of these are not provided for by either the +\fBmemcached_stat_get_keys()\fP call nor are they defined in the +memcached protocol). You must specify the hostname and port of the server +you want to obtain information on. .sp memcached_stat_get_value() returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated. .sp -memcached_stat_get_keys() returns a list of keys that the server has state -objects on. You are responsible for freeing this list. +\fBmemcached_stat_get_keys()\fP returns a list of keys that the server +has state objects on. You are responsible for freeing this list. .sp A command line tool, memstat(1), is provided so that you do not have to write an application to do this. @@ -115,7 +104,7 @@ To find out more information please check: .SH AUTHOR .sp Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp memcached(1) libmemcached(3) memcached_strerror(3) .SH AUTHOR