diff options
| author | Ben Pfaff <blp@nicira.com> | 2012-02-08 15:05:50 -0800 |
|---|---|---|
| committer | Ben Pfaff <blp@nicira.com> | 2012-02-27 09:24:15 -0800 |
| commit | 91005f0313a1e783bd25268a71bb996bfbe50a3c (patch) | |
| tree | 6acaf50fe9d8f87ee68725ed02a7ec7045d7efb2 /lib/vlog.man | |
| parent | dd1ba5b3f4425c8eba008d1a93b044da63466812 (diff) | |
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>
Diffstat (limited to 'lib/vlog.man')
| -rw-r--r-- | lib/vlog.man | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/lib/vlog.man b/lib/vlog.man index 0fff8601..a2316dab 100644 --- a/lib/vlog.man +++ b/lib/vlog.man @@ -1,5 +1,10 @@ -.TP -\fB\-v\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]], \fB\-\-verbose=\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]] +.de IQ +. br +. ns +. IP "\\$1" +.. +.IP "\fB\-v\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]" +.IQ "\fB\-\-verbose=\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]" . Sets the logging level for \fImodule\fR in \fIfacility\fR to \fIlevel\fR: @@ -28,13 +33,13 @@ logged. If it is omitted, \fIlevel\fR defaults to \fBdbg\fR. See \fBovs\-appctl\fR(8) for a definition of each log level. .RE . -.TP -\fB\-v\fR, \fB\-\-verbose\fR +.IP "\fB\-v\fR" +.IQ "\fB\-\-verbose\fR" Sets the maximum logging verbosity level, equivalent to \fB\-\-verbose=ANY:ANY:dbg\fR. . -.TP -\fB\-vPATTERN:\fIfacility\fB:\fIpattern\fR, \fB\-\-verbose=PATTERN:\fIfacility\fB:\fIpattern\fR +.IP "\fB\-vPATTERN:\fIfacility\fB:\fIpattern\fR" +.IQ "\fB\-\-verbose=PATTERN:\fIfacility\fB:\fIpattern\fR" Sets the log pattern for \fIfacility\fR to \fIpattern\fR. Refer to \fBovs\-appctl\fR(8) for a description of the valid syntax for \fIpattern\fR. . |