fix #131: add build time option: CLIENT_PREFIX
[awesomized/libmemcached] / docs / source / bin / memping.rst
index 5fdfef70c3f32a13d247ce31eec54e80f2b15733..fc08b27e87926f420c802e211d390db0d3f0def3 100644 (file)
@@ -1,48 +1,47 @@
-===============================================
-memping - Test to see if a server is available.
-===============================================
+memping
+=======
 
-
---------
 SYNOPSIS
 --------
 
-memping [options] [server]
+|client_prefix|\ping [options] [server]
 
 .. program:: memping
 
+Test for availability of a server
 
------------
 DESCRIPTION
 -----------
 
+:program:`memping` can be used to ping a memcached server to see if it is accepting connections.
 
-:program:`memping` can be used to ping a memcached server to see if it is taking connections.
-
--------
 OPTIONS
 -------
 
+.. include:: options/all.rst
+.. include:: options/common.rst
+.. include:: options/sasl.rst
 
-You can specify servers via the option:
+.. option:: -s|--servers <list of servers>
 
-.. option:: --servers
+    Specify the list of servers as *hostname[:port][,hostname[:port]...]*.
 
-or via the environment variable:
 
-.. envvar:: `MEMCACHED_SERVERS`
+.. include:: common/env.rst
 
-If you do not specify either these, the final value in the command line list is the name of a server(s).
+NOTES
+-----
 
-For a full list of operations run the tool with the option:
+.. include:: common/note_program_prefix.rst
 
-.. option:: --help
-
-
---------
 SEE ALSO
 --------
 
 .. only:: man
 
-  :manpage:`memcached(1)` :manpage:`libmemcached(3)`
+  :manpage:`memcached(1)`
+  :manpage:`libmemcached(3)`
+
+.. only:: html
+
+* :doc:`/libmemcached`