X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=utilities%2Fovs-vsctl.8.in;h=7db3ddcdcfdb9d45fb8a35a2b02f76a66ab5c5fa;hb=8ab4016b3604566d221b5461f690fd698494e6ae;hp=f5885816e246d86c89adbfa3c0f9097d67acdba7;hpb=bb1c67c813c9bd80c2bd9acf2bf5158b48841c61;p=openvswitch diff --git a/utilities/ovs-vsctl.8.in b/utilities/ovs-vsctl.8.in index f5885816..7db3ddcd 100644 --- a/utilities/ovs-vsctl.8.in +++ b/utilities/ovs-vsctl.8.in @@ -18,12 +18,12 @@ ovs\-vsctl \- utility for querying and configuring \fBovs\-vswitchd\fR . .SH SYNOPSIS -\fBovs\-vsctl\fR [\fIoptions\fR] [\fB\-\-\fR] \fIcommand \fR[\fIargs\fR\&...] -[\fB\-\-\fR \fIcommand \fR[\fIargs\fR\&...]] +\fBovs\-vsctl\fR [\fIoptions\fR] \fB\-\-\fR [\fIoptions\fR] \fIcommand +\fR[\fIargs\fR] [\fB\-\-\fR [\fIoptions\fR] \fIcommand \fR[\fIargs\fR]]... . .SH DESCRIPTION The \fBovs\-vsctl\fR program configures \fBovs\-vswitchd\fR(8) by -providing a high\-level interface to editing its configuration +providing a high\-level interface to its configuration database. This program is mainly intended for use when \fBovs\-vswitchd\fR is running. If it is used when \fBovs\-vswitchd\fR is not running, then \fB\-\-no\-wait\fR should be @@ -39,7 +39,16 @@ commands. Then, if it applied any changes, it waits until .PP \fBovs\-vsctl\fR can perform any number of commands in a single run, implemented as a single atomic transaction against the database. -Commands are separated on the command line by \fB\-\-\fR arguments. +.PP +The \fBovs\-vsctl\fR command line begins with global options (see +\fBOPTIONS\fR below for details). The global options are followed by +one or more commands. Each command should begin with \fB\-\-\fR by +itself as a command-line argument, to separate it from the global +options and following commands. (If the first command does not have +any options, then the first \fB\-\-\fR may be omitted.) The command +itself starts with command-specific options, if any, followed by the +command name and any arguments. See \fBEXAMPLES\fR below for syntax +examples. . .SS "Linux VLAN Bridging Compatibility" The \fBovs\-vsctl\fR program supports the model of a bridge @@ -247,6 +256,17 @@ Without \fB\-\-if\-exists\fR, attempting to delete a port that does not exist is an error. With \fB\-\-if\-exists\fR, attempting to delete a port that does not exist has no effect. . +.IP "[\fB\-\-if\-exists\fR] \fB\-\-with\-iface del\-port \fR[\fIbridge\fR] \fIiface\fR" +Deletes the port named \fIiface\fR or that has an interface named +\fIiface\fR. If \fIbridge\fR is omitted, the port is removed from +whatever bridge contains it; if \fIbridge\fR is specified, it must be +the real or fake bridge that contains the port. +.IP +Without \fB\-\-if\-exists\fR, attempting to delete the port for an +interface that does not exist is an error. With \fB\-\-if\-exists\fR, +attempting to delete the port for an interface that does not exist has +no effect. +. .IP "\fBport\-to\-br \fIport\fR" Prints the name of the bridge that contains \fIport\fR on standard output.