Alphabetical order, please.

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

diff --git a/doc/editcap.pod b/doc/editcap.pod
index f2cb2f7e348a72b9fbfd59e1833b3691cda97c45..deea34ea7644db765fc0beacab99dcdd7f4bdadf 100644 (file)
--- a/doc/editcap.pod
+++ b/doc/editcap.pod
@@ -10,6 +10,8 @@ S<[ B<-c> E<lt>packets per fileE<gt> ]>
 S<[ B<-C> E<lt>choplenE<gt> ]>
 S<[ B<-E> E<lt>error probabilityE<gt> ]>
 S<[ B<-F> E<lt>file formatE<gt> ]>
+S<[ B<-W> E<lt>file format optionE<gt>]>
+S<[ B<-H> E<lt>input hosts file<gt> ]>
 S<[ B<-A> E<lt>start timeE<gt> ]>
 S<[ B<-B> E<lt>stop timeE<gt> ]>
 S<[ B<-h> ]>
@@ -80,11 +82,13 @@ opened. The default is to use a single output file.
 
 =item -C  E<lt>choplenE<gt>
 
-Sets the chop length to use when writing the packet data.
-Each packet is chopped at the packet end by a few <choplen> bytes of data.
+Sets the chop length to use when writing the packet data. Each packet is
+chopped by a few <choplen> bytes of data. Positive values chop at the packet
+beginning while negative values chop at the packet end.
 
-This is useful in the rare case that the conversion between two file 
-formats leaves some random bytes at the end of each packet.
+This is useful for chopping headers for decapsulation of an entire capture or
+in the rare case that the conversion between two file formats leaves some random
+bytes at the end of each packet.
 
 =item -d
 
@@ -105,7 +109,7 @@ to standard out.  This verbose output (specifically the MD5 hash strings)
 can be useful in scripts to identify duplicate packets across trace
 files.
 
-The <dup window> is specifed as an integer value between 0 and 1000000 (inclusive).
+The <dup window> is specified as an integer value between 0 and 1000000 (inclusive).
 
 NOTE: Specifying large <dup window> values with large tracefiles can
 result in very long processing times for B<editcap>.
@@ -119,7 +123,7 @@ and the packet length and MD5 hash of the current packet are the same then
 the packet to skipped.  The duplicate comparison test stops when
 the current packet's relative arrival time is greater than <dup time window>.
 
-The <dup time window> is specifed as I<seconds>[I<.fractional seconds>].
+The <dup time window> is specified as I<seconds>[I<.fractional seconds>].
 
 The [.fractional seconds] component can be specified to nine (9) decimal
 places (billionths of a second) but most typical trace files have resolution
@@ -134,7 +138,7 @@ removal option may not identify some duplicates.
 
 =item -E  E<lt>error probabilityE<gt>
 
-Sets the probabilty that bytes in the output file are randomly changed.
+Sets the probability that bytes in the output file are randomly changed.
 B<Editcap> uses that probability (between 0.0 and 1.0 inclusive) 
 to apply errors to each data byte in the file.  For instance, a 
 probability of 0.02 means that each byte has a 2% chance of having an error.
@@ -148,6 +152,30 @@ B<Editcap> can write the file in several formats, B<editcap -F>
 provides a list of the available output formats. The default
 is the B<libpcap> format.
 
+=item -W  E<lt>file format optionE<gt>
+
+Save extra information in the file if the format supports it. For
+example,
+
+  -F pcapng -W n
+
+will save host name resolution records along with captured packets.
+
+Future versions of Wireshark may automatically change the capture format to
+B<pcapng> as needed.
+
+The argument is a string that may contain the following letter:
+
+B<n> write network address resolution information (pcapng only)
+
+=item -H  E<lt>input "hosts" fileE<gt>
+
+Read a list of address to host name mappings and include the result in
+the output file. Implies B<-W n>.
+
+The input file format is described at
+L<http://en.wikipedia.org/wiki/Hosts_%28file%29>.
+
 =item -A  E<lt>start timeE<gt>
 
 Saves only the packets whose timestamp is on or after start time.
@@ -155,7 +183,7 @@ The time is given in the following format YYYY-MM-DD HH:MM:SS
 
 =item -B  E<lt>stop timeE<gt>
 
-Saves only the packets whose timestamp is on or before stop time.
+Saves only the packets whose timestamp is before stop time.
 The time is given in the following format YYYY-MM-DD HH:MM:SS
 
 =item -h