From: Justin Pettit <jpettit@nicira.com>
Date: Thu, 10 Dec 2009 23:04:22 +0000 (-0800)
Subject: ovs-brcompatd: Change man page to reflect new config db changes
X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=36594cd0b01407bb7ed44ef424ab8d8a810e7c43;p=openvswitch

ovs-brcompatd: Change man page to reflect new config db changes
---

diff --git a/vswitchd/ovs-brcompatd.8.in b/vswitchd/ovs-brcompatd.8.in
index e1d448d2..28d2d983 100644
--- a/vswitchd/ovs-brcompatd.8.in
+++ b/vswitchd/ovs-brcompatd.8.in
@@ -6,14 +6,21 @@ 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.
+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 takes one of the following forms:
+.IP "\fBtcp:\fIip\fB:\fIport\fR"
+Connect to the given TCP \fIport\fR on \fIip\fR.
+.IP "\fBunix:\fIfile\fR"
+Connect to the Unix domain server socket named \fIfile\fR.
 .PP
 .SH OPTIONS
 .IP "\fB--appctl-command=\fIcommand\fR"
@@ -39,14 +46,9 @@ both of these streams separately.
 \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
@@ -59,5 +61,5 @@ loaded.
 .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.