X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=ovsdb%2Fovsdb-tool.1.in;h=a2f1f22ba7a8d36a76c47f9545aa1977091d8eda;hb=28c5588e8e1a8d091c5d2275232c35f2968a97fa;hp=04e6296860893f9c4820febee2ea50e9d0f17f00;hpb=c69ee87c10818267f991236201150b1fa51ae519;p=sliver-openvswitch.git

diff --git a/ovsdb/ovsdb-tool.1.in b/ovsdb/ovsdb-tool.1.in
index 04e629686..a2f1f22ba 100644
--- a/ovsdb/ovsdb-tool.1.in
+++ b/ovsdb/ovsdb-tool.1.in
@@ -5,20 +5,35 @@
 .  IP "\\$1"
 ..
 .\" -*- nroff -*-
-.TH ovsdb\-tool 1 "November 2009" "Open vSwitch" "Open vSwitch Manual"
+.TH ovsdb\-tool 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
 .ds PN ovsdb\-tool
 .
 .SH NAME
 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
-\fBovsdb\-tool \fR[\fIoptions\fR] \fBquery\fI db transaction\fR
+\fBovsdb\-tool \fR[\fIoptions\fR] \fBcompact \fR[\fIdb\fR [\fItarget\fR]]
 .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
-\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
@@ -40,6 +55,57 @@ 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 "\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
@@ -48,7 +114,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 +126,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"
-Prints a summary of the records in \fBdb\fR's log, including the time
+.IP "\fBshow\-log\fI db\fR"
+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
-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,
+.IP
+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.
 .
@@ -81,6 +147,10 @@ record.
 .so lib/vlog.man
 .SS "Other Options"
 .so lib/common.man
+.SH "FILES"
+The default \fIdb\fR is \fB@DBDIR@/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),