Merge branch 'hotfix' into make-improv

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

diff --git a/ovsdb/ovsdb-server.1.in b/ovsdb/ovsdb-server.1.in
index 79a39c6..242c98b 100644 (file)
--- a/ovsdb/ovsdb-server.1.in
+++ b/ovsdb/ovsdb-server.1.in
@@ -10,7 +10,7 @@ ovsdb\-server \- Open vSwitch database server
 .
 .SH SYNOPSIS
 \fBovsdb\-server\fR
 .
 .SH SYNOPSIS
 \fBovsdb\-server\fR

-\fIdatabase\fR
+[\fIdatabase\fR]\&...

 [\fB\-\-remote=\fIremote\fR]\&...
 [\fB\-\-run=\fIcommand\fR]
 .so lib/daemon-syn.man
 [\fB\-\-remote=\fIremote\fR]\&...
 [\fB\-\-run=\fIcommand\fR]
 .so lib/daemon-syn.man


@@ -21,13 +21,14 @@ ovsdb\-server \- Open vSwitch database server
 .so lib/common-syn.man
 .
 .SH DESCRIPTION
 .so lib/common-syn.man
 .
 .SH DESCRIPTION

-The \fBovsdb\-server\fR program provides RPC interfaces to an Open
-vSwitch database (OVSDB).  It supports JSON-RPC client connections
-over active or passive TCP/IP or Unix domain sockets.
+The \fBovsdb\-server\fR program provides RPC interfaces to one or more
+Open vSwitch databases (OVSDBs).  It supports JSON-RPC client
+connections over active or passive TCP/IP or Unix domain sockets.

 .PP
 .PP

-The name of the OVSDB file must be specified on the command line as
-\fIdatabase\fR, which must already have been created and initialized
-using, for example, \fBovsdb\-tool create\fR.
+Each OVSDB file may be specified on the command line as \fIdatabase\fR.
+If none is specified, the default is \fB@DBDIR@/conf.db\fR.  The database
+files must already have been created and initialized using, for
+example, \fBovsdb\-tool create\fR.

 .
 .SH OPTIONS
 .
 .
 .SH OPTIONS
 .


@@ -39,11 +40,12 @@ Adds \fIremote\fR as a connection method used by \fBovsdb\-server\fR.
 .so ovsdb/remote-passive.man
 .so ovsdb/remote-active.man
 .
 .so ovsdb/remote-passive.man
 .so ovsdb/remote-active.man
 .

-.IP "\fBdb:\fItable\fB,\fIcolumn\fR"
+.IP "\fBdb:\fR[\fIdb\fB,\fR]\fItable\fB,\fIcolumn\fR"

 Reads additional connection methods from \fIcolumn\fR in all of the
 Reads additional connection methods from \fIcolumn\fR in all of the

-rows in \fItable\fR.  As the contents of \fIcolumn\fR changes,
-\fBovsdb\-server\fR also adds and drops connection methods
-accordingly.
+rows in \fItable\fR within \fIdb\fR.  (If \fBovsdb\-server\fR is
+providing access to only one database, then \fIdb\fR is optional.)  As
+the contents of \fIcolumn\fR changes, \fBovsdb\-server\fR also adds
+and drops connection methods accordingly.

 .IP
 If \fIcolumn\fR's type is string or set of strings, then the
 connection methods are taken directly from the column.  The connection
 .IP
 If \fIcolumn\fR's type is string or set of strings, then the
 connection methods are taken directly from the column.  The connection


@@ -60,7 +62,7 @@ is mandatory: if it is missing or empty then no connection method can
 be configured.
 .IP "\fBmax_backoff\fR (integer)"
 Maximum number of milliseconds to wait between connection attempts.
 be configured.
 .IP "\fBmax_backoff\fR (integer)"
 Maximum number of milliseconds to wait between connection attempts.

