Merge "sflow" into "master".

[openvswitch] / utilities / ovs-controller.8.in

diff --git a/utilities/ovs-controller.8.in b/utilities/ovs-controller.8.in
index b6b05d074661c2b9bd473b57ef293336b30dd411..040f633038ec61342666db68f9ac74700c090af4 100644 (file)
--- a/utilities/ovs-controller.8.in
+++ b/utilities/ovs-controller.8.in
@@ -38,16 +38,15 @@ to the given \fIip\fR.
 Listens for connections from OpenFlow switches on the Unix domain
 server socket named \fIfile\fR.
 
 Listens for connections from OpenFlow switches on the Unix domain
 server socket named \fIfile\fR.
 

-.TP
-\fBssl:\fIhost\fR[\fB:\fIport\fR]
-The specified SSL \fIport\fR (default: 6633) on the given remote
-\fIhost\fR.  The \fB--private-key\fR, \fB--certificate\fR, and
-\fB--ca-cert\fR options are mandatory when this form is used.
+.IP "\fBssl:\fIip\fR[\fB:\fIport\fR]"
+The specified SSL \fIport\fR (default: 6633) on the host at the given
+\fIip\fR, which must be expressed as an IP address (not a DNS name).
+The \fB--private-key\fR, \fB--certificate\fR, and \fB--ca-cert\fR
+options are mandatory when this form is used.

 
 

-.TP
-\fBtcp:\fIhost\fR[\fB:\fIport\fR]
-The specified TCP \fIport\fR (default: 6633) on the given remote
-\fIhost\fR.
+.IP "\fBtcp:\fIip\fR[\fB:\fIport\fR]"
+The specified TCP \fIport\fR (default: 6633) on the host at the given
+\fIip\fR, which must be expressed as an IP address (not a DNS name).

 
 .TP
 \fBunix:\fIfile\fR
 
 .TP
 \fBunix:\fIfile\fR


@@ -119,6 +118,30 @@ through the controller and every packet is flooded.
 
 This option is most useful for debugging.  It reduces switching
 performance, so it should not be used in production.
 
 This option is most useful for debugging.  It reduces switching
 performance, so it should not be used in production.

+.
+.IP "\fB-w\fR, \fB--wildcard\fR"
+By default, \fBovs\-controller\fR sets up exact-match flows.  This
+option allows it to set up wildcarded flows, which may reduce
+flow-setup latency by causing less traffic to be sent up to the
+controller.
+.IP
+This option has no effect when \fB-n\fR (or \fB--noflow\fR) is in use
+(because the controller does not set up flows in that case).
+.
+.IP "\fB-N\fR, \fB--normal\fR"
+By default, \fBovs\-controller\fR directs packets to a particular port
+or floods them.  This option causes it to direct non-flooded packets
+to the OpenFlow \fBOFPP_NORMAL\fR port.  This allows the switch itself
+to make decisions about packet destinations.  Support for
+\fBOFPP_NORMAL\fR is optional in OpenFlow, so this option may not well
+with some non-Open vSwitch switches.
+.
+.IP "\fB--mute\fR"
+Prevents ovs\-controller from replying to any OpenFlow messages sent
+to it by switches.
+.IP
+This option is only for debugging the Open vSwitch implementation of
+``fail open'' mode.  It must not be used in production.

 
 .so lib/daemon.man
 .so lib/vlog.man
 
 .so lib/daemon.man
 .so lib/vlog.man