From 0ce534a791d671a2988e6835f5675e35a8c80636 Mon Sep 17 00:00:00 2001 From: Brian Aker Date: Sun, 12 Feb 2012 03:50:26 -0800 Subject: [PATCH] Update docs --- clients/memexist.cc | 2 +- docs/bin/memexist.rst | 64 +++++++++++++++++++++++++++++++++++++++++++ docs/bin/memparse.rst | 56 +++++++++++++++++++++++++++++++++++++ docs/bin/memping.rst | 61 +++++++++++++++++++++++++++++++++++++++++ docs/bin/memtouch.rst | 63 ++++++++++++++++++++++++++++++++++++++++++ docs/conf.py.in | 4 +++ docs/index.rst | 4 +++ 7 files changed, 253 insertions(+), 1 deletion(-) create mode 100644 docs/bin/memexist.rst create mode 100644 docs/bin/memparse.rst create mode 100644 docs/bin/memping.rst create mode 100644 docs/bin/memtouch.rst diff --git a/clients/memexist.cc b/clients/memexist.cc index 20ad4850..c3871dea 100644 --- a/clients/memexist.cc +++ b/clients/memexist.cc @@ -28,7 +28,7 @@ static char *opt_username; static char *opt_passwd; #define PROGRAM_NAME "memexist" -#define PROGRAM_DESCRIPTION "Erase a key or set of keys from a memcached cluster." +#define PROGRAM_DESCRIPTION "Check for the existance of a key within a cluster." /* Prototypes */ static void options_parse(int argc, char *argv[]); diff --git a/docs/bin/memexist.rst b/docs/bin/memexist.rst new file mode 100644 index 00000000..22c3a4d8 --- /dev/null +++ b/docs/bin/memexist.rst @@ -0,0 +1,64 @@ +=========================================== +memexist - Check for the existance of a key +=========================================== + + +-------- +SYNOPSIS +-------- + +memexist [options] [key] + +.. program:: memexist + + +----------- +DESCRIPTION +----------- + +:program:`memexist` checks for the existance of a key within a cluster. + + +------- +OPTIONS +------- + + +You can specify servers via the option: + +.. option:: --servers + +or via the environment variable: + +.. envvar:: `MEMCACHED_SERVERS` + +If you do not specify either these, the final value in the command line list is the name of a server(s). + +For a full list of operations run the tool with the option: + +.. option:: --help + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` + diff --git a/docs/bin/memparse.rst b/docs/bin/memparse.rst new file mode 100644 index 00000000..c50c5f02 --- /dev/null +++ b/docs/bin/memparse.rst @@ -0,0 +1,56 @@ +================================= +memparse - Parse an option string +================================= + + +Copies files to a collection of memcached servers + + +-------- +SYNOPSIS +-------- + +memparse [options] "option string" + +.. program:: memparse + + +----------- +DESCRIPTION +----------- + + +:program:`memparse` can be used to validate an option string. + +------- +OPTIONS +------- + +For a full list of operations run the tool with the option: + +.. option:: --help + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` + diff --git a/docs/bin/memping.rst b/docs/bin/memping.rst new file mode 100644 index 00000000..5a784299 --- /dev/null +++ b/docs/bin/memping.rst @@ -0,0 +1,61 @@ +=============================================== +memping - Test to see if a server is available. +=============================================== + + +-------- +SYNOPSIS +-------- + +memping [options] [server] + +.. program:: memping + + +----------- +DESCRIPTION +----------- + + +:program:`memping` can be used to ping a memcached server to see if it is taking connections. + +------- +OPTIONS +------- + + +You can specify servers via the option: + +.. option:: --servers + +or via the environment variable: + +.. envvar:: `MEMCACHED_SERVERS` + +If you do not specify either these, the final value in the command line list is the name of a server(s). + +For a full list of operations run the tool with the option: + +.. option:: --help + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + +Brian Aker, + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/bin/memtouch.rst b/docs/bin/memtouch.rst new file mode 100644 index 00000000..3f7cd1c7 --- /dev/null +++ b/docs/bin/memtouch.rst @@ -0,0 +1,63 @@ +========================= +memtouch - Touches a key. +========================= + + +-------- +SYNOPSIS +-------- + +memtouch [options] key + +.. program:: memtouch + + +----------- +DESCRIPTION +----------- + + +:program:`memtouch` does a "touch" on the specified key. + +------- +OPTIONS +------- + + +You can specify servers via the option: + +.. option:: --servers + +or via the environment variable: + +.. envvar:: `MEMCACHED_SERVERS` + +If you do not specify either these, the final value in the command line list is the name of a server(s). + +For a full list of operations run the tool with the option: + +.. option:: --help + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + +Brian Aker, + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` + diff --git a/docs/conf.py.in b/docs/conf.py.in index 5686ad04..08b6f639 100644 --- a/docs/conf.py.in +++ b/docs/conf.py.in @@ -353,4 +353,8 @@ man_pages = [ ('bin/memaslap', 'memaslap', u'libmemcached Documentation', [u'Brian Aker'], 1), ('bin/memslap', 'memslap', u'libmemcached Documentation', [u'Brian Aker'], 1), ('bin/memstat', 'memstat', u'libmemcached Documentation', [u'Brian Aker'], 1), + ('bin/memexist', 'memexist', u'libmemcached Documentation', [u'Brian Aker'], 1), + ('bin/memparse', 'memparse', u'libmemcached Documentation', [u'Brian Aker'], 1), + ('bin/memping', 'memping', u'libmemcached Documentation', [u'Brian Aker'], 1), + ('bin/memtouch', 'memtouch', u'libmemcached Documentation', [u'Brian Aker'], 1), ] diff --git a/docs/index.rst b/docs/index.rst index 286848e5..e0dba59b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -129,6 +129,10 @@ Client Applications bin/memslap bin/memaslap bin/memstat + bin/memexist.rst + bin/memparse.rst + bin/memping.rst + bin/memtouch.rst ---------- Libhashkit -- 2.30.2