-.IP "\fBinactivity_probe\fR (integer)
+.IP "\fBinactivity_probe\fR (integer)"

 Maximum number of milliseconds of idle time on connection to
 client before sending an inactivity probe message.
 .RE
 Maximum number of milliseconds of idle time on connection to
 client before sending an inactivity probe message.
 .RE


@@ -81,6 +83,9 @@ This option can be useful where a database server is needed only to
 run a single command, e.g.:
 .B "ovsdb\-server \-\-remote=punix:socket \-\-run='ovsdb\-client dump unix:socket Open_vSwitch'"
 .SS "Daemon Options"
 run a single command, e.g.:
 .B "ovsdb\-server \-\-remote=punix:socket \-\-run='ovsdb\-client dump unix:socket Open_vSwitch'"
 .SS "Daemon Options"

+.ds DD \
+\fBovsdb\-server\fR detaches only after it starts listening on all \
+configured remotes.

 .so lib/daemon.man
 .SS "Logging Options"
 .so lib/vlog.man
 .so lib/daemon.man
 .SS "Logging Options"
 .so lib/vlog.man


@@ -88,11 +93,11 @@ run a single command, e.g.:
 The options described below for configuring the SSL public key
 infrastructure accept a special syntax for obtaining their
 configuration from the database.  If any of these options is given
 The options described below for configuring the SSL public key
 infrastructure accept a special syntax for obtaining their
 configuration from the database.  If any of these options is given

-\fBdb:\fItable\fB,\fIcolumn\fR as its argument, then the actual file
-name is read from the specified \fIcolumn\fR in \fItable\fR within the
-\fBovsdb\-server\fR database.  The \fIcolumn\fR must have type string
-or set of strings.  The first nonempty string in the table is taken as
-the file name.  (This means that ordinarily there should be at most
+\fBdb:\fR[\fIdb\fB,\fR]\fItable\fB,\fIcolumn\fR as its argument, then the
+actual file name is read from the specified \fIcolumn\fR in \fItable\fR
+within the \fBovsdb\-server\fR database.  The \fIcolumn\fR must have type
+string or set of strings.  The first nonempty string in the table is taken
+as the file name.  (This means that ordinarily there should be at most

 one row in \fItable\fR.)
 .so lib/ssl.man
 .so lib/ssl-bootstrap.man
 one row in \fItable\fR.)
 .so lib/ssl.man
 .so lib/ssl-bootstrap.man


@@ -107,9 +112,10 @@ described below.
 These commands are specific to \fBovsdb\-server\fR.
 .IP "\fBexit\fR"
 Causes \fBovsdb\-server\fR to gracefully terminate.
 These commands are specific to \fBovsdb\-server\fR.
 .IP "\fBexit\fR"
 Causes \fBovsdb\-server\fR to gracefully terminate.

-.IP "\fBovsdb\-server/compact\fR"
-Compacts the database in-place.  The database is also automatically
-compacted occasionally.
+.IP "\fBovsdb\-server/compact\fR [\fIdb\fR]\&..."
+Compacts each database \fIdb\fR in-place.  If no \fIdb\fR is
+specified, compacts every database in-place.  Databases are also
+automatically compacted occasionally.

 .
 .IP "\fBovsdb\-server/reconnect\fR"
 Makes \fBovsdb\-server\fR drop all of the JSON\-RPC
 .
 .IP "\fBovsdb\-server/reconnect\fR"
 Makes \fBovsdb\-server\fR drop all of the JSON\-RPC


@@ -119,6 +125,9 @@ This command might be useful for debugging issues with database
 clients.
 .
 .so lib/vlog-unixctl.man
 clients.
 .
 .so lib/vlog-unixctl.man

+.so lib/memory-unixctl.man
+.so lib/coverage-unixctl.man
+.so lib/stress-unixctl.man

 .SH "SEE ALSO"
 .
 .BR ovsdb\-tool (1).
 .SH "SEE ALSO"
 .
 .BR ovsdb\-tool (1).