Describe dummy test model. Work on OpenFlow intro.

[openvswitch] / ofproto / ofproto-unixctl.man

diff --git a/ofproto/ofproto-unixctl.man b/ofproto/ofproto-unixctl.man
index 9d0c8e32783e0ee1dccd7ef7197d7abb56683e55..889034367187d2a08c45cbc072297c7b5b95e20e 100644 (file)
--- a/ofproto/ofproto-unixctl.man
+++ b/ofproto/ofproto-unixctl.man
@@ -6,7 +6,7 @@ These commands manage the core OpenFlow switch implementation (called
 Lists the names of the running ofproto instances.  These are the names
 that may be used on \fBofproto/trace\fR.
 .
 Lists the names of the running ofproto instances.  These are the names
 that may be used on \fBofproto/trace\fR.
 .

-.IP "\fBofproto/trace \fIswitch priority tun_id in_port packet\fR"
+.IP "\fBofproto/trace \fIswitch priority tun_id in_port mark packet\fR"

 .IQ "\fBofproto/trace \fIswitch flow \fB\-generate\fR"
 Traces the path of an imaginary packet through \fIswitch\fR.  Both
 forms require \fIswitch\fR, the switch on which the packet arrived
 .IQ "\fBofproto/trace \fIswitch flow \fB\-generate\fR"
 Traces the path of an imaginary packet through \fIswitch\fR.  Both
 forms require \fIswitch\fR, the switch on which the packet arrived


@@ -21,6 +21,8 @@ The tunnel ID on which the packet arrived.  Use
 .IP "\fIin_port\fR"
 The OpenFlow port on which the packet arrived.  Use \fB65534\fR if the
 packet arrived on \fBOFPP_LOCAL\fR, the local port.
 .IP "\fIin_port\fR"
 The OpenFlow port on which the packet arrived.  Use \fB65534\fR if the
 packet arrived on \fBOFPP_LOCAL\fR, the local port.

+.IP "\fImark\fR"
+SKB mark of the packet. Use \fB0\fR if Netfilter marks are not used.

 .IP "\fIpacket\fR"
 A sequence of hex digits specifying the packet's contents.  An
 Ethernet frame is at least 14 bytes long, so there must be at least 28
 .IP "\fIpacket\fR"
 A sequence of hex digits specifying the packet's contents.  An
 Ethernet frame is at least 14 bytes long, so there must be at least 28


@@ -31,13 +33,13 @@ utilities provide easier ways.
 .IP
 The second form specifies the packet's contents implicitly:
 .RS
 .IP
 The second form specifies the packet's contents implicitly:
 .RS

-.IP "\flow\fR"
+.IP "\fIflow\fR"

 A flow in one of two forms: either the form printed by
 \fBovs\-dpctl\fR(8)'s \fBdump\-flows\fR command, or in a format
 A flow in one of two forms: either the form printed by
 \fBovs\-dpctl\fR(8)'s \fBdump\-flows\fR command, or in a format

-similar to that accepted by \Bovs\-ofctl\fR(8)'s \fBadd\-flow\fR
+similar to that accepted by \fBovs\-ofctl\fR(8)'s \fBadd\-flow\fR

 command.  This is not an OpenFlow flow: besides other differences, it
 never contains wildcards.  \fB\*(PN\fR generates an arbitrary packet
 command.  This is not an OpenFlow flow: besides other differences, it
 never contains wildcards.  \fB\*(PN\fR generates an arbitrary packet

-that has the specified \flow\fR.
+that has the specified \fIflow\fR.

 .RE
 .IP
 \fB\*(PN\fR will respond with extensive information on how the packet
 .RE
 .IP
 \fB\*(PN\fR will respond with extensive information on how the packet


@@ -51,16 +53,16 @@ Traces the path of a packet in an imaginary flow through
 .IP "\fIswitch\fR"
 The switch on which the packet arrived (one of those listed by
 \fBofproto/list\fR).
 .IP "\fIswitch\fR"
 The switch on which the packet arrived (one of those listed by
 \fBofproto/list\fR).

-.IP "\flow\fR"
+.IP "\fIflow\fR"

 A flow in one of two forms: either the form printed by
 \fBovs\-dpctl\fR(8)'s \fBdump\-flows\fR command, or in a format
 A flow in one of two forms: either the form printed by
 \fBovs\-dpctl\fR(8)'s \fBdump\-flows\fR command, or in a format

-similar to that accepted by \Bovs\-ofctl\fR(8)'s \fBadd\-flow\fR
+similar to that accepted by \fBovs\-ofctl\fR(8)'s \fBadd\-flow\fR

 command.  This is not an OpenFlow flow: besides other differences, it
 never contains wildcards.
 .RE
 .IP
 \fB\*(PN\fR will respond with extensive information on how a packet
 command.  This is not an OpenFlow flow: besides other differences, it
 never contains wildcards.
 .RE
 .IP
 \fB\*(PN\fR will respond with extensive information on how a packet

-in \flow\fR would be handled if it were received by
+in \fIflow\fR would be handled if it were received by

 \fIswitch\fR.  No packet will actually be sent.  Some side effects may
 occur, but MAC learning in particular will not.
 .IP
 \fIswitch\fR.  No packet will actually be sent.  Some side effects may
 occur, but MAC learning in particular will not.
 .IP