diff --git a/doc/editcap.pod b/doc/editcap.pod index 22870bd685..99cf40ae13 100644 --- a/doc/editcap.pod +++ b/doc/editcap.pod @@ -6,15 +6,15 @@ editcap - Edit and/or translate the format of capture files =head1 SYNOPSYS B -S<[ B<-c> packets per file]> -S<[ B<-C> choplen ]> -S<[ B<-E> error probability]> -S<[ B<-F> file format ]> +S<[ B<-c> Epackets per fileE ]> +S<[ B<-C> EchoplenE ]> +S<[ B<-E> Eerror probabilityE ]> +S<[ B<-F> Efile formatE ]> S<[ B<-h> ]> S<[ B<-r> ]> -S<[ B<-s> snaplen ]> -S<[ B<-t> time adjustment ]> -S<[ B<-T> encapsulation type ]> +S<[ B<-s> EsnaplenE ]> +S<[ B<-t> Etime adjustmentE ]> +S<[ B<-T> Eencapsulation typeE ]> S<[ B<-v> ]> I I @@ -42,14 +42,14 @@ The supported input and output capture file formats are described in a section b =over 4 -=item -c packets per file +=item -c Epackets per fileE Sets the maximum number of packets per output file. Each output file will be created with a suffix -nnnnn, starting with 00000. If the specified number of packets are written to the output file, the next output file is -opened. +opened. The default is to use a single output file. -=item -C choplen +=item -C EchoplenE Sets the chop length to use when writing the packet data. Each packet is chopped at the packet end by a few bytes of data. @@ -57,7 +57,7 @@ Each packet is chopped at the packet end by a few bytes of data. This is useful in the rare case that the conversion between two file formats leaves some random bytes at the end of each packet. -=item -E error probability +=item -E Eerror probabilityE Sets the probabilty that bytes in the output file are randomly changed. B uses that probability (between 0.0 and 1.0 inclusive) @@ -66,11 +66,12 @@ probability of 0.02 means that each byte has a 2% chance of having an error. This option is meant to be used for fuzz-testing protocol dissectors. -=item -F file format +=item -F Efile formatE Sets the file format of the output capture file. -B can write the file in several formats, B -provides a complete list of the available output formats. +B can write the file in several formats, B +provides a list of the available output formats. The default +is the B format. =item -h @@ -82,7 +83,7 @@ Reverse the packet selection. Causes the packets whose packet numbers are specified on the command line to be written to the output capture file, instead of discarding them. -=item -s snaplen +=item -s EsnaplenE Sets the snapshot length to use when writing the data. If the B<-s> flag is used to specify a snapshot length, packets in the @@ -97,7 +98,7 @@ appear to reject Ethernet packets larger than the standard Ethernet MTU, making them incapable of handling gigabit Ethernet captures if jumbo packets were used). -=item -t time adjustment +=item -t Etime adjustmentE Sets the time adjustment to use on selected packets. If the B<-t> flag is used to specify a time adjustment, the specified @@ -111,13 +112,15 @@ This feature is useful when synchronizing dumps collected on different machines where the time difference between the two machines is known or can be estimated. -=item -T encapsulation type +=item -T Eencapsulation typeE Sets the packet encapsulation type of the output capture file. If the B<-T> flag is used to specify an encapsulation type, the encapsulation type of the output capture file will be forced to the -specified type, rather than being the type appropriate to the -encapsulation type of the input capture file. +specified type. +B provides a list of the available types. The default +type is the one appropriate to the encapsulation type of the input +capture file. Note: this merely forces the encapsulation type of the output file to be the specified @@ -266,7 +269,7 @@ Linux Bluez Bluetooth stack B traces B can write the file in several output formats. The B<-F> flag can be used to specify the format in which to write the capture -file, B provides +file, B provides a list of the available output formats. =head1 SEE ALSO