lib/table.man

   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
   6 .ie '\*(PN'ovsdb\-client' .IP "\fBtable\fR (default)"
   7 .el                       .IP "\fBtable\fR"
   8 2-D text tables with aligned columns.
   9 .ie '\*(PN'ovsdb\-client' .IP "\fBlist\fR"
  10 .el                       .IP "\fBlist\fR (default)"
  11 A list with one column per line and rows separated by a blank line.
  12 .IP "\fBhtml\fR"
  13 HTML tables.
  14 .IP "\fBcsv\fR"
  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"
  38 .IQ "\fB\-\-data=\fIformat\fR"
  39 Sets the formatting for cells within output tables unless the table
  40 format is set to \fBjson\fR, in which case \fBjson\fR formatting is
  41 always used when formatting cells.  The following types of \fIformat\fR
  42 are available:
  43 .RS
  44 .IP "\fBstring\fR (default)"
  45 The simple format described in the \fBDatabase Values\fR
  46 .ie '\*(PN'ovs\-vsctl' section below.
  47 .el                    section of \fBovs\-vsctl\fR(8).
  48 .IP "\fBbare\fR"
  49 The simple format with punctuation stripped off: \fB[]\fR and \fB{}\fR
  50 are omitted around sets, maps, and empty columns, items within sets
  51 and maps are space-separated, and strings are never quoted.  This
  52 format may be easier for scripts to parse.
  53 .IP "\fBjson\fR"
  54 The RFC 4627 JSON format as described above.
  55 .RE
  56 .IP
  57 .
  58 .IP "\fB\-\-no\-headings\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.
  70 .IP "\fB\-\-bare\fR"
  71 Equivalent to \fB\-\-format=list \-\-data=bare \-\-no\-headings\fR.
  72 .IP "\fB\-\-max\-column-width=\fIn\fR"
  73 For 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.
  75 Columns are always wide enough to display the column names, if the
  76 heading row is printed.