Update documentatin for the qt build to reflect the cmake work.

[obnox/wireshark/wip.git] / doc / rawshark.pod

diff --git a/doc/rawshark.pod b/doc/rawshark.pod
index 1a3b9db210f735affd65dc1106c6a1584883341a..5b113a5db44eae1441cb55d746d71858593bf439 100644 (file)
--- a/doc/rawshark.pod
+++ b/doc/rawshark.pod
@@ -13,6 +13,7 @@ S<[ B<-l> ]>
 S<[ B<-n> ]>
 S<[ B<-N> E<lt>name resolving flagsE<gt> ]>
 S<[ B<-o> E<lt>preference settingE<gt> ] ...>
+S<[ B<-p> ]>
 S<[ B<-r> E<lt>pipeE<gt>|- ]>
 S<[ B<-R> E<lt>read (display) filterE<gt> ]>
 S<[ B<-s> ]>
@@ -34,8 +35,9 @@ One or more B<-F> flags should be specified in order for the output to be
 useful. The other flags listed above follow the same conventions as
 B<Wireshark> and B<TShark>.
 
-B<Rawshark> expects input records with the following format. Note that this
-matches the pcap_pkthdr struct and packet data used in libpcap.
+B<Rawshark> expects input records with the following format by default. This
+matches the format of the packet header and packet data in a libpcap-formatted
+file on disk.
 
     struct rawshark_rec_s {
         uint32_t ts_sec;      /* Time stamp (seconds) */
@@ -45,6 +47,20 @@ matches the pcap_pkthdr struct and packet data used in libpcap.
         uint8_t data[caplen]; /* Packet data */
     };
 
+If B<-p> is supplied B<rawshark> expects the following format. This matches the
+pcap_pkthdr struct and packet data used in libpcap. Note that the time stamp
+value will match the previous format on some systems but not others.
+
+    struct rawshark_rec_s {
+        struct timeval ts;    /* Time stamp */
+        uint32_t caplen;      /* Length of the packet buffer */
+        uint32_t len;         /* "On the wire" length of the packet */
+        uint8_t *data;        /* Packet data */
+    };
+
+In either case, the endianness (byte ordering) of each integer must match the
+system on which B<rawshark> is running.
+
 =head1 OUTPUT
 
 If one or more fields are specified via the B<-F> flag, B<Rawshark> prints
@@ -82,9 +98,6 @@ fields might be displayed.
 Specify how the packet data should be dissected. The encapsulation is of the
 form I<type>B<:>I<value>, where I<type> is one of:
 
-B<encap>:I<name> Packet data should be dissected using the libpcap data
-link type I<name>, e.g. B<encap:EN10MB> for Ethernet.
-
 B<encap>:I<name> Packet data should be dissected using the libpcap data link
 type (DLT) I<name>, e.g. B<encap:EN10MB> for Ethernet. Names are converted
 using pcap_datalink_name_to_val().
@@ -156,6 +169,13 @@ form I<prefname>B<:>I<value>, where I<prefname> is the name of the
 preference (which is the same name that would appear in the preference
 file), and I<value> is the value to which it should be set.
 
+=item -p
+
+Assume that packet data is preceded by a pcap_pkthdr struct as defined in
+pcap.h. On some systems the size of the timestamp data will be different from
+the data written to disk. On other systems they are identical and this flag has
+no effect.
+
 =item -r  E<lt>pipeE<gt>|-
 
 Read packet data from I<input source>. It can be either the name of a FIFO
@@ -429,6 +449,13 @@ deciding if a file really is in the ERF format.  Setting this environment
 variable a number higher than the default (20) would make false positives
 less likely.
 
+=item IPFIX_RECORDS_TO_CHECK
+
+This environment variable controls the number of IPFIX records checked when
+deciding if a file really is in the IPFIX format.  Setting this environment
+variable a number higher than the default (20) would make false positives
+less likely.
+
 =item WIRESHARK_ABORT_ON_DISSECTOR_BUG
 
 If this environment variable is set, B<Rawshark> will call abort(3)