X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=utilities%2Fovs-appctl.8.in;h=fc5c885c5e4de04951747c8b88c917cb31059e4b;hb=45c580a3486b246c8e7032d95c58eefdf6d3b3fc;hp=51085980b507a44b739510b418f3d6afc6a7b7c2;hpb=7d110e960278c0b1f5c39e398a3aab9d02e84c00;p=openvswitch diff --git a/utilities/ovs-appctl.8.in b/utilities/ovs-appctl.8.in index 51085980..fc5c885c 100644 --- 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,21 +53,34 @@ as if it had been specified directly as the target. .IP The default target is \fBovs\-vswitchd\fR. . -.SH LOGGING COMMANDS +.SH COMMON COMMANDS +Every Open vSwitch daemon supports a common set of commands, which are +documented in this section. . -.PP -Open vSwitch has several log levels. The highest-severity log level -is: +.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 enabled -by default: +The following log levels, in order of descending severity, are +available: . -.IP "\fBEMER\f" +.IP "\fBEMER\fR" A major failure forced a process to abort. .IP "\fBERR\fR" A high-level operation or a subsystem failed. Attention is @@ -85,8 +97,8 @@ 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. +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. . @@ -186,12 +198,6 @@ 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: