aboutsummaryrefslogtreecommitdiffstats
path: root/docbook/wsug_src/WSUG_chapter_io.adoc
diff options
context:
space:
mode:
authorJohn Thacker <johnthacker@gmail.com>2022-02-22 07:32:01 -0500
committerA Wireshark GitLab Utility <gerald+gitlab-utility@wireshark.org>2022-02-23 02:58:31 +0000
commit1d84a092cfeb0d14a970ed2f79f77547126db706 (patch)
treec190155922dc65bb26313bbd8021dba87cdd8fd3 /docbook/wsug_src/WSUG_chapter_io.adoc
parent0e427ac837b20f37774514b270674eeb29fccd68 (diff)
doc: Update text2pcap and Import from Hexdump doc
Update the text2pcap man page and the Import from Hexdump WSUG page to clarify how to use it, for grammar, and to remove a few things that are no longer relevant. (E.g., it's no longer the case that files without an EOL don't work.) Fix #15563, #15564.
Diffstat (limited to 'docbook/wsug_src/WSUG_chapter_io.adoc')
-rw-r--r--docbook/wsug_src/WSUG_chapter_io.adoc77
1 files changed, 45 insertions, 32 deletions
diff --git a/docbook/wsug_src/WSUG_chapter_io.adoc b/docbook/wsug_src/WSUG_chapter_io.adoc
index e2e0e66ca7..cc7e5ebbe0 100644
--- a/docbook/wsug_src/WSUG_chapter_io.adoc
+++ b/docbook/wsug_src/WSUG_chapter_io.adoc
@@ -436,15 +436,53 @@ Two methods for converting the input are supported:
==== Standard ASCII Hexdumps
-Wireshark understands a hexdump of the form generated by `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 packet, each
-new packet starts with an offset of 0 and there is a space separating the
-offset from the following bytes. The offset is a hex number (can also be octal
-or decimal), of more than two hex digits.
-Here is a sample dump that can be imported:
+Wireshark understands a hexdump of the form generated by `od -Ax -tx1 -v`.
+In other words, each byte is individually displayed, with spaces separating
+the bytes from each other. Hex digits can be upper or lowercase.
+
+In normal operation, each line must begin with an offset describing the
+position in the packet, followed a colon, space, or tab separating it from
+the bytes. There is no limit on the width or number of bytes per line, but
+lines with only hex bytes without a leading offset are ignored (i.e.,
+line breaks should not be inserted in long lines that wrap.) Offsets are more
+than two digits; they are in hex by default, but can also be in octal or
+decimal. Each packet must begin with offset zero, and an offset
+zero indicates the beginning of a new packet. Offset values must be correct;
+an unexpected value causes the current packet to be aborted and the next
+packet start awaited. There is also a single packet mode with no offsets.
+
+Packets may be preceded by a direction indicator ('I' or 'O') and/or a
+timestamp if indicated. If both are present, the direction indicator precedes
+the timestamp. The format of the timestamps must be specified. If no timestamp
+is parsed, in the case of the first packet the current system time is used,
+while subsequent packets are written with timestamps one microsecond later than
+that of the previous packet.
+
+Other text in the input data is ignored. Any text before the offset is
+ignored, including email forwarding characters '>'. Any text on a line
+after the bytes is ignored, e.g. an ASCII character dump (but see *-a* to
+ensure that hex digits in the character dump are ignored). Any line where
+the first non-whitespace character is a '#' will be ignored as a comment.
+Any lines of text between the bytestring lines are considered preamble;
+the beginning of the preamble is scanned for the direction indicator and
+timestamp as mentioned above and otherwise ignored.
+
+Any line beginning with #TEXT2PCAP is a directive and options
+can be inserted after this command to be processed by Wireshark.
+Currently there are no directives implemented; in the future, these may
+be used to give more fine grained control on the dump and the way it
+should be processed e.g. timestamps, encapsulation type etc.
+
+In general, short of these restrictions, Wireshark is pretty liberal
+about reading in hexdumps and has been tested with a variety of
+mangled outputs (including being forwarded through email multiple
+times, with limited line wrap etc.)
+
+Here is a sample dump that can be imported, including optional
+directional indicator and timestamp:
----
+I 2019-05-14T19:04:57Z
000000 00 e0 1e a7 05 6f 00 10 ........
000008 5a a0 b9 12 08 00 46 00 ........
000010 03 68 00 00 00 00 0a 2e ........
@@ -454,31 +492,6 @@ Here is a sample dump that can be imported:
000030 01 01 0f 19 03 80 11 01 ........
----
-There is no limit on the width or number of bytes per line. Also the text dump
-at the end of the line is ignored. Byte and hex numbers can be uppercase or
-lowercase. Any text before the offset is ignored, including email forwarding
-characters _>_. Any lines of text between the bytestring lines are ignored.
-The offsets are used to track the bytes, so offsets must be correct. Any line
-which has only bytes without a leading offset is ignored. An offset is
-recognized as being a hex number longer than two characters. Any text after the
-bytes is ignored (e.g. the character dump). Any hex numbers in this text are
-also ignored. An offset of zero is indicative of starting a new packet, so a
-single text file with a series of hexdumps can be converted into a packet
-capture with multiple packets. Packets may be preceded by a timestamp. These are
-interpreted according to the format given. If not the first packet is
-timestamped with the current time the import takes place. Multiple packets are
-written with timestamps differing by one nanosecond each. In general, short of
-these restrictions, Wireshark is pretty liberal about reading in hexdumps and
-has been tested with a variety of mangled outputs (including being forwarded
-through email multiple times, with limited line wrap etc.)
-
-There are a couple of other special features to note. Any line where the first
-non-whitespace character is `#` will be ignored as a comment. Any line beginning
-with `#TEXT2PCAP` is a directive and options can be inserted after this command to
-be processed by Wireshark. Currently there are no directives implemented. In the
-future these may be used to give more fine grained control on the dump and the
-way it should be processed e.g. timestamps, encapsulation type etc.
-
==== Regular Text Dumps
Wireshark is also capable of scanning the input using a custom perl regular