ovs-appctl: Document -T and --timeout options.

Signed-off-by: Ben Pfaff <blp@ovn.org>
Acked-by: Russell Bryant <russell@ovn.org>

diff --git a/utilities/ovs-appctl.8.in b/utilities/ovs-appctl.8.in
index 645b62b4be99f2a83c708a7f9462c37c6747e762..43c9a9517a86bc94db7ef853bce580977cb87a86 100644 (file)
--- a/utilities/ovs-appctl.8.in
+++ b/utilities/ovs-appctl.8.in
@@ -12,11 +12,12 @@ ovs\-appctl \- utility for configuring running Open vSwitch daemons
 .
 .SH SYNOPSIS
 \fBovs\-appctl\fR [\fB\-\-target=\fItarget\fR | \fB\-t\fR \fItarget\fR]
+[\fB\-T \fIsecs\fR | \fB\-\-timeout=\fIsecs\fR]
 \fIcommand \fR[\fIarg\fR...]
 .br
-\fBovs\-appctl\fR \-\-help
+\fBovs\-appctl \fB\-\-help\fR
 .br
-\fBovs\-appctl\fR \-\-version
+\fBovs\-appctl \fB\-\-version\fR
 .SH DESCRIPTION
 Open vSwitch daemons accept certain commands at runtime to control their
 behavior and query their settings.  Every daemon accepts a common set of
@@ -63,6 +64,13 @@ directory.
 .IP
 The default target is \fBovs\-vswitchd\fR.
 .
+.IP "\fB\-T \fIsecs\fR"
+.IQ "\fB\-\-timeout=\fIsecs\fR"
+By default, or with a \fIsecs\fR of \fB0\fR, \fBovs\-appctl\fR waits
+forever to connect to the daemon and receive a response.  This option
+limits runtime to approximately \fIsecs\fR seconds.  If the timeout
+expires, \fBovs\-appctl\fR exits with a \fBSIGALRM\fR signal.
+.
 .SH COMMON COMMANDS
 Every Open vSwitch daemon supports a common set of commands, which are
 documented in this section.