ofproto: Add "ofproto/trace" command to help debugging flow tables.

[sliver-openvswitch.git] / utilities / ovs-tcpundump.1.in

diff --git a/utilities/ovs-tcpundump.1.in b/utilities/ovs-tcpundump.1.in
new file mode 100644 (file)
index 0000000..e59f6db
--- /dev/null
+++ b/utilities/ovs-tcpundump.1.in
@@ -0,0 +1,30 @@
+.TH ovs\-tcpundump 1 "December 2010" "Open vSwitch" "Open vSwitch Manual"
+.
+.SH NAME
+ovs\-tcpundump \- convert ``tcpdump \-xx'' output to hex strings
+.
+.SH SYNOPSIS
+\fBovs\-tcpundump < \fIfile\fR
+.so lib/common-syn.man
+.
+.SH DESCRIPTION
+The \fBovs\-tcpundump\fR program reads \fBtcpdump \-xx\fR output on
+stdin, looking for hexadecimal packet data, and dumps each Ethernet as
+a single hexadecimal string on stdout.  This format is suitable for
+use with the \fBofproto/trace\fR command supported by
+\fBovs\-vswitchd\fR(8) and \fBovs-openflowd\fR(8).
+.PP
+At least two \fB\-x\fR or \fB\-X\fR options must be given, otherwise
+the output will omit the Ethernet header, which prevents the output
+from being using with \fBofproto/trace\fR.
+.
+.SH "OPTIONS"
+.so lib/common.man
+.
+.SH "SEE ALSO"
+.
+.BR ovs\-vswitchd (8),
+.BR ovs\-openflowd (8),
+.BR ovs\-pcap (1),
+.BR tcpdump (8),
+.BR wireshark (8).