mirror of
https://github.com/openvswitch/ovs
synced 2025-10-29 15:28:56 +00:00
ovsdb-client: improve formatting option description in man page
Use correct option name for "--no-headings", remove duplicate "--no-heading" option in synopsis. Clarify description of "--data=json" option. Signed-off-by: Lance Richardson <lrichard@redhat.com> Signed-off-by: Ben Pfaff <blp@ovn.org>
This commit is contained in:
committed by
Ben Pfaff
parent
bcb58ce069
commit
3b4d80efd7
@@ -36,8 +36,10 @@ as text strings.
|
||||
.
|
||||
.IP "\fB\-d \fIformat\fR"
|
||||
.IQ "\fB\-\-data=\fIformat\fR"
|
||||
Sets the formatting for cells within output tables. The following
|
||||
types of \fIformat\fR are available:
|
||||
Sets the formatting for cells within output tables unless the table
|
||||
format is set to \fBjson\fR, in which case \fBjson\fR formatting is
|
||||
always used when formatting cells. The following types of \fIformat\fR
|
||||
are available:
|
||||
.RS
|
||||
.IP "\fBstring\fR (default)"
|
||||
The simple format described in the \fBDatabase Values\fR
|
||||
@@ -49,13 +51,11 @@ are omitted around sets, maps, and empty columns, items within sets
|
||||
and maps are space-separated, and strings are never quoted. This
|
||||
format may be easier for scripts to parse.
|
||||
.IP "\fBjson\fR"
|
||||
JSON.
|
||||
The RFC 4627 JSON format as described above.
|
||||
.RE
|
||||
.IP
|
||||
The \fBjson\fR output format always outputs cells in JSON format,
|
||||
ignoring this option.
|
||||
.
|
||||
.IP "\fB\-\-no\-heading\fR"
|
||||
.IP "\fB\-\-no\-headings\fR"
|
||||
This option suppresses the heading row that otherwise appears in the
|
||||
first row of table output.
|
||||
.
|
||||
|
||||
@@ -46,10 +46,9 @@ ovsdb\-client \- command-line interface to \fBovsdb-server\fR(1)
|
||||
.IP "Output formatting options:"
|
||||
[\fB\-\-format=\fIformat\fR]
|
||||
[\fB\-\-data=\fIformat\fR]
|
||||
[\fB\-\-no-heading\fR]
|
||||
[\fB\-\-no-headings\fR]
|
||||
[\fB\-\-pretty\fR]
|
||||
[\fB\-\-bare\fR]
|
||||
[\fB\-\-no\-heading\fR]
|
||||
[\fB\-\-timestamp\fR]
|
||||
.so lib/daemon-syn.man
|
||||
.so lib/vlog-syn.man
|
||||
|
||||
Reference in New Issue
Block a user