python/ovs/stream: teach stream.py tcp socket
[openvswitch] / ovsdb / ovsdb-tool.1.in
index 7f346095f3358d646be9440aece7b52d5e5971db..f9a36610babee6b786e30a55a2563e83dad33115 100644 (file)
 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] \fBcompact \fIdb \fR[\fItarget\fR]
+\fBovsdb\-tool \fR[\fIoptions\fR] \fBcompact \fR[\fIdb\fR [\fItarget\fR]]
 .br
 .br
-\fBovsdb\-tool \fR[\fIoptions\fR] \fBconvert\fI db schema
-\fR[\fItarget\fR]
+\fBovsdb\-tool \fR[\fIoptions\fR] \fBconvert \fR[\fIdb\fR [\fIschema
+\fR[\fItarget\fR]]]
 .br
 .br
-\fBovsdb\-tool \fR[\fIoptions\fR] \fBneeds\-conversion\fI db schema\fR
+\fBovsdb\-tool \fR[\fIoptions\fR] \fBneeds\-conversion \fR[\fIdb\fR [\fIschema\fR]]
 .br
 .br
-\fBovsdb\-tool \fR[\fIoptions\fR] \fBdb\-version\fI db\fR
+\fBovsdb\-tool \fR[\fIoptions\fR] \fBdb\-version \fR[\fIdb\fR]
 .br
 .br
-\fBovsdb\-tool \fR[\fIoptions\fR] \fBschema\-version\fI schema\fR
+\fBovsdb\-tool \fR[\fIoptions\fR] \fBschema\-version \fR[\fIschema\fR]
 .br
 .br
-\fBovsdb\-tool \fR[\fIoptions\fR] \fBdb\-cksum\fI db\fR
+\fBovsdb\-tool \fR[\fIoptions\fR] \fBdb\-cksum \fR[\fIdb\fR]
 .br
 .br
-\fBovsdb\-tool \fR[\fIoptions\fR] \fBschema\-cksum\fI schema\fR
+\fBovsdb\-tool \fR[\fIoptions\fR] \fBschema\-cksum \fR[\fIschema\fR]
 .br
 .br
-\fBovsdb\-tool \fR[\fIoptions\fR] \fBquery\fI db transaction\fR
+\fBovsdb\-tool \fR[\fIoptions\fR] \fBquery \fR[\fIdb\fR] \fItransaction\fR
 .br
 .br
-\fBovsdb\-tool \fR[\fIoptions\fR] \fBtransact\fI db transaction\fR
+\fBovsdb\-tool \fR[\fIoptions\fR] \fBtransact \fR[\fIdb\fR] \fItransaction\fR
 .br
 .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 \fR[\fIdb\fR]
 .br
 \fBovsdb\-tool help\fR
 .so lib/vlog-syn.man
 .br
 \fBovsdb\-tool help\fR
 .so lib/vlog-syn.man
@@ -102,8 +102,8 @@ will print a blank line.
 Prints the checksum in the schema embedded within the database
 \fIdb\fR or of the standalone schema \fIschema\fR on stdout.
 .IP
 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 versioning was
-introduced, then it will not have a version number and this command
+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"
 will print a blank line.
 .
 .IP "\fBquery\fI db transaction\fR"
@@ -131,10 +131,10 @@ 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.
 and date at which each database change occurred and any associated
 comment.  This may be useful for debugging.
-.PP
+.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
 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
@@ -147,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@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),
 .SH "SEE ALSO"
 .
 \fBovsdb\-server\fR(1),