ovs-ofctl: Document "in_port" action in man page.
[openvswitch] / ofproto / ofproto-unixctl.man
index 72f076dd579eaa9232bc2b82d56f7fbc01b87cce..be6f002b4aadac222127874907b55c11f3f34d5b 100644 (file)
@@ -4,10 +4,13 @@ These commands manage the core OpenFlow switch implementation (called
 .IP "\fBofproto/list\fR"
 Lists the names of the running ofproto instances.  These are the names
 that may be used on \fBofproto/trace\fR.
-.IP "\fBofproto/trace \fItun_id in_port packet\fR"
-Traces the path of an imaginary packet through ofproto.  The arguments
-are:
+.IP "\fBofproto/trace \fIswitch tun_id in_port packet\fR"
+Traces the path of an imaginary packet through \fIswitch\fR.  The
+arguments are:
 .RS
+.IP "\fIswitch\fR"
+The switch on which the packet arrived (one of those listed by
+\fBofproto/list\fR).
 .IP "\fItun_id\fR"
 The tunnel ID on which the packet arrived.  Use
 \fB0\fR if the packet did not arrive through a tunnel.
@@ -20,7 +23,7 @@ Ethernet frame is at least 14 bytes long, so there must be at least 28
 hex digits.  Obviously, it is inconvenient to type in the hex digits
 by hand, so the \fBovs\-pcap\fR(1) and \fBovs\-tcpundump\fR(1)
 utilities provide easier ways.
-.RS
+.RE
 \fB\*(PN\fR will respond with extensive information on how the packet
 would be handled if it were to be received.  The packet will not
 actually be sent.