Add some info about extended value string to section 1.7.1
[obnox/wireshark/wip.git] / doc / text2pcap.pod
index 92983d4662273a76d0fbb0d7d91093c7b8d79d5b..ab31f1ed04fedcc30f221f97e1ab02c1afd50022 100644 (file)
@@ -3,13 +3,13 @@
 
 text2pcap - Generate a capture file from an ASCII hexdump of packets
 
-=head1 SYNOPSYS
+=head1 SYNOPSIS
 
 B<text2pcap>
 S<[ B<-h> ]>
 S<[ B<-d> ]>
 S<[ B<-q> ]>
-S<[ B<-o> hex|oct ]>
+S<[ B<-o> hex|oct|dec ]>
 S<[ B<-l> E<lt>typenumE<gt> ]>
 S<[ B<-e> E<lt>l3pidE<gt> ]>
 S<[ B<-i> E<lt>protoE<gt> ]>
@@ -31,12 +31,12 @@ multiple packets.  B<text2pcap> is also capable of generating dummy
 Ethernet, IP and UDP, TCP, or SCTP headers, in order to build fully
 processable packet dumps from hexdumps of application-level data only.
 
-B<Text2pcap> understands a hexdump of the form generated by I<od -Ax -tx1>.
+B<Text2pcap> understands a hexdump of the form generated by I<od -Ax -tx1 -v>.
 In other words, each byte is individually displayed and
 surrounded with a space. Each line begins with an offset describing
 the position in the file. The offset is a hex number (can also be
-octal - see B<-o>), of more than two hex digits. Here is a sample dump
-that B<text2pcap> can recognize:
+octal or decimal - see B<-o>), of more than two hex digits.
+Here is a sample dump that B<text2pcap> can recognize:
 
     000000 00 e0 1e a7 05 6f 00 10 ........
     000008 5a a0 b9 12 08 00 46 00 ........
@@ -97,9 +97,9 @@ multiple times to generate more debugging information.
 
 Be completely quiet during the process.
 
-=item -o hex|oct
+=item -o hex|oct|dec
 
-Specify the radix for the offsets (hex or octal). Defaults to
+Specify the radix for the offsets (hex, octal or decimal). Defaults to
 hex. This corresponds to the C<-A> option for I<od>.
 
 =item -l
@@ -128,9 +128,9 @@ sort of L3 packet.
 Include dummy IP headers before each packet. Specify the IP protocol
 for the packet in decimal. Use this option if your dump is the payload
 of an IP packet (i.e. has complete L4 information) but does not have
-an IP header. Note that this automatically includes an appropriate
-Ethernet header as well. Example: I<-i 46> to specify an RSVP packet
-(IP protocol 46).
+an IP header with each packet. Note that an appropriate Ethernet header
+is automatically included with each packet as well. 
+Example: I<-i 46> to specify an RSVP packet (IP protocol 46).
 
 =item -m E<lt>max-packetE<gt>
 
@@ -148,26 +148,26 @@ TCP packets.
 Include dummy UDP headers before each packet. Specify the source and
 destination UDP ports for the packet in decimal. Use this option if
 your dump is the UDP payload of a packet but does not include any UDP,
-IP or Ethernet headers. Note that this automatically includes
-appropriate Ethernet and IP headers with each packet. Example: I<-u
-1000,69> to make the packets look like TFTP/UDP packets.
+IP or Ethernet headers. Note that appropriate Ethernet and IP headers 
+are automatically also included with each packet. 
+Example: I<-u1000,69> to make the packets look like TFTP/UDP packets.
 
 =item -T E<lt>srcportE<gt>,E<lt>destportE<gt>
 
 Include dummy TCP headers before each packet. Specify the source and
 destination TCP ports for the packet in decimal. Use this option if
 your dump is the TCP payload of a packet but does not include any TCP,
-IP or Ethernet headers. Note that this automatically includes
-appropriate Ethernet and IP headers with each packet.
-Sequence numbers will start a 0.
+IP or Ethernet headers. Note that appropriate Ethernet and IP headers 
+are automatically also included with each packet.
+Sequence numbers will start at 0.
 
 =item -s E<lt>srcportE<gt>,E<lt>destportE<gt>,E<lt>tagE<gt>
 
 Include dummy SCTP headers before each packet.  Specify, in decimal, the
 source and destination SCTP ports, and verification tag, for the packet. 
 Use this option if your dump is the SCTP payload of a packet but does
-not include any SCTP, IP or Ethernet headers.  Note that this
-automatically includes appropriate Ethernet and IP headers with each
+not include any SCTP, IP or Ethernet headers.  Note that appropriate 
+Ethernet and IP headers are automatically also included with each
 packet.  A CRC32C checksum will be put into the SCTP header.
 
 =item -S E<lt>srcportE<gt>,E<lt>destportE<gt>,E<lt>ppiE<gt>
@@ -177,8 +177,8 @@ source and destination SCTP ports, and a verification tag of 0, for the
 packet, and prepend a dummy SCTP DATA chunk header with a payload
 protocol identifier if I<ppi>.  Use this option if your dump is the SCTP
 payload of a packet but does not include any SCTP, IP or Ethernet
-headers.  Note that this automatically includes appropriate Ethernet and
-IP headers with each packet.  A CRC32C checksum will be put into the
+headers.  Note that appropriate Ethernet and IP headers are 
+automatcally included with each packet.  A CRC32C checksum will be put into the
 SCTP header.
 
 =item -t E<lt>timefmtE<gt>
@@ -191,6 +191,9 @@ B<NOTE:> The subsecond component delimiter must be specified (.) but no
 pattern is required; the remaining number is assumed to be fractions of
 a second.
 
+B<NOTE:> Date/time fields from the current date/time are
+used as the default for unspecified fields.
+
 =back
 
 =head1 SEE ALSO