Add OXM data to mf_fields

[openvswitch] / ovsdb / ovsdb-tool.1.in

diff --git a/ovsdb/ovsdb-tool.1.in b/ovsdb/ovsdb-tool.1.in
index b073f6d57508e7d043eb674bd38fdc3210c91c8e..c440e0d6be8b3e21a85ead117b74c0c8cede047f 100644 (file)
--- a/ovsdb/ovsdb-tool.1.in
+++ b/ovsdb/ovsdb-tool.1.in
@@ -12,13 +12,28 @@
 ovsdb\-tool \- Open vSwitch database management utility
 .
 .SH SYNOPSIS
 ovsdb\-tool \- Open vSwitch database management utility
 .
 .SH SYNOPSIS

-\fBovsdb\-tool \fR[\fIoptions\fR] \fBcreate\fI db schema\fR
+\fBovsdb\-tool \fR[\fIoptions\fR] \fBcreate \fR[\fIdb\fR [\fIschema\fR]]

 .br
 .br

-\fBovsdb\-tool \fR[\fIoptions\fR] \fBquery\fI db transaction\fR
+\fBovsdb\-tool \fR[\fIoptions\fR] \fBcompact \fR[\fIdb\fR [\fItarget\fR]]

 .br
 .br

-\fBovsdb\-tool \fR[\fIoptions\fR] \fBtransact\fI db transaction\fR
+\fBovsdb\-tool \fR[\fIoptions\fR] \fBconvert \fR[\fIdb\fR [\fIschema
+\fR[\fItarget\fR]]]

 .br
 .br

-\fBovsdb\-tool \fR[\fIoptions\fR] [\fB\-m\fR | \fB\-\-more\fR]... \fBshow\-log\fI db\fR
+\fBovsdb\-tool \fR[\fIoptions\fR] \fBneeds\-conversion \fR[\fIdb\fR [\fIschema\fR]]
+.br
+\fBovsdb\-tool \fR[\fIoptions\fR] \fBdb\-version \fR[\fIdb\fR]
+.br
+\fBovsdb\-tool \fR[\fIoptions\fR] \fBschema\-version \fR[\fIschema\fR]
+.br
+\fBovsdb\-tool \fR[\fIoptions\fR] \fBdb\-cksum \fR[\fIdb\fR]
+.br
+\fBovsdb\-tool \fR[\fIoptions\fR] \fBschema\-cksum \fR[\fIschema\fR]
+.br
+\fBovsdb\-tool \fR[\fIoptions\fR] \fBquery \fR[\fIdb\fR] \fItransaction\fR
+.br
+\fBovsdb\-tool \fR[\fIoptions\fR] \fBtransact \fR[\fIdb\fR] \fItransaction\fR
+.br
+\fBovsdb\-tool \fR[\fIoptions\fR] [\fB\-m\fR | \fB\-\-more\fR]... \fBshow\-log \fR[\fIdb\fR]

 .br
 \fBovsdb\-tool help\fR
 .so lib/vlog-syn.man
 .br
 \fBovsdb\-tool help\fR
 .so lib/vlog-syn.man


@@ -63,6 +78,34 @@ ignored.  Columns that exist in \fIschema\fR but not in \fIdb\fR are
 set to their default values.  All of \fIschema\fR's constraints apply
 in full.
 .
 set to their default values.  All of \fIschema\fR's constraints apply
 in full.
 .

+.IP "\fBneeds\-conversion\fI db schema\fR"
+Reads the schema embedded in \fIdb\fR and the standalone schema in
+\fIschema\fR and compares them.  If the schemas are the same, prints
+\fBno\fR on stdout; if they differ, print \fByes\fR.
+.
+.IP "\fBdb\-version\fI db\fR"
+.IQ "\fBschema\-version\fI schema\fR"
+Prints the version number in the schema embedded within the database
+\fIdb\fR or in the standalone schema \fIschema\fR 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 \fIschema\fR or \fIdb\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 "\fBdb\-cksum\fI db\fR"
+.IQ "\fBschema\-cksum\fI schema\fR"
+Prints the checksum in the schema embedded within the database
+\fIdb\fR or of the standalone schema \fIschema\fR on stdout.
+.IP
+If \fIschema\fR or \fIdb\fR was created before schema checksums were
+introduced, then it will not have a checksum and this command
+will print a blank line.
+.

 .IP "\fBquery\fI db transaction\fR"
 Opens \fIdb\fR, executes \fItransaction\fR on it, and prints the
 results.  The \fItransaction\fR must be a JSON array in the format of
 .IP "\fBquery\fI db transaction\fR"
 Opens \fIdb\fR, executes \fItransaction\fR on it, and prints the
 results.  The \fItransaction\fR must be a JSON array in the format of


@@ -88,7 +131,7 @@ instead, to write to a database that is served by
 \fBovsdb\-server\fR(1).
 .
 .IP "\fBshow\-log\fI db\fR"
 \fBovsdb\-server\fR(1).
 .
 .IP "\fBshow\-log\fI db\fR"

-Prints a summary of the records in \fBdb\fR's log, including the time
+Prints a summary of the records in \fIdb\fR's log, including the time

 and date at which each database change occurred and any associated
 comment.  This may be useful for debugging.
 .PP
 and date at which each database change occurred and any associated
 comment.  This may be useful for debugging.
 .PP


@@ -104,6 +147,10 @@ record.
 .so lib/vlog.man
 .SS "Other Options"
 .so lib/common.man
 .so lib/vlog.man
 .SS "Other Options"
 .so lib/common.man

+.SH "FILES"
+The default \fIdb\fR is \fB@sysconfdir@/openvswitch/conf.db\fR.  The
+default \fIschema\fR is \fB@pkgdatadir@/vswitch.ovsschema\fR.  The
+\fBhelp\fR command also displays these defaults.

 .SH "SEE ALSO"
 .
 \fBovsdb\-server\fR(1),
 .SH "SEE ALSO"
 .
 \fBovsdb\-server\fR(1),