vlog: add "vlog/list-pattern" command

[cascardo/ovs.git] / utilities / ovs-appctl.8.in

diff --git a/utilities/ovs-appctl.8.in b/utilities/ovs-appctl.8.in
index e381b2b..f477534 100644 (file)
--- a/utilities/ovs-appctl.8.in
+++ b/utilities/ovs-appctl.8.in
@@ -52,6 +52,15 @@ named \fB@RUNDIR@/\fItarget\fB.\fIpid\fB.ctl\fR, where \fIpid\fR is
 replaced by the process ID read from the pidfile, and uses that file
 as if it had been specified directly as the target.
 .IP
 replaced by the process ID read from the pidfile, and uses that file
 as if it had been specified directly as the target.
 .IP

+On Windows, \fItarget\fR can be an absolute path to a file that contains
+a localhost TCP port on which an Open vSwitch daemon is listening
+for control channel connections. By default, each daemon writes the
+TCP port on which it is listening for control connection into the file
+\fIprogram\fB.ctl\fR located inside the configured \fIOVS_RUNDIR\fR
+directory. If \fItarget\fR is not an absolute path, \fBovs\-appctl\fR
+looks for a file named \fItarget\fB.ctl\fR in the configured \fIOVS_RUNDIR\fR
+directory.
+.IP

 The default target is \fBovs\-vswitchd\fR.
 .
 .SH COMMON COMMANDS
 The default target is \fBovs\-vswitchd\fR.
 .
 .SH COMMON COMMANDS


@@ -64,7 +73,7 @@ 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.
 .
 \fB\-\-version\fR options that return information about the
 \fBovs\-appctl\fR utility itself.
 .

-.IP "\fBhelp\fR"
+.IP "\fBlist-commands\fR"

 Lists the commands supported by the target.
 .
 .IP "\fBversion\fR"
 Lists the commands supported by the target.
 .
 .IP "\fBversion\fR"


@@ -75,7 +84,7 @@ 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
 .
 .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.
+destination's log level to \fBoff\fR disables logging to that destination.

 .
 .PP
 The following log levels, in order of descending severity, are
 .
 .PP
 The following log levels, in order of descending severity, are


@@ -103,9 +112,12 @@ and adjusting log levels.
 .IP "\fBvlog/list\fR"
 Lists the known logging modules and their current levels.
 .
 .IP "\fBvlog/list\fR"
 Lists the known logging modules and their current levels.
 .

+.IP "\fBvlog/list-pattern\fR"
+Lists logging pattern used for each destination.
+.

 .IP "\fBvlog/set\fR [\fIspec\fR]"
 Sets logging levels.  Without any \fIspec\fR, sets the log level for
 .IP "\fBvlog/set\fR [\fIspec\fR]"
 Sets logging levels.  Without any \fIspec\fR, sets the log level for

-every module and facility to \fBdbg\fR.  Otherwise, \fIspec\fR is a
+every module and destination to \fBdbg\fR.  Otherwise, \fIspec\fR is a

 list of words separated by spaces or commas or colons, up to one from
 each category below:
 .
 list of words separated by spaces or commas or colons, up to one from
 each category below:
 .


@@ -119,6 +131,10 @@ module.
 \fBsyslog\fR, \fBconsole\fR, or \fBfile\fR, to limit the log level
 change to only to the system log, to the console, or to a file,
 respectively.
 \fBsyslog\fR, \fBconsole\fR, or \fBfile\fR, to limit the log level
 change to only to the system log, to the console, or to a file,
 respectively.

+.IP
+On Windows platform, \fBsyslog\fR is accepted as a word and
+is only useful if the \fItarget\fR was started with the
+\fB\-\-syslog\-target\fR option (the word has no effect otherwise).

 .
 .IP \(bu 
 \fBoff\fR, \fBemer\fR, \fBerr\fR, \fBwarn\fR, \fBinfo\fR, or
 .
 .IP \(bu 
 \fBoff\fR, \fBemer\fR, \fBerr\fR, \fBwarn\fR, \fBinfo\fR, or


@@ -137,9 +153,9 @@ will not take place unless the target application was invoked with the
 For compatibility with older versions of OVS, \fBany\fR is accepted as
 a word but has no effect.
 .
 For compatibility with older versions of OVS, \fBany\fR is accepted as
 a word but has no effect.
 .

-.IP "\fBvlog/set PATTERN:\fIfacility\fB:\fIpattern\fR"
-Sets the log pattern for \fIfacility\fR to \fIpattern\fR.  Each time a
-message is logged to \fIfacility\fR, \fIpattern\fR determines the
+.IP "\fBvlog/set PATTERN:\fIdestination\fB:\fIpattern\fR"
+Sets the log pattern for \fIdestination\fR to \fIpattern\fR.  Each time a
+message is logged to \fIdestination\fR, \fIpattern\fR determines the

 message's formatting.  Most characters in \fIpattern\fR are copied
 literally to the log, but special escapes beginning with \fB%\fR are
 expanded as follows:
 message's formatting.  Most characters in \fIpattern\fR are copied
 literally to the log, but special escapes beginning with \fB%\fR are
 expanded as follows:


@@ -241,6 +257,14 @@ The default pattern for console and file output is \fB%D{%Y-%m-%dT
 Daemons written in Python (e.g. \fBovs\-xapi\-sync\fR,
 \fBovs\-monitor\-ipsec) do not allow control over the log pattern.
 .
 Daemons written in Python (e.g. \fBovs\-xapi\-sync\fR,
 \fBovs\-monitor\-ipsec) do not allow control over the log pattern.
 .

+.IP "\fBvlog/set\fR FACILITY:\fIfacility\fR"
+Sets the RFC5424 facility of the log message. \fIfacility\fR can be one of
+\fBkern\fR, \fBuser\fR, \fBmail\fR, \fBdaemon\fR, \fBauth\fR, \fBsyslog\fR,
+\fBlpr\fR, \fBnews\fR, \fBuucp\fR, \fBclock\fR, \fBftp\fR, \fBntp\fR,
+\fBaudit\fR, \fBalert\fR, \fBclock2\fR, \fBlocal0\fR, \fBlocal1\fR,
+\fBlocal2\fR, \fBlocal3\fR, \fBlocal4\fR, \fBlocal5\fR, \fBlocal6\fR or
+\fBlocal7\fR.
+.

 .IP "\fBvlog/reopen\fR"
 Causes the daemon to close and reopen its log file.  (This
 is useful after rotating log files, to cause a new log file to be
 .IP "\fBvlog/reopen\fR"
 Causes the daemon to close and reopen its log file.  (This
 is useful after rotating log files, to cause a new log file to be