Catalli's threaded switch

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

diff --git a/ovsdb/ovsdb-tool.1.in b/ovsdb/ovsdb-tool.1.in
index 04e6296..b073f6d 100644 (file)
--- a/ovsdb/ovsdb-tool.1.in
+++ b/ovsdb/ovsdb-tool.1.in
@@ -18,7 +18,7 @@ ovsdb\-tool \- Open vSwitch database management utility
 .br
 \fBovsdb\-tool \fR[\fIoptions\fR] \fBtransact\fI db transaction\fR
 .br
-\fBovsdb\-tool \fR[\fIoptions\fR] [\fB-m\fR | \fB--more\fR]... \fBshow\-log\fI db\fR
+\fBovsdb\-tool \fR[\fIoptions\fR] [\fB\-m\fR | \fB\-\-more\fR]... \fBshow\-log\fI db\fR
 .br
 \fBovsdb\-tool help\fR
 .so lib/vlog-syn.man
@@ -40,6 +40,29 @@ existing \fIdb\fR.
 \fIschema\fR must contain an OVSDB schema in JSON format.  Refer to
 the OVSDB specification for details.
 .
+.IP "\fBcompact\fI db \fR[\fItarget\fR]"
+Reads \fIdb\fR and writes a compacted version.  If \fItarget\fR is
+specified, the compacted version is written as a new file named
+\fItarget\fR, which must not already exist.  If \fItarget\fR is
+omitted, then the compacted version of the database replaces \fIdb\fR
+in-place.
+.
+.IP "\fBconvert\fI db schema \fR[\fItarget\fR]"
+Reads \fIdb\fR, translating it into to the schema specified in
+\fIschema\fR, and writes out the new interpretation.  If \fItarget\fR
+is specified, the translated version is written as a new file named
+\fItarget\fR, which must not already exist.  If \fItarget\fR is
+omitted, then the translated version of the database replaces \fIdb\fR
+in-place.
+.IP
+This command can do simple ``upgrades'' and ``downgrades'' on a
+database's schema.  The data in \fIdb\fR must be valid when
+interpreted under \fIschema\fR, with only one exception: data in
+\fIdb\fR for tables and columns that do not exist in \fIschema\fR are
+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.
+.
 .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
@@ -48,7 +71,7 @@ described in the OVSDB specification.
 .IP
 The \fIdb\fR is opened for read-only access, so this command may
 safely run concurrently with other database activity, including
-\fBovsdb-server\fR and other database writers.  The \fItransaction\fR
+\fBovsdb\-server\fR and other database writers.  The \fItransaction\fR
 may specify database modifications, but these will have no effect on
 \fIdb\fR.
 .
@@ -60,19 +83,19 @@ JSON array in the format of the \fBparams\fR array for the JSON-RPC
 .IP
 The \fIdb\fR is opened and locked for read/write access, so this
 command will fail if the database is opened for writing by any other
-process, including \fBovsdb-server\fR(1).  Use \fBovsdb\-client\fR(1),
+process, including \fBovsdb\-server\fR(1).  Use \fBovsdb\-client\fR(1),
 instead, to write to a database that is served by
-\fBovsdb-server\fR(1).
+\fBovsdb\-server\fR(1).
 .
-.IP "\fBshow-log\fI db\fR"
+.IP "\fBshow\-log\fI db\fR"
 Prints a summary of the records in \fBdb\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
-To increase the verbosity of output, add \fB-m\fR (or \fB--more\fR)
-one or more times to the command line.  With one \fB-m\fR,
+To increase the verbosity of output, add \fB\-m\fR (or \fB\-\-more\fR)
+one or more times to the command line.  With one \fB\-m\fR,
 \fBshow\-log\fR prints a summary of the records added, deleted, or
-modified by each transaction.  With two \fB-m\fRs, \fBshow\-log\fR
+modified by each transaction.  With two \fB\-m\fRs, \fBshow\-log\fR
 also prints the values of the columns modified by each change to a
 record.
 .