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