projects
/
m6w6
/
libmemcached
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
|
github
raw
|
inline
| side by side
Merge in cleanup on the parser API.
[m6w6/libmemcached]
/
docs
/
memcapable.rst
diff --git
a/docs/memcapable.rst
b/docs/memcapable.rst
index b06d69a5d14307d26859a03d5aca4f74f4c1b88e..a22ba2c865cdf528071c4c6f544ab342cc1d3b24 100644
(file)
--- a/
docs/memcapable.rst
+++ b/
docs/memcapable.rst
@@
-1,103
+1,82
@@
-.. highlight:: perl
+=======================================================================
+memcapable - Checking a Memcached server capibilities and compatibility
+=======================================================================
-memcapable
-**********
+Check the server for compatibility and capabilities
-Check memcached server capabilities
-
-
-********
+--------
SYNOPSIS
SYNOPSIS
-********
-
-
-
-.. code-block:: perl
-
- memcat [-h hostname] [-p port] [-c] [-v] [-t n]
-
+--------
+:program:`memcapable`
-***********
-DESCRIPTION
-***********
-
-
-\ **memcapable**\ connects to the specified memcached server and tries to
-determine its capabilities by running the various commands and verifying
-the response.
+.. program:: memcapable
-
-*******
-OPTIONS
-*******
-
-
-The following options are supported:
-
-
--h hostname
+.. option:: -h hostname
Specify the hostname to connect to. The default is \ *localhost*\
Specify the hostname to connect to. The default is \ *localhost*\
-
-
--p port
+.. option:: -p port
Specify the port number to connect to. The default is \ *11211*\
Specify the port number to connect to. The default is \ *11211*\
--c
+
.. option::
-c
Generate a coredump when it detects an error from the server.
Generate a coredump when it detects an error from the server.
--v
+
.. option::
-v
- Print out the comparison when it detects an error from the server.
+
Print out the comparison when it detects an error from the server.
--t n
+
.. option::
-t n
Set the timeout from an IO operation to/from the server to \ *n*\ seconds.
Set the timeout from an IO operation to/from the server to \ *n*\ seconds.
+-----------
+DESCRIPTION
+-----------
+\ **memcapable**\ connects to the specified memcached server and tries to
+determine its capabilities by running the various commands and verifying
+the response.
-***********
+-----------
LIMITATIONS
LIMITATIONS
-***********
+-----------
The current version of memcapable will only verify the binary protocol.
The current version of memcapable will only verify the binary protocol.
-****
+----
HOME
HOME
-****
+----
To find out more information please check:
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
To find out more information please check:
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-******
+------
AUTHOR
AUTHOR
-******
+------
Trond Norbye, <trond.norbye@gmail.com>
Trond Norbye, <trond.norbye@gmail.com>
-********
+--------
SEE ALSO
SEE ALSO
-********
-
+--------
-memcached(1) libmemcached(3)
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`