X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=vswitchd%2Fovs-brcompatd.8.in;h=fdce0428e4b1d6342515041a0d920057535bc8e9;hb=9b80f761bed9a32c1b0eb22ee3361966057ea973;hp=cd911ca831eb5cef96dde06f742ad298ae634f31;hpb=8398cf7efc3979cd6c8152915a584c13873ee322;p=sliver-openvswitch.git diff --git a/vswitchd/ovs-brcompatd.8.in b/vswitchd/ovs-brcompatd.8.in index cd911ca83..fdce0428e 100644 --- a/vswitchd/ovs-brcompatd.8.in +++ b/vswitchd/ovs-brcompatd.8.in @@ -6,60 +6,41 @@ ovs\-brcompatd \- Bridge compatibility front-end for ovs\-vswitchd . .SH SYNOPSIS .B ovs\-brcompatd -[\fIoptions\fR] \fIconfig\fR +[\fIoptions\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 .SH OPTIONS -.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 \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. -.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 +.IP "\fB\-\-appctl=\fIprogram\fR" +Sets the name to the program that \fBovs\-brcompatd\fR runs to +communicate with \fBovs\-vswitchd\fR. The default is +\fBovs\-appctl\fR. Unless \fIprogram\fR contains \fB/\fR, +\fBovs\-brcompatd\fR will search the \fBPATH\fR environment variable +to find it. . -Sets the maximum time between pruning port entries to \fIsecs\fR seconds. -Pruning ports is the process of removing port entries from \fIconfig\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. +.IP "\fB\-\-vsctl=\fIprogram\fR" +Sets the name to the program that \fBovs\-brcompatd\fR runs to +communicate with \fBovsdb\-server\fR. The default is +\fBovs\-vsctl\fR. Unless \fIprogram\fR contains \fB/\fR, +\fBovs\-brcompatd\fR will search the \fBPATH\fR environment variable +to find it. . +.ds DD .so lib/daemon.man .so lib/vlog.man .so lib/common.man .so lib/leak-checker.man . .SH NOTES -\fBovs\-brcompatd\fR requires the \fBbrcompat_mod.ko\fR kernel module to be +\fBovs\-brcompatd\fR requires the \fBbrcompat.ko\fR kernel module to be loaded. .SH "SEE ALSO" .BR ovs\-appctl (8), +.BR ovs\-vsctl (8), .BR ovs\-vswitchd (8), -.BR ovs\-vswitchd.conf (5), +.BR ovsdb\-server (1), \fBINSTALL.bridge\fR in the Open vSwitch distribution.