summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Schwenke <martin@meltin.net>2015-03-24 21:04:25 +1100
committerStefan Metzmacher <metze@samba.org>2016-08-10 11:24:38 +0200
commitbe449dbb3f4092fd71fd61ddbdeae6971aa74c2e (patch)
treea7b9c5b1439a249fc68284a23a7ee60e0bec1437
parent52bff15434ed3aee98a2329c83cc860abac34fd0 (diff)
downloadsamba-be449dbb3f4092fd71fd61ddbdeae6971aa74c2e.tar.gz
ctdb-doc: Document that "ctdb tickle" can now read from stdin
BUG: https://bugzilla.samba.org/show_bug.cgi?id=12123 Although this has been queued for a while, with changes to add stdin support to the original ctdb tool, this came for free with the replacement tool. addtickle and deltickle also now have this feature. However, they're internal commands and we're not adding new documentation for internal/debug commands. Signed-off-by: Martin Schwenke <martin@meltin.net> Reviewed-by: Amitay Isaacs <amitay@gmail.com> (cherry picked from commit 2295f5009dabfc09eec40bb4f30679d76310ce12)
-rw-r--r--ctdb/doc/ctdb.1.xml23
1 files changed, 17 insertions, 6 deletions
diff --git a/ctdb/doc/ctdb.1.xml b/ctdb/doc/ctdb.1.xml
index 7878c4c2b15..9324813fe51 100644
--- a/ctdb/doc/ctdb.1.xml
+++ b/ctdb/doc/ctdb.1.xml
@@ -1440,13 +1440,24 @@ RUNNING
</refsect2>
<refsect2>
- <title>tickle <parameter>SRC-IPADDR</parameter>:<parameter>SRC-PORT</parameter> <parameter>DST-IPADDR</parameter>:<parameter>DST-PORT</parameter></title>
+ <title>tickle</title>
<para>
- Send a TCP tickle to the source host for the specified TCP
- connection. A TCP tickle is a TCP ACK packet with an invalid
- sequence and acknowledge number and will when received by the
- source host result in it sending an immediate correct ACK back
- to the other end.
+ Read a list of TCP connections, one per line, from standard
+ input and send a TCP tickle to the source host for each
+ connection. A connection is specified as:
+ </para>
+ <synopsis>
+ <parameter>SRC-IPADDR</parameter>:<parameter>SRC-PORT</parameter> <parameter>DST-IPADDR</parameter>:<parameter>DST-PORT</parameter>
+ </synopsis>
+ <para>
+ A single connection can be specified on the command-line
+ rather than on standard input.
+ </para>
+ <para>
+ A TCP tickle is a TCP ACK packet with an invalid sequence and
+ acknowledge number and will when received by the source host
+ result in it sending an immediate correct ACK back to the
+ other end.
</para>
<para>
TCP tickles are useful to "tickle" clients after a IP failover has