X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=ovsdb%2Fovsdb-server.1.in;h=242c98b54a5ba6254e543050007b1670068bc204;hb=7c690f462fec1af60d76c67fac226fc648ea9149;hp=1f5be03a8e6d09c513c26bcee66392d021aa403b;hpb=f973f2af2fd4452c8e182caf6a4346cf2a2a394e;p=sliver-openvswitch.git diff --git a/ovsdb/ovsdb-server.1.in b/ovsdb/ovsdb-server.1.in index 1f5be03a8..242c98b54 100644 --- 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 -[\fIdatabase\fR] +[\fIdatabase\fR]\&... [\fB\-\-remote=\fIremote\fR]\&... [\fB\-\-run=\fIcommand\fR] .so lib/daemon-syn.man @@ -21,13 +21,13 @@ ovsdb\-server \- Open vSwitch database server .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 -The OVSDB file may be specified on the command line as \fIdatabase\fR. -The default is \fB@DBDIR@/conf.db\fR. The database -file must already have been created and initialized using, for +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 @@ -40,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 . -.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 -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 @@ -61,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. -.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 @@ -92,11 +93,11 @@ configured remotes. 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 @@ -111,9 +112,10 @@ described below. 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