Make facility and level optional in -v, --verbose options.

[openvswitch] / utilities / dpctl.8

diff --git a/utilities/dpctl.8 b/utilities/dpctl.8
index 1a714d2ccf0e269521f7e447343aa86e3c5fd5a2..043ff143e449ccb9292077d0845827edec1a05bd 100644 (file)
--- a/utilities/dpctl.8
+++ b/utilities/dpctl.8
@@ -85,14 +85,9 @@ Prints to the console all OpenFlow packets sent by datapath
 \fIdp_idx\fR to its controller, where \fIdp_idx\fR is the ID of an
 existing datapath.
 
-.TP
-\fBbenchmark-nl nl:\fIdp_idx n size\fR
-Checks the netlink performance between the kernel and userspace.
-This is done by sending \fIN\fR packets of \fIsize\fR bytes from
-the kernel module to dpctl.
-
 .PP
-The following commands can be used regardless of the connection method.
+The following commands can be apply to OpenFlow switches regardless of
+the connection method.
 
 .TP
 \fBshow \fIswitch\fR
@@ -142,19 +137,30 @@ Deletes entries from the datapath \fIswitch\fR's tables that match
 tables are removed.  See \fBFLOW SYNTAX\fR, below, for the syntax of
 \fIflows\fR.
 
+.PP
+The following commands can be used regardless of the connection
+method.  They apply to OpenFlow switches and controllers.
+
 .TP
-\fBping \fIswitch \fR[\fIn\fR]
-Sends a series of 10 echo request packets to \fIswitch\fR and times
+\fBprobe \fIvconn\fR
+Connects to \fIvconn\fR and sends a single OpenFlow echo-request
+packet and waits for the response.  With the \fB-t\fR or
+\fB--timeout\fR option, this command can test whether an OpenFlow
+switch or controller is up and running.
+
+.TP
+\fBping \fIvconn \fR[\fIn\fR]
+Sends a series of 10 echo request packets to \fIvconn\fR and times
 each reply.  The echo request packets consist of an OpenFlow header
 plus \fIn\fR bytes (default: 64) of randomly generated payload.  This
 measures the latency of individual requests.
 
 .TP
-\fBbenchmark \fIswitch n count\fR
+\fBbenchmark \fIvconn n count\fR
 Sends \fIcount\fR echo request packets that each consist of an
 OpenFlow header plus \fIn\fR bytes of payload and waits for each
 response.  Reports the total time required.  This is a measure of the
-maximum bandwidth to \fIswitch\fR for round-trips of \fIn\fR-byte
+maximum bandwidth to \fIvconn\fR for round-trips of \fIn\fR-byte
 messages.
 
 .SH "FLOW SYNTAX"
@@ -288,6 +294,12 @@ If this field is not specified, or if \fInumber\fR is given as
 \fB255\fR, statistics are gathered about flows from all tables.
 
 .SH OPTIONS
+.TP
+\fB-t\fR, \fB--timeout=\fIsecs\fR
+Limits \fBdpctl\fR runtime to approximately \fIsecs\fR seconds.  If
+the timeout expires, \fBdpctl\fR will exit with a \fBSIGALRM\fR
+signal.
+
 .TP
 \fB-p\fR, \fB--private-key=\fIprivkey.pem\fR
 Specifies a PEM file containing the private key used as the
@@ -309,17 +321,18 @@ a switch is trustworthy.
 Prints a brief help message to the console.
 
 .TP
-\fB-v\fR \fImodule\fB:\fIfacility\fB:\fIlevel\fR, \fB--verbose=\fImodule\fB:\fIfacility\fB:\fIlevel\fR
+\fB-v\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]], \fB--verbose=\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]
 Sets the logging level for \fImodule\fR in \fIfacility\fR to
 \fIlevel\fR.  The \fImodule\fR may be any valid module name (as
 displayed by the \fB--list\fR action on \fBvlogconf\fR(8)), or the
 special name \fBANY\fR to set the logging levels for all modules.  The
 \fIfacility\fR may be \fBsyslog\fR or \fBconsole\fR to set the levels
 for logging to the system log or to the console, respectively, or
-\fBANY\fR to set the logging levels for both facilities.  The
-\fIlevel\fR must be one of \fBemer\fR, \fBerr\fR, \fBwarn\fR, or
-\fBdbg\fR, designating the minimum severity of a message for it to be
-logged.
+\fBANY\fR to set the logging levels for both facilities.  If it is
+omitted, \fIfacility\fR defaults to \fBANY\fR.  The \fIlevel\fR must
+be one of \fBemer\fR, \fBerr\fR, \fBwarn\fR, or \fBdbg\fR, designating
+the minimum severity of a message for it to be logged.  If it is
+omitted, \fIlevel\fR defaults to \fBdbg\fR.
 
 .TP
 \fB-v\fR, \fB--verbose\fR