ebd67028f3ca7ac1d8856eb157919f3bfe46b4e1
[openvswitch] / vswitchd / ovs-brcompatd.8.in
1 .TH ovs\-brcompatd 8 "March 2009" "Open vSwitch" "Open vSwitch Manual"
2 .ds PN ovs\-brcompatd
3 .
4 .SH NAME
5 ovs\-brcompatd \- Bridge compatibility front-end for ovs\-vswitchd
6 .
7 .SH SYNOPSIS
8 .B ovs\-brcompatd
9 [\fIoptions\fR] \fIconfig\fR
10 .
11 .SH DESCRIPTION
12 A daemon that provides a legacy bridge front-end for \fBovs\-vswitchd\fR.  It 
13 does this by listening for bridge ioctl commands (e.g., those generated by 
14 the \fBbrctl\fR program) to add or remove datapaths and the interfaces 
15 that attach to them.  It modifies \fIconfig\fR and forces
16 \fBovs\-vswitchd\fR to reload its configuration file.
17 .PP
18 .SH OPTIONS
19 .IP "\fB--reload-command=\fIcommand\fR"
20 Sets the command that \fBovs\-brcompatd\fR runs to force \fBovs\-vswitchd\fR to
21 reload its configuration file to \fIcommand\fR.  The command is run in
22 a subshell, so it may contain arbitrary shell metacharacters, etc.
23 The \fB--help\fR option displays the default reload command.
24 .TP
25 \fB--prune-timeout=\fIsecs\fR
26 .
27 Sets the maximum time between pruning port entries to \fIsecs\fR seconds.
28 Pruning ports is the process of removing port entries from \fIconfig\fR 
29 that no longer exist.  If \fIsecs\fR is zero, then entries are never
30 pruned.  The default prune timeout is 5 seconds.
31 .TP
32 \fB--lock-timeout=\fImsecs\fR
33 .
34 Sets the maximum time to wait for \fIconfig\fR to become unlocked to 
35 \fImsecs\fR milliseconds.  The default lock timeout is 500 milliseconds.
36 .
37 .so lib/daemon.man
38 .so lib/vlog.man
39 .so lib/common.man
40 .so lib/leak-checker.man
41 .
42 .SH NOTES
43 \fBovs\-brcompatd\fR requires the \fBbrcompat_mod.ko\fR kernel module to be
44 loaded.
45 .SH "SEE ALSO"
46 .BR ovs\-appctl (8),
47 .BR ovs\-vswitchd (8),
48 .BR ovs\-vswitchd.conf (5),
49 \fBINSTALL\fR in the Open vSwitch distribution.