From 12ebd3eb79086cdf4827fc392b398d0ea1088462 Mon Sep 17 00:00:00 2001 From: Brian Aker Date: Tue, 20 Sep 2011 15:43:51 -0700 Subject: [PATCH] Adding docs --- .bzrignore | 1 - docs/man/memcached_exist_by_key.3 | 69 ++++++++ docs/man/memcached_return_t.3 | 266 ++++++++++++++++++++++++++++++ 3 files changed, 335 insertions(+), 1 deletion(-) create mode 100644 docs/man/memcached_exist_by_key.3 create mode 100644 docs/man/memcached_return_t.3 diff --git a/.bzrignore b/.bzrignore index 763623e5..8432fe19 100644 --- a/.bzrignore +++ b/.bzrignore @@ -70,7 +70,6 @@ docs/doctest/ docs/doctrees/ docs/html/ docs/linkcheck/ -docs/man/* docs/text example/memcached_light libhashkit/configure.h diff --git a/docs/man/memcached_exist_by_key.3 b/docs/man/memcached_exist_by_key.3 new file mode 100644 index 00000000..3a98ebf7 --- /dev/null +++ b/docs/man/memcached_exist_by_key.3 @@ -0,0 +1,69 @@ +.TH "MEMCACHED_EXIST_BY_KEY" "3" "September 18, 2011" "0.52" "libmemcached" +.SH NAME +memcached_exist_by_key \- libmemcached Documentation +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.\" Man page generated from reStructeredText. +. +.SH SYNOPSIS +.sp +#include +.INDENT 0.0 +.TP +.B memcached_return_t memcached_exist(memcached_st\fI\ *ptr\fP, char\fI\ *key\fP, size_t\fI\ *key_length\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_exist_by_key(memcached_st\fI\ *ptr\fP, char\fI\ *group_key\fP, size_t\fI\ *group_key_length\fP, char\fI\ *key\fP, size_t\fI\ *key_length\fP) +.sp +New in version 0.53. +.UNINDENT +.sp +Compile and link with \-lmemcached +.SH DESCRIPTION +.sp +\fI\%memcached_exist()\fP can be used to check to see if a key exists. No value is returned if the key exists, or does not exist, on the server. +.SH RETURN +.sp +\fI\%memcached_exist()\fP sets error to +to \fBMEMCACHED_SUCCESS\fP upon finding that the key exists. +\fBMEMCACHED_NOTFOUND\fP will be return if the key is not found. +.SH HOME +.sp +To find out more information please check: +\fI\%http://libmemcached.org/\fP +.SH SEE ALSO +.sp +\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP +.SH AUTHOR +Brian Aker +.SH COPYRIGHT +2011, Brian Aker DataDifferential, http://datadifferential.com/ +.\" Generated by docutils manpage writer. +.\" +. diff --git a/docs/man/memcached_return_t.3 b/docs/man/memcached_return_t.3 new file mode 100644 index 00000000..2a2a1867 --- /dev/null +++ b/docs/man/memcached_return_t.3 @@ -0,0 +1,266 @@ +.TH "MEMCACHED_RETURN_T" "3" "September 18, 2011" "0.52" "libmemcached" +.SH NAME +memcached_return_t \- Return type values +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.\" Man page generated from reStructeredText. +. +.SH SYNOPSIS +.sp +#include +.INDENT 0.0 +.TP +.B memcached_return_t +.UNINDENT +.INDENT 0.0 +.TP +.B const char *libmemcached_strerror(libmemcached_return_t\fI\ rc\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B bool libmemcached_success(libmemcached_return_t\fI\ rc\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B bool libmemcached_failure(libmemcached_return_t\fI\ rc\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B bool libmemcache_continue(libmemcached_return_t\fI\ rc\fP) +.UNINDENT +.sp +\fBmemcached_success()\fP return true if \fI\%MEMCACHED_SUCCESS\fP tested true. +.sp +\fBmemcached_failure()\fP return true if any value other then \fI\%MEMCACHED_SUCCESS\fP was provided. +.SS Libmemcached return types: +.INDENT 0.0 +.TP +.B MEMCACHED_SUCCESS +.UNINDENT +.sp +Success +.INDENT 0.0 +.TP +.B MEMCACHED_FAILURE +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_HOST_LOOKUP_FAILURE +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_CONNECTION_FAILURE +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_CONNECTION_BIND_FAILURE +.UNINDENT +.sp +Deprecated since version <0.30. +.INDENT 0.0 +.TP +.B MEMCACHED_WRITE_FAILURE +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_READ_FAILURE +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_UNKNOWN_READ_FAILURE +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_PROTOCOL_ERROR +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_CLIENT_ERROR +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_SERVER_ERROR +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE +.UNINDENT +.sp +Deprecated since version <0.30. +.INDENT 0.0 +.TP +.B MEMCACHED_DATA_EXISTS +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_DATA_DOES_NOT_EXIST +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_NOTSTORED +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_STORED +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_NOTFOUND +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_MEMORY_ALLOCATION_FAILURE +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_PARTIAL_READ +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_SOME_ERRORS +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_NO_SERVERS +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_END +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_DELETED +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_VALUE +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_STAT +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_ITEM +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_ERRNO +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_FAIL_UNIX_SOCKET +.UNINDENT +.sp +Deprecated since version <0.30. +.INDENT 0.0 +.TP +.B MEMCACHED_NOT_SUPPORTED +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_NO_KEY_PROVIDED +.UNINDENT +.sp +Deprecated since version <0.30: Use \fI\%MEMCACHED_BAD_KEY_PROVIDED\fP instead. +.INDENT 0.0 +.TP +.B MEMCACHED_FETCH_NOTFINISHED +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_TIMEOUT +. +Connection to server timed out. +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_BUFFERED +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_BAD_KEY_PROVIDED +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_INVALID_HOST_PROTOCOL +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_SERVER_MARKED_DEAD +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_UNKNOWN_STAT_KEY +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_E2BIG +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_INVALID_ARGUMENTS +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_KEY_TOO_BIG +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_AUTH_PROBLEM +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_AUTH_FAILURE +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_AUTH_CONTINUE +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_PARSE_ERROR +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_PARSE_USER_ERROR +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_DEPRECATED +.UNINDENT +.SH SEE ALSO +.sp +\fImemcached(8)\fP \fIlibmemcached(3)\fP \fImemcached_client_error()\fP or \fImemcached_worker_error()\fP +.SH AUTHOR +Brian Aker +.SH COPYRIGHT +2011, Brian Aker DataDifferential, http://datadifferential.com/ +.\" Generated by docutils manpage writer. +.\" +. -- 2.30.2