Fix the usage message and man page for text2pcap.
[obnox/wireshark/wip.git] / doc / text2pcap.pod
1
2 =head1 NAME
3
4 text2pcap - Generate a capture file from an ASCII hexdump of packets
5
6 =head1 SYNOPSYS
7
8 B<text2pcap>
9 S<[ B<-d> ]>
10 S<[ B<-q> ]>
11 S<[ B<-o> hex|oct ]>
12 S<[ B<-l> typenum ]>
13 S<[ B<-e> l3pid ]>
14 S<[ B<-i> proto ]>
15 S<[ B<-u> srcport,destport ]>
16 S<[ B<-t> timefmt ]>
17 I<infile>
18 I<outfile>
19
20 =head1 DESCRIPTION
21
22 B<Text2pcap> is a program that reads in an ASCII hex dump and writes
23 the data described into a B<libpcap>-style capture file. B<text2pcap>
24 can read hexdumps with multiple packets in them, and build a capture
25 file of multiple packets. B<text2pcap> is also capable of generating
26 dummy Ethernet, IP and UDP headers, in order to build fully
27 processable packet dumps from hexdumps of application-level data
28 only. 
29
30 B<Text2pcap> understands a hexdump of the form generated by I<od -t
31 x1>. In other words, each byte is individually displayed and
32 surrounded with a space. Each line begins with an offset describing
33 the position in the file. The offset is a hex number (can also be
34 octal - see B<-o>), of more than two hex digits. Here is a sample dump
35 that B<text2pcap> can recognize:
36
37     000000 00 e0 1e a7 05 6f 00 10 ........
38     000008 5a a0 b9 12 08 00 46 00 ........
39     000010 03 68 00 00 00 00 0a 2e ........
40     000018 ee 33 0f 19 08 7f 0f 19 ........
41     000020 03 80 94 04 00 00 10 01 ........
42     000028 16 a2 0a 00 03 50 00 0c ........
43     000030 01 01 0f 19 03 80 11 01 ........
44
45 There is no limit on the width or number of bytes per line. Also the
46 text dump at the end of the line is ignored. Bytes/hex numbers can be
47 uppercase or lowercase. Any text before the offset is ignored,
48 including email forwarding characters '>'. Any lines of text between
49 the bytestring lines is ignored. The offsets are used to track the
50 bytes, so offsets must be correct. Any line which has only bytes
51 without a leading offset is ignored. An offset is recognized as being
52 a hex number longer than two characters. Any text after the bytes is
53 ignored (e.g. the character dump). Any hex numbers in this text are
54 also ignored. An offset of zero is indicative of starting a new
55 packet, so a single text file with a series of hexdumps can be
56 converted into a packet capture with multiple packets. Multiple
57 packets are read in with timestamps differing by one second each. In
58 general, short of these restrictions, B<text2pcap> is pretty liberal
59 about reading in hexdumps and has been tested with a variety of
60 mangled outputs (including being forwarded through email multiple
61 times, with limited line wrap etc.)
62
63 There are a couple of other special features to note. Any line where
64 the first non-whitespace character is '#' will be ignored as a
65 comment. Any line beginning with #TEXT2PCAP is a directive and options
66 can be inserted after this command to be processed by
67 B<text2pcap>. Currently there are no directives implemented; in the
68 future, these may be used to give more fine grained control on the
69 dump and the way it should be processed e.g. timestamps, encapsulation
70 type etc.
71
72 B<Text2pcap> also allows the user to read in dumps of
73 application-level data, by inserting dummy L2, L3 and L4 headers
74 before each packet. The user can elect to insert Ethernet headers,
75 Ethernet and IP, or Ethernet, IP and UDP headers before each
76 packet. This allows Ethereal or any other full-packet decoder to
77 handle these dumps.
78
79 =head1 OPTIONS
80
81 =over 4
82
83 =item -d
84
85 Displays debugging information during the process. Can be used
86 multiple times to generate more debugging information.
87
88 =item -q
89
90 Be completely quiet during the process.
91
92 =item -o hex|oct
93
94 Specify the radix for the offsets (hex or octal). Defaults to
95 hex. This corresponds to the C<-A> option for I<od>.
96
97 =item -l
98
99 Specify the link-layer type of this packet. Default is Ethernet
100 (1). See I<net/bpf.h> for the complete list of possible
101 encapsulations. Note that this option should be used if your dump is a
102 complete hex dump of an encapsulated packet and you wish to specify
103 the exact type of encapsulation. Example: I<-l 7> for ARCNet packets.
104
105 =item -e l3pid
106
107 Include a dummy Ethernet header before each packet. Specify the L3PID
108 for the Ethernet header in hex. Use this option if your dump has Layer
109 3 header and payload (e.g. IP header), but no Layer 2
110 encapsulation. Example: I<-e 0x806> to specify an ARP packet. 
111
112 For IP packets, instead of generating a fake Ethernet header you can
113 also use I<-l 12> to indicate a raw IP packet to Ethereal. Note that
114 I<-l 12> does not work for any non-IP Layer 3 packet (e.g. ARP),
115 whereas generating a dummy Ethernet header with I<-e> works for any
116 sort of L3 packet.
117
118 =item -i proto
119
120 Include dummy IP headers before each packet. Specify the IP protocol
121 for the packet in decimal. Use this option if your dump is the payload
122 of an IP packet (i.e. has complete L4 information) but does not have
123 an IP header. Note that this automatically includes an appropriate
124 Ethernet header as well. Example: I<-i 46> to specify an RSVP packet
125 (IP protocol 46).
126
127 =item -u srcport,destport
128
129 Include dummy UDP headers before each packet. Specify the source and
130 destination UDP ports for the packet in decimal. Use this option if
131 your dump is the UDP payload of a packet but does not include any UDP,
132 IP or Ethernet headers. Note that this automatically includes
133 appropriate Ethernet and IP headers with each packet. Example: I<-u
134 1000,69> to make the packets look like TFTP/UDP packets.
135
136 =item -t timefmt
137
138 Treats the text before the packet as a date/time code; I<timefmt> is a
139 format string of the sort supported by B<strptime(3)>.
140 Example: The time "10:15:14.5476" has the format code "%H:%M:%S."
141
142 B<NOTE:> The subsecond component delimiter must be specified (.) but no
143 pattern is required; the remaining number is assumed to be fractions of
144 a second.
145
146 =head1 SEE ALSO
147
148 L<tcpdump(8)>, L<pcap(3)>, L<ethereal(1)>, L<editcap(1)>, L<strptime(3)>.
149
150 =head1 NOTES
151
152 B<Text2pcap> is part of the B<Ethereal> distribution.  The latest version
153 of B<Ethereal> can be found at B<http://www.ethereal.com>.
154
155 =head1 AUTHORS
156
157   Ashok Narayanan          <ashokn@cisco.com>