summaryrefslogtreecommitdiff
path: root/docs/source/bin/memping.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/bin/memping.rst')
-rw-r--r--docs/source/bin/memping.rst61
1 files changed, 61 insertions, 0 deletions
diff --git a/docs/source/bin/memping.rst b/docs/source/bin/memping.rst
new file mode 100644
index 00000000..5a784299
--- /dev/null
+++ b/docs/source/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/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+Brian Aker, <brian@tangent.org>
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`