Merge "citrix" branch into "master".

[openvswitch] / vswitchd / ovs-brcompatd.8.in

diff --git a/vswitchd/ovs-brcompatd.8.in b/vswitchd/ovs-brcompatd.8.in
index cd911ca831eb5cef96dde06f742ad298ae634f31..f5dd62a716a2612e706bb1e3a564fcba50e2d840 100644 (file)
--- a/vswitchd/ovs-brcompatd.8.in
+++ b/vswitchd/ovs-brcompatd.8.in
@@ -6,14 +6,18 @@ ovs\-brcompatd \- Bridge compatibility front-end for ovs\-vswitchd
 .
 .SH SYNOPSIS
 .B ovs\-brcompatd
 .
 .SH SYNOPSIS
 .B ovs\-brcompatd

-[\fIoptions\fR] \fIconfig\fR
+[\fIoptions\fR] \fIdatabase\fR

 .
 .SH DESCRIPTION
 A daemon that provides a legacy bridge front-end for \fBovs\-vswitchd\fR.  It 
 does this by listening for bridge ioctl commands (e.g., those generated by 
 the \fBbrctl\fR program) to add or remove datapaths and the interfaces 
 .
 .SH DESCRIPTION
 A daemon that provides a legacy bridge front-end for \fBovs\-vswitchd\fR.  It 
 does this by listening for bridge ioctl commands (e.g., those generated by 
 the \fBbrctl\fR program) to add or remove datapaths and the interfaces 

-that attach to them.  It modifies \fIconfig\fR and forces
-\fBovs\-vswitchd\fR to reload its configuration file.
+that attach to them.  
+.PP
+The mandatory \fIdatabase\fR argument specifies the
+\fBovsdb\-server\fR from which \fBovs\-vswitchd\fR's configuration is
+retrieved.  It should take the form \fBunix:\fIfile\fR, to connect to
+the Unix domain server socket named \fIfile\fR.

 .PP
 .SH OPTIONS
 .IP "\fB--appctl-command=\fIcommand\fR"
 .PP
 .SH OPTIONS
 .IP "\fB--appctl-command=\fIcommand\fR"


@@ -29,10 +33,8 @@ replaced by a single \fB%\fR.  The \fB%\fR character may not otherwise
 appear in \fIcommand\fR.
 .IP
 The commands that are substituted into \fIcommand\fR are those that
 appear in \fIcommand\fR.
 .IP
 The commands that are substituted into \fIcommand\fR are those that

-can be listed by passing \fB-e help\fR to \fBovs\-appctl\fR with
-\fBovs\-vswitchd\fR as target.  The command that is substituted may
-include white space-separated arguments, so \fIcommand\fR should include
-shell quotes around \fB%s\fR.
+can be listed by passing \fBhelp\fR to \fBovs\-appctl\fR with
+\fBovs\-vswitchd\fR as target.

 .IP
 \fIcommand\fR must not redirect \fBovs\-appctl\fR's standard output or
 standard error streams, because \fBovs\-brcompatd\fR expects to read
 .IP
 \fIcommand\fR must not redirect \fBovs\-appctl\fR's standard output or
 standard error streams, because \fBovs\-brcompatd\fR expects to read


@@ -41,14 +43,9 @@ both of these streams separately.
 \fB--prune-timeout=\fIsecs\fR
 .
 Sets the maximum time between pruning port entries to \fIsecs\fR seconds.
 \fB--prune-timeout=\fIsecs\fR
 .
 Sets the maximum time between pruning port entries to \fIsecs\fR seconds.

-Pruning ports is the process of removing port entries from \fIconfig\fR 
+Pruning ports is the process of removing port entries from \fIdatabase\fR 

 that no longer exist.  If \fIsecs\fR is zero, then entries are never
 pruned.  The default prune timeout is 5 seconds.
 that no longer exist.  If \fIsecs\fR is zero, then entries are never
 pruned.  The default prune timeout is 5 seconds.

-.TP
-\fB--lock-timeout=\fImsecs\fR
-.
-Sets the maximum time to wait for \fIconfig\fR to become unlocked to 
-\fImsecs\fR milliseconds.  The default lock timeout is 500 milliseconds.

 .
 .so lib/daemon.man
 .so lib/vlog.man
 .
 .so lib/daemon.man
 .so lib/vlog.man


@@ -61,5 +58,5 @@ loaded.
 .SH "SEE ALSO"
 .BR ovs\-appctl (8),
 .BR ovs\-vswitchd (8),
 .SH "SEE ALSO"
 .BR ovs\-appctl (8),
 .BR ovs\-vswitchd (8),

-.BR ovs\-vswitchd.conf (5),
+.BR ovsdb\-server (1),

 \fBINSTALL.bridge\fR in the Open vSwitch distribution.
 \fBINSTALL.bridge\fR in the Open vSwitch distribution.