ofp-actions: Support mixing "conjunction" and "note" actions.

[cascardo/ovs.git] / utilities / ovs-vlan-test.8.in

diff --git a/utilities/ovs-vlan-test.8.in b/utilities/ovs-vlan-test.8.in
index 82b4cf7..2cdeff8 100644 (file)
--- a/utilities/ovs-vlan-test.8.in
+++ b/utilities/ovs-vlan-test.8.in
@@ -1,4 +1,9 @@
-.TH ovs\-vlan\-test 1 "December 2010" "Open vSwitch" "Open vSwitch Manual"
+.de IQ
+.  br
+.  ns
+.  IP "\\$1"
+..
+.TH ovs\-vlan\-test 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
 .
 .SH NAME
 \fBovs\-vlan\-test\fR \- check Linux drivers for problems with vlan traffic
@@ -8,6 +13,12 @@
 .so lib/common-syn.man
 .
 .SH DESCRIPTION
+The \fBovs\-vlan\-test\fR utility has some limitations, for example, it does
+not use TCP in its tests. Also it does not take into account MTU to detect
+potential edge cases. To overcome those limitations a new tool was
+developed \- \fBovs\-test\fR. \fBovs\-test\fR is currently supported only
+on Debian so, if possible try to use that on instead of \fBovs\-vlan\-test\fR.
+.PP
 The \fBovs\-vlan\-test\fR program may be used to check for problems sending
 802.1Q traffic which may occur when running Open vSwitch. These problems can
 occur when Open vSwitch is used to send 802.1Q traffic through physical
@@ -18,23 +29,7 @@ client mode connecting to an \fBovs\-vlan\-test\fR server.
 \fBovs\-vlan\-test\fR will display "OK" if it did not detect problems.
 .PP
 Some examples of the types of problems that may be encountered are:
-.IP \(bu
-When NICs use vlan stripping on receive they must pass a pointer to
-a vlan group when reporting the stripped tag to the networking core.
-If there is no vlan group in use then some drivers just drop the
-extracted tag.  Drivers are supposed to only enable stripping if a
-vlan group is registered but not all of them do that.
-.
-.IP \(bu
-Some drivers size their receive buffers based on whether a vlan
-group is enabled, meaning that a maximum size packet with a vlan tag
-will not fit if a vlan group is not configured.
-.
-.IP \(bu
-On transmit some drivers expect that vlan acceleration will be used
-if it is available (which can only be done if a vlan group is
-configured).  In these cases, the driver may fail to parse the packet
-and correctly setup checksum offloading and/or TSO.
+.so utilities/ovs-vlan-bugs.man
 .
 .SS "Client Mode"
 An \fBovs\-vlan\-test\fR client may be run on a host to check for VLAN
@@ -53,8 +48,8 @@ test against a single \fBovs\-vlan\-test\fR server concurrently.
 .
 .SH OPTIONS
 .
-.TP
-\fB\-s\fR, \fB\-\-server\fR
+.IP "\fB\-s\fR"
+.IQ "\fB\-\-server\fR"
 Run in server mode.
 .
 .so lib/common.man
@@ -77,26 +72,25 @@ Set up a bridge which forwards traffic originating from \fB1.2.3.4\fR out
 .IP
 .B \-\- set Interface vlan\-br\-tag type=internal
 .IP
-.B ifconfig vlan\-br\-tag up 5.6.7.8
+.B ifconfig vlan\-br\-tag up 1.2.3.4
 .
 .PP
 Run an \fBovs\-vlan\-test\fR server listening for client control traffic on
-5.6.7.8 port 80 and VLAN traffic on the default port of 1.2.3.0.
+172.16.0.142 port 8080 and VLAN traffic on the default port of 1.2.3.3.
 .IP
-.B ovs\-vlan\-test \-s 5.6.7.8:80 1.2.3.0
+.B ovs\-vlan\-test \-s 172.16.0.142:8080 1.2.3.3
 .
 .PP
-Run an \fBovs\-vlan\-test\fR client with a control server located at 5.6.7.8
-port 80 and a local VLAN ip of 1.2.3.4.
+Run an \fBovs\-vlan\-test\fR client with a control server located at
+172.16.0.142 port 8080 and a local VLAN ip of 1.2.3.4.
 .IP
-.B ovs\-vlan\-test 5.6.7.8:80 1.2.3.4
+.B ovs\-vlan\-test 172.16.0.142:8080 1.2.3.4
 .
-.TP
-
 .SH SEE ALSO
 .
 .BR ovs\-vswitchd (8),
 .BR ovs\-ofctl (8),
 .BR ovs\-vsctl (8),
+.BR ovs\-test (8),
 .BR ethtool (8),
 .BR uname (1)