mir/ovs
2
0
Fork 0
mirror of https://github.com/openvswitch/ovs synced 2025-08-22 09:58:01 +00:00
Code Issues Releases Wiki Activity
ovs/lib/vlog.man

58 lines
1.8 KiB
Groff
Raw Normal View History

docs: Consistently format each form of an option on a separate line. Most options were formatted like this in the manpage: -o ARGUMENT --option ARGUMENT but a few were formatted like this: -o ARGUMENT | --option ARGUMENT or even as: -o, --option ARGUMENT The former seems least confusing to me, so switch all of the documentation to this format. Signed-off-by: Ben Pfaff <blp@nicira.com>
2012-02-08 15:05:50 -08:00
.de IQ
. br
. ns
. IP "\\$1"
..
vlog: Be more liberal in syntax for -v and vlog/set. Until now, the argument to -v and vlog/set has had to take the form "module:facility:level". I can never remember the required order, so this commit switches to allowing any order. Signed-off-by: Ben Pfaff <blp@nicira.com>
2012-02-08 15:29:15 -08:00
.IP "\fB\-v\fR[\fIspec\fR]
.IQ "\fB\-\-verbose=\fR[\fIspec\fR]
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
vlog: Be more liberal in syntax for -v and vlog/set. Until now, the argument to -v and vlog/set has had to take the form "module:facility:level". I can never remember the required order, so this commit switches to allowing any order. Signed-off-by: Ben Pfaff <blp@nicira.com>
2012-02-08 15:29:15 -08:00
Sets logging levels. Without any \fIspec\fR, sets the log level for
every module and facility 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:
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.RS
.IP \(bu
vlog: Be more liberal in syntax for -v and vlog/set. Until now, the argument to -v and vlog/set has had to take the form "module:facility:level". I can never remember the required order, so this commit switches to allowing any order. Signed-off-by: Ben Pfaff <blp@nicira.com>
2012-02-08 15:29:15 -08:00
A valid module name, as displayed by the \fBvlog/list\fR command on
\fBovs\-appctl\fR(8), limits the log level change to the specified
module.
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.IP \(bu
vlog: Be more liberal in syntax for -v and vlog/set. Until now, the argument to -v and vlog/set has had to take the form "module:facility:level". I can never remember the required order, so this commit switches to allowing any order. Signed-off-by: Ben Pfaff <blp@nicira.com>
2012-02-08 15:29:15 -08:00
\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.
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.IP \(bu
vlog: Be more liberal in syntax for -v and vlog/set. Until now, the argument to -v and vlog/set has had to take the form "module:facility:level". I can never remember the required order, so this commit switches to allowing any order. Signed-off-by: Ben Pfaff <blp@nicira.com>
2012-02-08 15:29:15 -08:00
\fBoff\fR, \fBemer\fR, \fBerr\fR, \fBwarn\fR, \fBinfo\fR, or
\fBdbg\fR, to control the log level. Messages of the given severity
or higher will be logged, and messages of lower severity will be
filtered out. \fBoff\fR filters out all messages. See
vlog: Move log level definitions from source code to user documentation. Users should be able to find out what a log level means without reading source code comments, so this seems like a better place for it. Reported-by: David Tsai <dtsai@nicira.com>
2011-07-28 10:19:43 -07:00
\fBovs\-appctl\fR(8) for a definition of each log level.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.RE
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
vlog: Be more liberal in syntax for -v and vlog/set. Until now, the argument to -v and vlog/set has had to take the form "module:facility:level". I can never remember the required order, so this commit switches to allowing any order. Signed-off-by: Ben Pfaff <blp@nicira.com>
2012-02-08 15:29:15 -08:00
.IP
Case is not significant within \fIspec\fR.
.IP
Regardless of the log levels set for \fBfile\fR, logging to a file
will not take place unless \fB\-\-log\-file\fR is also specified (see
below).
.IP
For compatibility with older versions of OVS, \fBany\fR is accepted as
a word but has no effect.
.
docs: Consistently format each form of an option on a separate line. Most options were formatted like this in the manpage: -o ARGUMENT --option ARGUMENT but a few were formatted like this: -o ARGUMENT | --option ARGUMENT or even as: -o, --option ARGUMENT The former seems least confusing to me, so switch all of the documentation to this format. Signed-off-by: Ben Pfaff <blp@nicira.com>
2012-02-08 15:05:50 -08:00
.IP "\fB\-v\fR"
.IQ "\fB\-\-verbose\fR"
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
Sets the maximum logging verbosity level, equivalent to
doc: Change "-" to "\-" in appropriate places. The newer manpages tend to get this right more often than the old ones, but there were lots of places that needed to be corrected.
2010-06-29 14:29:40 -07:00
\fB\-\-verbose=ANY:ANY:dbg\fR.
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
docs: Consistently format each form of an option on a separate line. Most options were formatted like this in the manpage: -o ARGUMENT --option ARGUMENT but a few were formatted like this: -o ARGUMENT | --option ARGUMENT or even as: -o, --option ARGUMENT The former seems least confusing to me, so switch all of the documentation to this format. Signed-off-by: Ben Pfaff <blp@nicira.com>
2012-02-08 15:05:50 -08:00
.IP "\fB\-vPATTERN:\fIfacility\fB:\fIpattern\fR"
.IQ "\fB\-\-verbose=PATTERN:\fIfacility\fB:\fIpattern\fR"
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
Sets the log pattern for \fIfacility\fR to \fIpattern\fR. Refer to
Make ovs-appctl easier to use and synchronize its interface with ovs-vsctl. It is inconvenient to type the whole path to the Unix daemon socket when using ovs-appctl. Allow the name of the daemon to be used instead when a pidfile exists in the default location, and contact ovs-vswitchd by default. Also, the various options for manipulating vlog were invented before the general-purpose command mechanism existed. Get rid of all of the action options in favor of just specifying the command to be executed as non-option arguments. Finally, there simply wasn't much value in allowing multiple targets or options to be specified; these variations were never used in practice. So simplify the interface by making it one target, one action per invocation. Also, make ovs-vsctl use the same syntax for its --target option. Based on work by Justin Pettit.
2009-11-09 14:46:38 -08:00
\fBovs\-appctl\fR(8) for a description of the valid syntax for \fIpattern\fR.
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.TP
doc: Change "-" to "\-" in appropriate places. The newer manpages tend to get this right more often than the old ones, but there were lots of places that needed to be corrected.
2010-06-29 14:29:40 -07:00
\fB\-\-log\-file\fR[\fB=\fIfile\fR]
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
Enables logging to a file. If \fIfile\fR is specified, then it is
used as the exact name for the log file. The default log file name
used if \fIfile\fR is omitted is \fB@LOGDIR@/\*(PN.log\fR.
Reference in New Issue Copy Permalink