X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_auto.3;h=d8bf8dc56ceb2dd157c1ac46f6feca9f92a47e9f;hb=6e9731947eace4be83d553a242a44b36b3adcf22;hp=ded157eb9863c9de79a8b07cdcf93962d57cef49;hpb=ef301192f389f5f6ab4f8ed8c204ca7e115fe0b1;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_auto.3 b/docs/man/memcached_auto.3 index ded157eb..d8bf8dc5 100644 --- a/docs/man/memcached_auto.3 +++ b/docs/man/memcached_auto.3 @@ -1,6 +1,6 @@ -.TH "MEMCACHED_AUTO" "3" "April 08, 2011" "0.47" "libmemcached" +.TH "MEMCACHED_AUTO" "3" "April 12, 2011" "0.47" "libmemcached" .SH NAME -memcached_auto \- libmemcached Documentation +memcached_auto \- Incrementing and Decrementing Values . .nr rst2man-indent-level 0 . @@ -30,87 +30,46 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . +.SH SYNOPSIS .sp -Manipulate counters -.SH LIBRARY -.sp -C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS -.sp -.nf -.ft C #include - -memcached_return_t - memcached_increment (memcached_st *ptr, - const char *key, size_t key_length, - unsigned int offset, - uint64_t *value); - -memcached_return_t - memcached_decrement (memcached_st *ptr, - const char *key, size_t key_length, - unsigned int offset, - uint64_t *value); - -memcached_return_t - memcached_increment_with_initial (memcached_st *ptr, - const char *key, - size_t key_length, - uint64_t offset, - uint64_t initial, - time_t expiration, - uint64_t *value); - -memcached_return_t - memcached_decrement_with_initial (memcached_st *ptr, - const char *key, - size_t key_length, - uint64_t offset, - uint64_t initial, - time_t expiration, - uint64_t *value); - -memcached_return_t - memcached_increment_by_key (memcached_st *ptr, - const char *master_key, size_t master_key_length, - const char *key, size_t key_length, - unsigned int offset, - uint64_t *value); - -memcached_return_t - memcached_decrement_by_key (memcached_st *ptr, - const char *master_key, size_t master_key_length, - const char *key, size_t key_length, - unsigned int offset, - uint64_t *value); - -memcached_return_t - memcached_increment_with_initial_by_key (memcached_st *ptr, - const char *master_key, - size_t master_key_length, - const char *key, - size_t key_length, - uint64_t offset, - uint64_t initial, - time_t expiration, - uint64_t *value); - -memcached_return_t - memcached_decrement_with_initial_by_key (memcached_st *ptr, - const char *master_key, - size_t master_key_length, - const char *key, - size_t key_length, - uint64_t offset, - uint64_t initial, - time_t expiration, - uint64_t *value); -.ft P -.fi -.SS DESCRIPTION +.INDENT 0.0 +.TP +.B memcached_return_t memcached_increment (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_decrement (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_increment_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_decrement_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_increment_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, unsigned int offset, uint64_t *value); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_decrement_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, unsigned int offset, uint64_t *value); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_increment_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_decrement_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value); +.UNINDENT +.sp +Compile and link with \-lmemcached +.SH DESCRIPTION .sp -memcached(1) servers have the ability to increment and decrement keys +\fImemcached(1)\fP servers have the ability to increment and decrement keys (overflow and underflow are not detected). This gives you the ability to use memcached to generate shared sequences of values. .sp @@ -153,10 +112,7 @@ Use memcached_strerror() to translate this value to a printable string. .sp To find out more information please check: \fI\%https://launchpad.net/libmemcached\fP -.SH AUTHOR -.sp -Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR