vlog: Add option to send vlog syslog output to arbitrary UDP destination.
[sliver-openvswitch.git] / lib / vlog.man
1 .de IQ
2 .  br
3 .  ns
4 .  IP "\\$1"
5 ..
6 .IP "\fB\-v\fR[\fIspec\fR]
7 .IQ "\fB\-\-verbose=\fR[\fIspec\fR]
8 .
9 Sets logging levels.  Without any \fIspec\fR, sets the log level for
10 every module and facility to \fBdbg\fR.  Otherwise, \fIspec\fR is a
11 list of words separated by spaces or commas or colons, up to one from
12 each category below:
13 .
14 .RS
15 .IP \(bu
16 A valid module name, as displayed by the \fBvlog/list\fR command on
17 \fBovs\-appctl\fR(8), limits the log level change to the specified
18 module.
19 .
20 .IP \(bu
21 \fBsyslog\fR, \fBconsole\fR, or \fBfile\fR, to limit the log level
22 change to only to the system log, to the console, or to a file,
23 respectively.
24 .
25 .IP \(bu 
26 \fBoff\fR, \fBemer\fR, \fBerr\fR, \fBwarn\fR, \fBinfo\fR, or
27 \fBdbg\fR, to control the log level.  Messages of the given severity
28 or higher will be logged, and messages of lower severity will be
29 filtered out.  \fBoff\fR filters out all messages.  See
30 \fBovs\-appctl\fR(8) for a definition of each log level.
31 .RE
32 .
33 .IP
34 Case is not significant within \fIspec\fR.
35 .IP
36 Regardless of the log levels set for \fBfile\fR, logging to a file
37 will not take place unless \fB\-\-log\-file\fR is also specified (see
38 below).
39 .IP
40 For compatibility with older versions of OVS, \fBany\fR is accepted as
41 a word but has no effect.
42 .
43 .IP "\fB\-v\fR"
44 .IQ "\fB\-\-verbose\fR"
45 Sets the maximum logging verbosity level, equivalent to
46 \fB\-\-verbose=dbg\fR.
47 .
48 .\" Python vlog doesn't implement -vPATTERN so only document it if
49 .\" \*(PY is empty:
50 .ie dPY
51 .el \{
52 .IP "\fB\-vPATTERN:\fIfacility\fB:\fIpattern\fR"
53 .IQ "\fB\-\-verbose=PATTERN:\fIfacility\fB:\fIpattern\fR"
54 Sets the log pattern for \fIfacility\fR to \fIpattern\fR.  Refer to
55 \fBovs\-appctl\fR(8) for a description of the valid syntax for \fIpattern\fR.
56 \}
57 .
58 .TP
59 \fB\-\-log\-file\fR[\fB=\fIfile\fR]
60 Enables logging to a file.  If \fIfile\fR is specified, then it is
61 used as the exact name for the log file.  The default log file name
62 used if \fIfile\fR is omitted is \fB@LOGDIR@/\*(PN.log\fR.
63 .
64 .IP "\fB\-\-syslog\-target=\fIhost\fB:\fIport\fR"
65 Send syslog messages to UDP \fIport\fR on \fIhost\fR, in addition to
66 the system syslog.  The \fIhost\fR must be a numerical IP address, not
67 a hostname.