docs: Consistently format each form of an option on a separate line.
[sliver-openvswitch.git] / lib / vlog.man
1 .de IQ
2 .  br
3 .  ns
4 .  IP "\\$1"
5 ..
6 .IP "\fB\-v\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]"
7 .IQ "\fB\-\-verbose=\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]"
8 .
9 Sets the logging level for \fImodule\fR in \fIfacility\fR to
10 \fIlevel\fR:
11 .
12 .RS
13 .IP \(bu
14 \fImodule\fR may be any valid module name (as displayed by the
15 \fB\-\-list\fR action on \fBovs\-appctl\fR(8)), or the special name
16 \fBANY\fR to set the logging levels for all modules.
17 .
18 .IP \(bu
19 \fIfacility\fR may be \fBsyslog\fR, \fBconsole\fR, or \fBfile\fR to
20 set the levels for logging to the system log, the console, or a file
21 respectively, or \fBANY\fR to set the logging levels for both
22 facilities.  If it is omitted, \fIfacility\fR defaults to \fBANY\fR.
23 .IP
24 Regardless of the log levels set for \fBfile\fR, logging to a file
25 will not take place unless \fB\-\-log\-file\fR is also specified (see
26 below).
27 .
28 .IP \(bu 
29 \fIlevel\fR must be one of \fBoff\fR, \fBemer\fR, \fBerr\fR, \fBwarn\fR,
30 \fBinfo\fR, or
31 \fBdbg\fR, designating the minimum severity of a message for it to be
32 logged.  If it is omitted, \fIlevel\fR defaults to \fBdbg\fR.  See
33 \fBovs\-appctl\fR(8) for a definition of each log level.
34 .RE
35 .
36 .IP "\fB\-v\fR"
37 .IQ "\fB\-\-verbose\fR"
38 Sets the maximum logging verbosity level, equivalent to
39 \fB\-\-verbose=ANY:ANY:dbg\fR.
40 .
41 .IP "\fB\-vPATTERN:\fIfacility\fB:\fIpattern\fR"
42 .IQ "\fB\-\-verbose=PATTERN:\fIfacility\fB:\fIpattern\fR"
43 Sets the log pattern for \fIfacility\fR to \fIpattern\fR.  Refer to
44 \fBovs\-appctl\fR(8) for a description of the valid syntax for \fIpattern\fR.
45 .
46 .TP
47 \fB\-\-log\-file\fR[\fB=\fIfile\fR]
48 Enables logging to a file.  If \fIfile\fR is specified, then it is
49 used as the exact name for the log file.  The default log file name
50 used if \fIfile\fR is omitted is \fB@LOGDIR@/\*(PN.log\fR.