ovsdb-server: Add --run option.

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

diff --git a/ovsdb/ovsdb-server.1.in b/ovsdb/ovsdb-server.1.in
index 4c6cedd..17c955e 100644 (file)
--- a/ovsdb/ovsdb-server.1.in
+++ b/ovsdb/ovsdb-server.1.in
@@ -9,6 +9,7 @@ ovsdb\-server \- Open vSwitch database server
 \fBovsdb\-server\fR
 \fIdatabase\fR
 [\fB--remote=\fIremote\fR]\&...
+[\fB--run=\fIcommand\fR]
 .so lib/daemon-syn.man
 .so lib/vlog-syn.man
 .so lib/common-syn.man
@@ -33,6 +34,18 @@ Adds \fIremote\fR as a connection method used by \fBovsdb\-server\fR.
 .so ovsdb/remote-active.man
 .RE
 .
+.IP "\fB\-\-run=\fIcommand\fR]"
+Ordinarily \fBovsdb\-server\fR runs forever, or until it is told to
+exit (see \fBRUNTIME MANAGEMENT COMMANDS\fR below).  With this option,
+\fBovsdb\-server\fR instead starts a shell subprocess running
+\fIcommand\fR.  When the subprocess terminates, \fBovsdb\-server\fR
+also exits gracefully.  If the subprocess exits normally with exit
+code 0, then \fBovsdb\-server\fR exits with exit code 0 also;
+otherwise, it exits with exit code 1.
+.IP
+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"
 .so lib/daemon.man
 .SS "Logging Options"
@@ -44,6 +57,10 @@ Adds \fIremote\fR as a connection method used by \fBovsdb\-server\fR.
 \fBovs\-appctl\fR(8) can send commands to a running
 \fBovsdb\-server\fR process.  The currently supported commands are
 described below.
+.SS "OVSDB-SERVER COMMANDS"
+These commands are specific to \fBovsdb\-server\fR.
+.IP "\fBexit\fR"
+Causes \fBovsdb\-server\fR to gracefully terminate.
 .so lib/vlog-unixctl.man
 .SH "SEE ALSO"
 .