meta-flow: Correctly set destination MAC in mf_set_flow_value().

[sliver-openvswitch.git] / utilities / ovs-appctl.8.in

diff --git a/utilities/ovs-appctl.8.in b/utilities/ovs-appctl.8.in
index 86d5a8b..fc5c885 100644 (file)
--- a/utilities/ovs-appctl.8.in
+++ b/utilities/ovs-appctl.8.in
@@ -18,12 +18,11 @@ ovs\-appctl \- utility for configuring running Open vSwitch daemons
 .br
 \fBovs\-appctl\fR \-\-version
 .SH DESCRIPTION
-Open vSwitch daemons accept certain commands at runtime to control
-their behavior and query their settings.  Every daemon accepts the
-commands for querying and adjusting its logging settings documented
-under \fBLOGGING COMMANDS\fR below, and \fBovs\-vswitchd\fR in
-particular accepts a number of additional commands documented in
-\fBovs\-vswitchd\fR(8).
+Open vSwitch daemons accept certain commands at runtime to control their
+behavior and query their settings.  Every daemon accepts a common set of
+commands documented under \fBCOMMON COMMANDS\fR below, and
+\fBovs\-vswitchd\fR in particular accepts a number of additional
+commands documented in \fBovs\-vswitchd\fR(8).
 .PP
 The \fBovs\-appctl\fR program provides a simple way to invoke these
 commands.  The command to be sent is specified on \fBovs\-appctl\fR's
@@ -54,10 +53,52 @@ as if it had been specified directly as the target.
 .IP
 The default target is \fBovs\-vswitchd\fR.
 .
-.SH LOGGING COMMANDS
-Every Open vSwitch daemon supports the following commands for
-examining and adjusting log levels.
+.SH COMMON COMMANDS
+Every Open vSwitch daemon supports a common set of commands, which are
+documented in this section.
 .
+.SS GENERAL COMMANDS
+These commands display daemon-specific commands and the running version.
+Note that these commands are different from the \fB\-\-help\fR and
+\fB\-\-version\fR options that return information about the
+\fBovs\-appctl\fR utility itself.
+.
+.IP "\fBhelp\fR"
+Lists the commands supported by the target.
+.
+.IP "\fBversion\fR"
+Displays the version and compilation date of the target.
+.
+.SS LOGGING COMMANDS
+Open vSwitch has several log levels.  The highest-severity log level is:
+.
+.IP "\fBOFF\fR"
+No message is ever logged at this level, so setting a logging
+facility's log level to \fBOFF\fR disables logging to that facility.
+.
+.PP
+The following log levels, in order of descending severity, are
+available:
+.
+.IP "\fBEMER\fR"
+A major failure forced a process to abort.
+.IP "\fBERR\fR"
+A high-level operation or a subsystem failed.  Attention is
+warranted.
+.IP "\fBWARN\fR"
+A low-level operation failed, but higher-level subsystems may be able
+to recover.
+.IP "\fBINFO\fR"
+Information that may be useful in retrospect when investigating
+a problem.
+.IP "\fBDBG\fR"
+Information useful only to someone with intricate knowledge of the
+system, or that would commonly cause too-voluminous log output.  Log
+messages at this level are not logged by default.
+.
+.PP
+Every Open vSwitch daemon supports the following commands for examining
+and adjusting log levels.
 .IP "\fBvlog/list\fR"
 Lists the known logging modules and their current levels.
 .
@@ -70,7 +111,8 @@ set the logging levels for all modules.  The \fIfacility\fR may be
 system log or to the console, respectively, or \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, \fBinfo\fR, or \fBdbg\fR, designating the
+\fBoff\fR, \fBemer\fR, \fBerr\fR, \fBwarn\fR, \fBinfo\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.
 .
@@ -156,16 +198,9 @@ This has no effect if the target application was not invoked with the
 .
 .so lib/common.man
 .
-.SH BUGS
-.
-The protocol used to speak to Open vSwitch daemons does not contain a
-quoting mechanism, so command arguments should not generally contain
-white space.
-.
 .SH "SEE ALSO"
 .
 \fBovs\-appctl\fR can control the following daemons:
 .BR ovs\-vswitchd (8),
-.BR ovs\-openflowd (8),
 .BR ovs\-controller (8),
 .BR ovs\-brcompatd (8).