vswitchd: Make the MAC entry aging time configurable.

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

diff --git a/vswitchd/ovs-brcompatd.8.in b/vswitchd/ovs-brcompatd.8.in
index ebd6702..0cce84d 100644 (file)
--- a/vswitchd/ovs-brcompatd.8.in
+++ b/vswitchd/ovs-brcompatd.8.in
@@ -6,33 +6,46 @@ ovs\-brcompatd \- Bridge compatibility front-end for ovs\-vswitchd
 .
 .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 
-that attach to them.  It modifies \fIconfig\fR and forces
-\fBovs\-vswitchd\fR to reload its configuration file.
+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.
+.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--reload-command=\fIcommand\fR"
-Sets the command that \fBovs\-brcompatd\fR runs to force \fBovs\-vswitchd\fR to
-reload its configuration file to \fIcommand\fR.  The command is run in
-a subshell, so it may contain arbitrary shell metacharacters, etc.
-The \fB--help\fR option displays the default reload command.
+.IP "\fB\-\-appctl\-command=\fIcommand\fR"
+Sets the command that \fBovs\-brcompatd\fR runs to communicate with
+\fBovs\-vswitchd\fR.  The command is run in \fB/bin/sh\fR as a shell
+command, so \fIcommand\fR may contain arbitrary shell metacharacters,
+etc.  The \fB\-\-help\fR option displays the default command.
+.IP
+\fIcommand\fR must contain exactly one instance of \fB%s\fR, which
+\fBovs\-brcompatd\fR replaces by a command from the set understood by
+\fBovs\-vswitchd\fR.  Any instances of \fB%%\fR in \fIcommand\fR are
+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
+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
+both of these streams separately.
 .TP
-\fB--prune-timeout=\fIsecs\fR
+\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.
-.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
@@ -45,5 +58,5 @@ loaded.
 .SH "SEE ALSO"
 .BR ovs\-appctl (8),
 .BR ovs\-vswitchd (8),
-.BR ovs\-vswitchd.conf (5),
-\fBINSTALL\fR in the Open vSwitch distribution.
+.BR ovsdb\-server (1),
+\fBINSTALL.bridge\fR in the Open vSwitch distribution.