]> git.proxmox.com Git - mirror_ovs.git/blame - lib/table.man
netdev-offload-tc: Use single 'once' variable for probing tc features
[mirror_ovs.git] / lib / table.man
CommitLineData
3a3eb9da
BP
1.IP "\fB\-f \fIformat\fR"
2.IQ "\fB\-\-format=\fIformat\fR"
3Sets the type of table formatting. The following types of
4\fIformat\fR are available:
5.RS
c4817da7
LR
6.ie '\*(PN'ovsdb\-client' .IP "\fBtable\fR (default)"
7.el .IP "\fBtable\fR"
c6a41252 82-D text tables with aligned columns.
c4817da7
LR
9.ie '\*(PN'ovsdb\-client' .IP "\fBlist\fR"
10.el .IP "\fBlist\fR (default)"
c6a41252 11A list with one column per line and rows separated by a blank line.
3a3eb9da
BP
12.IP "\fBhtml\fR"
13HTML tables.
132b0dcc 14.IP "\fBcsv\fR"
3a3eb9da
BP
15Comma-separated values as defined in RFC 4180.
16.IP "\fBjson\fR"
17JSON format as defined in RFC 4627. The output is a sequence of JSON
18objects, each of which corresponds to one table. Each JSON object has
19the following members with the noted values:
20.RS
21.IP "\fBcaption\fR"
22The table's caption. This member is omitted if the table has no
23caption.
24.IP "\fBheadings\fR"
25An array with one element per table column. Each array element is a
26string giving the corresponding column's heading.
27.IP "\fBdata\fR"
28An array with one element per table row. Each element is also an
29array with one element per table column. The elements of this
30second-level array are the cells that constitute the table. Cells
31that represent OVSDB data or data types are expressed in the format
32described in the OVSDB specification; other cells are simply expressed
33as text strings.
34.RE
35.RE
36.
37.IP "\fB\-d \fIformat\fR"
c2158145 38.IQ "\fB\-\-data=\fIformat\fR"
3b4d80ef
LR
39Sets the formatting for cells within output tables unless the table
40format is set to \fBjson\fR, in which case \fBjson\fR formatting is
41always used when formatting cells. The following types of \fIformat\fR
42are available:
3a3eb9da
BP
43.RS
44.IP "\fBstring\fR (default)"
e051b42c
BP
45The simple format described in the \fBDatabase Values\fR
46.ie '\*(PN'ovs\-vsctl' section below.
47.el section of \fBovs\-vsctl\fR(8).
c6a41252
BP
48.IP "\fBbare\fR"
49The simple format with punctuation stripped off: \fB[]\fR and \fB{}\fR
50are omitted around sets, maps, and empty columns, items within sets
51and maps are space-separated, and strings are never quoted. This
52format may be easier for scripts to parse.
3a3eb9da 53.IP "\fBjson\fR"
3b4d80ef 54The RFC 4627 JSON format as described above.
3a3eb9da
BP
55.RE
56.IP
3a3eb9da 57.
3b4d80ef 58.IP "\fB\-\-no\-headings\fR"
3a3eb9da
BP
59This option suppresses the heading row that otherwise appears in the
60first row of table output.
61.
62.IP "\fB\-\-pretty\fR"
63By default, JSON in output is printed as compactly as possible. This
64option causes JSON in output to be printed in a more readable
65fashion. Members of objects and elements of arrays are printed one
66per line, with indentation.
67.IP
68This option does not affect JSON in tables, which is always printed
69compactly.
c6a41252
BP
70.IP "\fB\-\-bare\fR"
71Equivalent to \fB\-\-format=list \-\-data=bare \-\-no\-headings\fR.
80f66ee0
BP
72.IP "\fB\-\-max\-column-width=\fIn\fR"
73For table output only, limits the width of any column in the output to
74\fIn\fR columns. Longer cell data is truncated to fit, as necessary.
75Columns are always wide enough to display the column names, if the
76heading row is printed.