From fd8540c3e8a911de4f218d4cc0e585ee55a999e7 Mon Sep 17 00:00:00 2001 From: Trond Norbye Date: Fri, 18 Sep 2009 09:21:11 +0200 Subject: [PATCH] Add manual page for memcapable --- docs/Makefile.am | 22 ++++++++++------ docs/memcapable.pod | 61 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 75 insertions(+), 8 deletions(-) create mode 100644 docs/memcapable.pod diff --git a/docs/Makefile.am b/docs/Makefile.am index 598eaf06..7972cc98 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -19,6 +19,7 @@ EXTRA_DIST = libmemcached.pod\ memcached_behavior.pod\ memcached_callback.pod\ memcached_server_st.pod\ + memcapable.pod \ memcat.pod\ memcached_create.pod\ memcached_pool.pod\ @@ -37,6 +38,7 @@ EXTRA_DIST = libmemcached.pod\ man_MANS = libmemcached.3\ libmemcached_examples.3\ + memcapable.1\ memcat.1\ memcp.1\ memerror.1\ @@ -112,16 +114,16 @@ man_MANS+= libmemcachedutil.3 \ endif -libmemcached.3: libmemcached.pod +libmemcached.3: libmemcached.pod ${POD2MAN} -c "libmemcached" -r "" -s 3 ${top_srcdir}/docs/libmemcached.pod > libmemcached.3 -libmemcachedutil.3: libmemcachedutil.pod +libmemcachedutil.3: libmemcachedutil.pod ${POD2MAN} -c "libmemcachedutil" -r "" -s 3 ${top_srcdir}/docs/libmemcachedutil.pod > libmemcachedutil.3 libmemcached_examples.3: libmemcached_examples.pod ${POD2MAN} -c "libmemcached" -r "" -s 3 ${top_srcdir}/docs/libmemcached_examples.pod > libmemcached_examples.3 -memcached_create.3: memcached_create.pod +memcached_create.3: memcached_create.pod ${POD2MAN} -c "libmemcached" -r "" -s 3 ${top_srcdir}/docs/memcached_create.pod > memcached_create.3 memcached_free.3: memcached_create.pod @@ -325,16 +327,16 @@ memcached_get_user_data.3: memcached_user_data.pod memcached_set_user_data.3: memcached_user_data.pod ${POD2MAN} -c "libmemcached" -r "" -s 3 ${top_srcdir}/docs/memcached_user_data.pod > memcached_set_user_data.3 -memcached_pool_create.3: memcached_pool.pod +memcached_pool_create.3: memcached_pool.pod ${POD2MAN} -c "libmemcachedutil" -r "" -s 3 ${top_srcdir}/docs/memcached_pool.pod > memcached_pool_create.3 -memcached_pool_destroy.3: memcached_pool.pod +memcached_pool_destroy.3: memcached_pool.pod ${POD2MAN} -c "libmemcachedutil" -r "" -s 3 ${top_srcdir}/docs/memcached_pool.pod > memcached_pool_destroy.3 -memcached_pool_pop.3: memcached_pool.pod +memcached_pool_pop.3: memcached_pool.pod ${POD2MAN} -c "libmemcachedutil" -r "" -s 3 ${top_srcdir}/docs/memcached_pool.pod > memcached_pool_pop.3 -memcached_pool_push.3: memcached_pool.pod +memcached_pool_push.3: memcached_pool.pod ${POD2MAN} -c "libmemcachedutil" -r "" -s 3 ${top_srcdir}/docs/memcached_pool.pod > memcached_pool_push.3 memcp.1: memcp.pod @@ -343,6 +345,9 @@ memcp.1: memcp.pod memslap.1: memslap.pod ${POD2MAN} -c "libmemcached" -r "" -s 1 ${top_srcdir}/docs/memslap.pod > memslap.1 +memcapable.1: memcapable.pod + ${POD2MAN} -c "libmemcached" -r "" -s 1 ${top_srcdir}/docs/memcapable.pod > memcapable.1 + memcat.1: memcat.pod ${POD2MAN} -c "libmemcached" -r "" -s 1 ${top_srcdir}/docs/memcat.pod > memcat.1 @@ -361,7 +366,7 @@ memdump.1: memdump.pod memflush.1: memflush.pod ${POD2MAN} -c "libmemcached" -r "" -s 1 ${top_srcdir}/docs/memflush.pod > memflush.1 -test: +test: podchecker $(top_srcdir)/docs/libmemcached.pod podchecker $(top_srcdir)/docs/memcached_flush.pod podchecker $(top_srcdir)/docs/memcached_stats.pod @@ -390,6 +395,7 @@ test: podchecker $(top_srcdir)/docs/memcached_pool.pod podchecker $(top_srcdir)/docs/memcached_memory_allocators.pod podchecker $(top_srcdir)/docs/memcached_user_data.pod + podchecker $(top_srcdir)/docs/memcapable.pod html-local: pod2htmltree "/libmemcached" . diff --git a/docs/memcapable.pod b/docs/memcapable.pod new file mode 100644 index 00000000..6555988b --- /dev/null +++ b/docs/memcapable.pod @@ -0,0 +1,61 @@ +=head1 NAME + +memcapable - Check memcached server capabilites + +=head1 SYNOPSIS + + memcat [-h hostname] [-p port] [-c] [-v] [-t n] + +=head1 DESCRIPTION + +B connects to the specified memcached server and tries to +determine its capabilities by running the various commands and verifying +the response. + +=head1 OPTIONS + +The following options are supported: + +=over 3 + +=item -h hostname + +Specify the hostname to connect to. The default is I + +=item -p port + +Specify the port number to connect to. The default is I<11211> + +=item -c + +Generate a coredump when it detects an error from the server. + +=item -v + +Print out the comparison when it detects an error from the server. + +=item -t n + +Set the timeout from an IO operation to/from the server to I seconds. + +=back + +=head1 LIMITATIONS + +The current version of memcapable will only verify the binary protocol. + +=head1 HOME + +To find out more information please check: +L + +=head1 AUTHOR + +Trond Norbye, Etrond.norbye@sun.comE + +=head1 SEE ALSO + +memcached(1) libmemcached(3) + +=cut + -- 2.30.2