Prepare Open vSwitch 1.1.2 release.

[sliver-openvswitch.git] / ovsdb / ovsdb-client.1.in

diff --git a/ovsdb/ovsdb-client.1.in b/ovsdb/ovsdb-client.1.in
index 22b4e23..fe7b7fa 100644 (file)
--- a/ovsdb/ovsdb-client.1.in
+++ b/ovsdb/ovsdb-client.1.in
@@ -19,6 +19,8 @@ ovsdb\-client \- command-line interface to \fBovsdb-server\fR(1)
 .br
 \fBovsdb\-client \fR[\fIoptions\fR] \fBget\-schema\fI server database\fR
 .br
+\fBovsdb\-client \fR[\fIoptions\fR] \fBget\-schema\-version\fI server database\fR
+.br
 \fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-tables\fI server database\fR
 .br
 \fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-columns\fI server database \fR[\fItable\fR]
@@ -61,6 +63,19 @@ be used for \fIdatabase\fR in the following commands.
 Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
 prints it in JSON format.
 .
+.IP "\fBget\-schema\-version\fI server database\fR"
+Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
+prints its version number on stdout.  A schema version number has the form
+\fIx\fB.\fIy\fB.\fIz\fR.  See \fBovs\-vswitchd.conf.db\fR(5) for
+details.
+.IP
+Schema version numbers and Open vSwitch version numbers are
+independent.
+.IP
+If \fIdatabase\fR was created before schema versioning was introduced,
+then it will not have a version number and this command will print a
+blank line.
+.
 .IP "\fBlist\-tables\fI server database\fR"
 Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
 prints a table listing the name of each table
@@ -112,64 +127,8 @@ contents of \fItable\fR.
 Much of the output from \fBovsdb\-client\fR is in the form of tables.
 The following options controlling output formatting:
 .
-.IP "\fB\-f \fIformat\fR"
-.IQ "\fB\-\-format=\fIformat\fR"
-Sets the type of table formatting.  The following types of
-\fIformat\fR are available:
-.RS
-.IP "\fBtable\fR (default)"
-Text-based tables with aligned columns.
-.IP "\fBhtml\fR"
-HTML tables.
-.IP "\fBcvs\fR"
-Comma-separated values as defined in RFC 4180.
-.IP "\fBjson\fR"
-JSON format as defined in RFC 4627.  The output is a sequence of JSON
-objects, each of which corresponds to one table.  Each JSON object has
-the following members with the noted values:
-.RS
-.IP "\fBcaption\fR"
-The table's caption.  This member is omitted if the table has no
-caption.
-.IP "\fBheadings\fR"
-An array with one element per table column.  Each array element is a
-string giving the corresponding column's heading.
-.IP "\fBdata\fR"
-An array with one element per table row.  Each element is also an
-array with one element per table column.  The elements of this
-second-level array are the cells that constitute the table.  Cells
-that represent OVSDB data or data types are expressed in the format
-described in the OVSDB specification; other cells are simply expressed
-as text strings.
-.RE
-.RE
-.
-.IP "\fB\-d \fIformat\fR"
-.IP "\fB\-\-data=\fIformat\fR"
-Sets the formatting for cells within output tables.  The following
-types of \fIformat\fR are available:
-.RS
-.IP "\fBstring\fR (default)"
-The simple format described in \fBovs\-vsctl\fR(8).
-.IP "\fBjson\fR"
-JSON.
-.RE
-.IP
-The \fBjson\fR output format always outputs cells in JSON format,
-ignoring this option.
-.
-.IP "\fB\-\-no\-heading\fR"
-This option suppresses the heading row that otherwise appears in the
-first row of table output.
-.
-.IP "\fB\-\-pretty\fR"
-By default, JSON in output is printed as compactly as possible.  This
-option causes JSON in output to be printed in a more readable
-fashion.  Members of objects and elements of arrays are printed one
-per line, with indentation.
-.IP
-This option does not affect JSON in tables, which is always printed
-compactly.
+.ds TD (default)
+.so lib/table.man
 .
 .SS "Daemon Options"
 The daemon options apply only to the \fBmonitor\fR command.  With any