aboutsummaryrefslogtreecommitdiffstats
path: root/docbook
diff options
context:
space:
mode:
authorGerald Combs <gerald@wireshark.org>2019-12-08 09:37:09 -0800
committerAnders Broman <a.broman58@gmail.com>2019-12-09 05:09:18 +0000
commitf5705e91186ed087f34f4ec7fc6e1c30d3ffbe33 (patch)
treebe75feae9b77a628afe3b4c85775708a6210848e /docbook
parentc8dd7eed99582126a8df8b4a2582361fb705eeb1 (diff)
WSUG: Export, packet range+format, and other IO chapter updates.
Add an "Export Specified Packets" section. Update the "Export Packet Dissections," "Packet Range," and "Packet Format" sections. Update some markup and text throughout the chapter. Change-Id: I7b7c6fcc41c4fdc684c86a34364ed9baa5123d15 Reviewed-on: https://code.wireshark.org/review/35359 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
Diffstat (limited to 'docbook')
-rw-r--r--docbook/CMakeLists.txt10
-rw-r--r--docbook/attributes.adoc2
-rw-r--r--docbook/wsug_graphics/ws-export-packet-dissections.pngbin0 -> 24546 bytes
-rw-r--r--docbook/wsug_graphics/ws-export-pdml.pngbin28709 -> 0 bytes
-rw-r--r--docbook/wsug_graphics/ws-export-plain.pngbin57116 -> 0 bytes
-rw-r--r--docbook/wsug_graphics/ws-export-ps.pngbin28832 -> 0 bytes
-rw-r--r--docbook/wsug_graphics/ws-export-psml.pngbin28742 -> 0 bytes
-rw-r--r--docbook/wsug_graphics/ws-export-specified-packets.pngbin0 -> 38066 bytes
-rw-r--r--docbook/wsug_graphics/ws-packet-format.pngbin1672 -> 2207 bytes
-rw-r--r--docbook/wsug_graphics/ws-packet-range.pngbin4322 -> 3354 bytes
-rw-r--r--docbook/wsug_src/WSUG_chapter_io.adoc439
11 files changed, 275 insertions, 176 deletions
diff --git a/docbook/CMakeLists.txt b/docbook/CMakeLists.txt
index 68276e30dd..e15d42eaca 100644
--- a/docbook/CMakeLists.txt
+++ b/docbook/CMakeLists.txt
@@ -143,10 +143,8 @@ set(WSUG_GRAPHICS
wsug_graphics/ws-expert-column.png
wsug_graphics/ws-expert-infos.png # Outdated
wsug_graphics/ws-export-objects.png
- wsug_graphics/ws-export-pdml.png
- wsug_graphics/ws-export-plain.png
- wsug_graphics/ws-export-ps.png
- wsug_graphics/ws-export-psml.png
+ wsug_graphics/ws-export-packet-dissections.png
+ wsug_graphics/ws-export-specified-packets.png
wsug_graphics/ws-export-selected.png
wsug_graphics/ws-file-import.png
wsug_graphics/ws-file-menu.png
@@ -180,9 +178,9 @@ set(WSUG_GRAPHICS
wsug_graphics/ws-merge-win32.png
wsug_graphics/ws-open-qt5.png
wsug_graphics/ws-open-win32.png
- wsug_graphics/ws-packet-format.png # Outdated
+ wsug_graphics/ws-packet-format.png
wsug_graphics/ws-packet-pane-popup-menu.png
- wsug_graphics/ws-packet-range.png # Outdated
+ wsug_graphics/ws-packet-range.png
wsug_graphics/ws-packet-selected.png
wsug_graphics/ws-packet-sep-win.png
wsug_graphics/ws-print.png
diff --git a/docbook/attributes.adoc b/docbook/attributes.adoc
index 615d25f136..34089fb796 100644
--- a/docbook/attributes.adoc
+++ b/docbook/attributes.adoc
@@ -86,4 +86,4 @@
:multiplication: ×
:cmd: ⌘
-:missing: Not yet written. See https://wiki.wireshark.org/Development/SubmittingPatches
+:missing: Not yet written. See https://wiki.wireshark.org/Development/SubmittingPatches.
diff --git a/docbook/wsug_graphics/ws-export-packet-dissections.png b/docbook/wsug_graphics/ws-export-packet-dissections.png
new file mode 100644
index 0000000000..4be7c958c2
--- /dev/null
+++ b/docbook/wsug_graphics/ws-export-packet-dissections.png
Binary files differ
diff --git a/docbook/wsug_graphics/ws-export-pdml.png b/docbook/wsug_graphics/ws-export-pdml.png
deleted file mode 100644
index 5d0b58ada6..0000000000
--- a/docbook/wsug_graphics/ws-export-pdml.png
+++ /dev/null
Binary files differ
diff --git a/docbook/wsug_graphics/ws-export-plain.png b/docbook/wsug_graphics/ws-export-plain.png
deleted file mode 100644
index 8735515afa..0000000000
--- a/docbook/wsug_graphics/ws-export-plain.png
+++ /dev/null
Binary files differ
diff --git a/docbook/wsug_graphics/ws-export-ps.png b/docbook/wsug_graphics/ws-export-ps.png
deleted file mode 100644
index b9637a73fd..0000000000
--- a/docbook/wsug_graphics/ws-export-ps.png
+++ /dev/null
Binary files differ
diff --git a/docbook/wsug_graphics/ws-export-psml.png b/docbook/wsug_graphics/ws-export-psml.png
deleted file mode 100644
index 320ad6cac6..0000000000
--- a/docbook/wsug_graphics/ws-export-psml.png
+++ /dev/null
Binary files differ
diff --git a/docbook/wsug_graphics/ws-export-specified-packets.png b/docbook/wsug_graphics/ws-export-specified-packets.png
new file mode 100644
index 0000000000..e8bb8aef59
--- /dev/null
+++ b/docbook/wsug_graphics/ws-export-specified-packets.png
Binary files differ
diff --git a/docbook/wsug_graphics/ws-packet-format.png b/docbook/wsug_graphics/ws-packet-format.png
index a3f243200b..c8b50c0b16 100644
--- a/docbook/wsug_graphics/ws-packet-format.png
+++ b/docbook/wsug_graphics/ws-packet-format.png
Binary files differ
diff --git a/docbook/wsug_graphics/ws-packet-range.png b/docbook/wsug_graphics/ws-packet-range.png
index 9261afea63..a35a008a92 100644
--- a/docbook/wsug_graphics/ws-packet-range.png
+++ b/docbook/wsug_graphics/ws-packet-range.png
Binary files differ
diff --git a/docbook/wsug_src/WSUG_chapter_io.adoc b/docbook/wsug_src/WSUG_chapter_io.adoc
index 8800364c96..35b52677ae 100644
--- a/docbook/wsug_src/WSUG_chapter_io.adoc
+++ b/docbook/wsug_src/WSUG_chapter_io.adoc
@@ -12,7 +12,7 @@ This chapter will describe input and output of capture data.
* Open capture files in various capture file formats
-* Save/Export capture files in various capture file formats
+* Save and export capture files in various formats
* Merge capture files together
@@ -243,7 +243,7 @@ If you don’t provide a file extension to the filename (e.g. `.pcap`) Wireshark
You can convert capture files from one format to another by opening a capture and saving it as a different format.
====
-If you wish to save some of the packets in your capture file you can do so via menu:File[Export Specified Packets...]
+If you wish to save some of the packets in your capture file you can do so via <<ChIOExportSpecifiedPacketsDialog>>.
[[ChIOOutputFormatsSection]]
@@ -430,7 +430,7 @@ data, to be imported and set import parameters.
[[ChIOFileImportDialog]]
.The “Import from Hex Dump” dialog
-image::wsug_graphics/ws-file-import.png[{screenshot-attrs}]
+image::wsug_graphics/ws-file-import.png[{medium-screenshot-attrs}]
Specific controls of this import dialog are split in two sections:
@@ -538,19 +538,23 @@ with file sets in a convenient way:
==== The “List Files” Dialog Box
.The “List Files” dialog box
-image::wsug_graphics/ws-file-set-dialog.png[{screenshot-attrs}]
+image::wsug_graphics/ws-file-set-dialog.png[{medium-screenshot-attrs}]
Each line contains information about a file of the file set:
-* _Filename_ the name of the file. If you click on the filename (or the radio
- button left to it), the current file will be closed and the corresponding
- capture file will be opened.
+Filename::
+The name of the file. If you click on the filename (or the radio
+button left to it), the current file will be closed and the corresponding
+capture file will be opened.
-* _Created_ the creation time of the file
+Created::
+The creation time of the file.
-* _Last Modified_ the last time the file was modified
+Last Modified::
+The last time the file was modified.
-* _Size_ the size of the file
+Size::
+The size of the file.
The last line will contain info about the currently used directory where all of
the files in the file set can be found.
@@ -562,29 +566,76 @@ The btn:[Close] button will, well, close the dialog box.
[[ChIOExportSection]]
+// - Add {missing} for other exports?
+
=== Exporting Data
-Wireshark provides several ways and formats to export packet data. This section
-describes general ways to export data from the main Wireshark application. There
-are more specialized functions to export specific data which are described
-elsewhere.
+Wireshark provides a variety of options for exporting packet data.
+This section describes general ways to export data from the main Wireshark application.
+There are many other ways to export or extract data from capture files, including processing <<AppToolstshark,tshark>> output and customizing Wireshark and tshark using Lua scripts.
+
+[[ChIOExportSpecifiedPacketsDialog]]
+
+==== The “Export Specified Packets” Dialog Box
+
+.The “Export Specified Packets” dialog box
+image::wsug_graphics/ws-export-specified-packets.png[{medium-screenshot-attrs}]
-// XXX - add detailed descriptions of the output formats and some sample output, too.
+This is similar to the “<<ChIOSaveAs,Save>>” dialog box, but it lets you save specific packets.
+This can be useful for trimming irrelevant or unwanted packets from a capture file.
+See <<ChIOPacketRangeSection,Packet Range>> for details on the range controls.
-// XXX Most of this content is no longer relevant in the current GTK+ UI, much less Qt.
+[[ChIOExportPacketDissectionsDialog]]
-[[ChIOExportPlainDialog]]
+==== The “Export Packet Dissections” Dialog Box
-==== The “Export As Plain Text File” Dialog Box
+This lets you save the packet list, packet details, and packet bytes as plain text, CSV, JSON, and other formats.
-[[ChIOExportPlain]]
+.The “Export Packet Dissections” dialog box
+image::wsug_graphics/ws-export-packet-dissections.png[{medium-screenshot-attrs}]
+
+The format can be selected from the “Export As” dopdown and further customized using the “<<ChIOPacketRangeSection,Packet Range>>” and “<<ChIOPacketRangeSection,Packet Format>>” controls.
+Some controls are unavailable for some formats, notably CSV and JSON.
+The following formats are supported:
+
+* Plain text as shown in the main window
+* link:{wikipedia-main-url}Comma-separated_values[Comma-separated values (CSV)]
+* link:{wikipedia-main-url}C_(programming_language)[C-compatible] byte arrays
+* link:https://web.archive.org/web/20141115200425/http://www.nbee.org/doku.php?id=netpdl:psml_specification[PSML] (summary XML)
+* link:https://web.archive.org/web/20140416072301/http://www.nbee.org/doku.php?id=netpdl:pdml_specification[PDML] (detailed XML)
+* link:{wikipedia-main-url}JSON[JavaScript Object Notation (JSON)]
+
+Here are some examples of exported data:
+
+.Plain text
+----
+No. Time Source Destination Protocol Length SSID Info
+ 1 0.000000 200.121.1.131 172.16.0.122 TCP 1454 10554 → 80 [ACK] Seq=1 Ack=1 Win=65535 Len=1400 [TCP segment of a reassembled PDU]
+
+Frame 1: 1454 bytes on wire (11632 bits), 1454 bytes captured (11632 bits)
+Ethernet II, Src: 00:50:56:c0:00:01, Dst: 00:0c:29:42:12:13
+Internet Protocol Version 4, Src: 200.121.1.131 (200.121.1.131), Dst: 172.16.0.122 (172.16.0.122)
+ 0100 .... = Version: 4
+ .... 0101 = Header Length: 20 bytes (5)
+ Differentiated Services Field: 0x00 (DSCP: CS0, ECN: Not-ECT)
+ Total Length: 1440
+ Identification: 0x0141 (321)
+ Flags: 0x0000
+ ...0 0000 0000 0000 = Fragment offset: 0
+ Time to live: 106
+ Protocol: TCP (6)
+ Header checksum: 0xd390 [validation disabled]
+ [Header checksum status: Unverified]
+ Source: 200.121.1.131 (200.121.1.131)
+ Destination: 172.16.0.122 (172.16.0.122)
+ [Source GeoIP: PE, ASN 6147, Telefonica del Peru S.A.A.]
+Transmission Control Protocol, Src Port: 10554, Dst Port: 80, Seq: 1, Ack: 1, Len: 1400
+----
-Export packet data into a plain ASCII text file, much like the format used to print packets.
[TIP]
====
-If you would like to be able to import any previously exported packets from a
-plain text file it is recommended that you:
+If you would like to be able to <<ChIOImportSection,import>> any previously exported packets from a plain text file it is recommended that you do the following:
* Add the “Absolute date and time” column.
@@ -603,119 +654,152 @@ plain text file it is recommended that you:
* Include the packet bytes.
====
-.The “Export as Plain Text File” dialog box
-image::wsug_graphics/ws-export-plain.png[{screenshot-attrs}]
-
-* The “Export to file:” frame chooses the file to export the packet data to.
-
-* The “Packet Range” frame is described in <<ChIOPacketRangeSection>>.
-
-* The “Packet Details” frame is described in <<ChIOPacketFormatSection>>.
-
-[[ChIOExportPSDialog]]
-
-==== The “Export As PostScript File” Dialog Box
-
-.The “Export as PostScript File” dialog box
-image::wsug_graphics/ws-export-ps.png[{screenshot-attrs}]
-
-* _Export to file:_ frame chooses the file to export the packet data to.
-
-* The _Packet Range_ frame is described in <<ChIOPacketRangeSection>>.
-
-* The _Packet Details_ frame is described in <<ChIOPacketFormatSection>>.
-
-[[ChIOExportCSVDialog]]
-
-==== The “Export As CSV (Comma Separated Values) File” Dialog Box
-
-// XXX - add screenshot
-
-Export packet summary into CSV, used e.g. by spreadsheet programs to im-/export data.
-
-//<!--<figure>
-// <title>The “Export as Comma Separated Values File” dialog box</title>
-// <graphic entityref="WiresharkExportCSVDialog" format="PNG"/>
-// </figure>-->
-
-* _Export to file:_ frame chooses the file to export the packet data to.
-
-* The _Packet Range_ frame is described in <<ChIOPacketRangeSection>>.
-
-[[ChIOExportCArraysDialog]]
-
-==== The “Export As C Arrays (Packet Bytes) file” Dialog Box
-
-// XXX - add screenshot
-
-Export packet bytes into C arrays so you can import the stream data into your own C program.
-
-// <figure>
-// <title>The “Export as C Arrays (packet bytes) file” dialog box</title>
-// <graphic entityref="WiresharkExportCArraysDialog" format="PNG"/>
-// </figure>
-
-* _Export to file:_ frame chooses the file to export the packet data to.
-
-* The _Packet Range_ frame is described in <<ChIOPacketRangeSection>>.
-
-[[ChIOExportPSMLDialog]]
-
-==== The “Export As PSML File” Dialog Box
-
-Export packet data into PSML. This is an XML based format including only the
-packet summary. The PSML file specification is available at:
-https://web.archive.org/web/20141115200425/http://www.nbee.org/doku.php?id=netpdl:psml_specification[].
-
-.The “Export as PSML File” dialog box
-image::wsug_graphics/ws-export-psml.png[{screenshot-attrs}]
-
-* _Export to file:_ frame chooses the file to export the packet data to.
-
-* The _Packet Range_ frame is described in <<ChIOPacketRangeSection>>.
-
-There’s no such thing as a packet details frame for PSML export, as the packet
-format is defined by the PSML specification.
-
-[[ChIOExportPDMLDialog]]
-
-==== The “Export As PDML File” Dialog Box
+.CSV
+----
+"No.","Time","Source","Destination","Protocol","Length","SSID","Info","Win Size"
+"1","0.000000","200.121.1.131","172.16.0.122","TCP","1454","","10554 > 80 [ACK] Seq=1 Ack=1 Win=65535 Len=1400 [TCP segment of a reassembled PDU]","65535"
+"2","0.000011","172.16.0.122","200.121.1.131","TCP","54","","[TCP ACKed unseen segment] 80 > 10554 [ACK] Seq=1 Ack=11201 Win=53200 Len=0","53200"
+"3","0.025738","200.121.1.131","172.16.0.122","TCP","1454","","[TCP Spurious Retransmission] 10554 > 80 [ACK] Seq=1401 Ack=1 Win=65535 Len=1400 [TCP segment of a reassembled PDU]","65535"
+"4","0.025749","172.16.0.122","200.121.1.131","TCP","54","","[TCP Window Update] [TCP ACKed unseen segment] 80 > 10554 [ACK] Seq=1 Ack=11201 Win=63000 Len=0","63000"
+"5","0.076967","200.121.1.131","172.16.0.122","TCP","1454","","[TCP Previous segment not captured] [TCP Spurious Retransmission] 10554 > 80 [ACK] Seq=4201 Ack=1 Win=65535 Len=1400 [TCP segment of a reassembled PDU]","65535"
+----
-Export packet data into PDML. This is an XML based format including the packet
-details. The PDML file specification is available at:
-https://web.archive.org/web/20140416072301/http://www.nbee.org/doku.php?id=netpdl:pdml_specification[].
+.JSON
+----
+{
+ "_index": "packets-2014-06-22",
+ "_type": "doc",
+ "_score": null,
+ "_source": {
+ "layers": {
+ "frame": {
+ "frame.encap_type": "1",
+ "frame.time": "Jun 22, 2014 13:29:41.834477000 PDT",
+ "frame.offset_shift": "0.000000000",
+ "frame.time_epoch": "1403468981.834477000",
+ "frame.time_delta": "0.450535000",
+ "frame.time_delta_displayed": "0.450535000",
+ "frame.time_relative": "0.450535000",
+ "frame.number": "2",
+ "frame.len": "86",
+ "frame.cap_len": "86",
+ "frame.marked": "0",
+ "frame.ignored": "0",
+ "frame.protocols": "eth:ethertype:ipv6:icmpv6",
+ "frame.coloring_rule.name": "ICMP",
+ "frame.coloring_rule.string": "icmp || icmpv6"
+ },
+ "eth": {
+ "eth.dst": "33:33:ff:9e:e3:8e",
+ "eth.dst_tree": {
+ "eth.dst_resolved": "33:33:ff:9e:e3:8e",
+ "eth.dst.oui": "3355647",
+ "eth.addr": "33:33:ff:9e:e3:8e",
+ "eth.addr_resolved": "33:33:ff:9e:e3:8e",
+ "eth.addr.oui": "3355647",
+ "eth.dst.lg": "1",
+ "eth.lg": "1",
+ "eth.dst.ig": "1",
+ "eth.ig": "1"
+ },
+ "eth.src": "00:01:5c:62:8c:46",
+ "eth.src_tree": {
+ "eth.src_resolved": "00:01:5c:62:8c:46",
+ "eth.src.oui": "348",
+ "eth.src.oui_resolved": "Cadant Inc.",
+ "eth.addr": "00:01:5c:62:8c:46",
+ "eth.addr_resolved": "00:01:5c:62:8c:46",
+ "eth.addr.oui": "348",
+ "eth.addr.oui_resolved": "Cadant Inc.",
+ "eth.src.lg": "0",
+ "eth.lg": "0",
+ "eth.src.ig": "0",
+ "eth.ig": "0"
+ },
+ "eth.type": "0x000086dd"
+ },
+ "ipv6": {
+ "ipv6.version": "6",
+ "ip.version": "6",
+ "ipv6.tclass": "0x00000000",
+ "ipv6.tclass_tree": {
+ "ipv6.tclass.dscp": "0",
+ "ipv6.tclass.ecn": "0"
+ },
+ "ipv6.flow": "0x00000000",
+ "ipv6.plen": "32",
+ "ipv6.nxt": "58",
+ "ipv6.hlim": "255",
+ "ipv6.src": "2001:558:4080:16::1",
+ "ipv6.addr": "2001:558:4080:16::1",
+ "ipv6.src_host": "2001:558:4080:16::1",
+ "ipv6.host": "2001:558:4080:16::1",
+ "ipv6.dst": "ff02::1:ff9e:e38e",
+ "ipv6.addr": "ff02::1:ff9e:e38e",
+ "ipv6.dst_host": "ff02::1:ff9e:e38e",
+ "ipv6.host": "ff02::1:ff9e:e38e",
+ "ipv6.geoip.src_summary": "US, ASN 7922, Comcast Cable Communications, LLC",
+ "ipv6.geoip.src_summary_tree": {
+ "ipv6.geoip.src_country": "United States",
+ "ipv6.geoip.country": "United States",
+ "ipv6.geoip.src_country_iso": "US",
+ "ipv6.geoip.country_iso": "US",
+ "ipv6.geoip.src_asnum": "7922",
+ "ipv6.geoip.asnum": "7922",
+ "ipv6.geoip.src_org": "Comcast Cable Communications, LLC",
+ "ipv6.geoip.org": "Comcast Cable Communications, LLC",
+ "ipv6.geoip.src_lat": "37.751",
+ "ipv6.geoip.lat": "37.751",
+ "ipv6.geoip.src_lon": "-97.822",
+ "ipv6.geoip.lon": "-97.822"
+ }
+ },
+ "icmpv6": {
+ "icmpv6.type": "135",
+ "icmpv6.code": "0",
+ "icmpv6.checksum": "0x00005b84",
+ "icmpv6.checksum.status": "1",
+ "icmpv6.reserved": "00:00:00:00",
+ "icmpv6.nd.ns.target_address": "2001:558:4080:16:be36:e4ff:fe9e:e38e",
+ "icmpv6.opt": {
+ "icmpv6.opt.type": "1",
+ "icmpv6.opt.length": "1",
+ "icmpv6.opt.linkaddr": "00:01:5c:62:8c:46",
+ "icmpv6.opt.src_linkaddr": "00:01:5c:62:8c:46"
+ }
+ }
+ }
+ }
+ }
+]
+----
-[NOTE]
-====
-The PDML specification is not officially released and Wireshark’s implementation
-of it is still in an early beta state, so please expect changes in future
-Wireshark versions.
-====
+[[ChIOExportSelectedDialog]]
-.The “Export as PDML File” dialog box
-image::wsug_graphics/ws-export-pdml.png[{screenshot-attrs}]
+==== The “Export Selected Packet Bytes” Dialog Box
-* _Export to file:_ frame chooses the file to export the packet data to.
+Export the bytes selected in the “Packet Bytes” pane into a raw binary file.
-* The _Packet Range_ frame is described in <<ChIOPacketRangeSection>>.
+.The “Export Selected Packet Bytes” dialog box
+image::wsug_graphics/ws-export-selected.png[{medium-screenshot-attrs}]
-There’s no such thing as a packet details frame for PDML export, as the packet
-format is defined by the PDML specification.
+File name::
+The file name to export the packet data to.
-[[ChIOExportSelectedDialog]]
+Save as type::
+The file extension.
-==== The “Export Selected Packet Bytes” Dialog Box
+[[ChIOExportPDUSDialog]]
-Export the bytes selected in the “Packet Bytes” pane into a raw binary file.
+==== The “Export PDUs to File...” Dialog Box
-.The “Export Selected Packet Bytes” dialog box
-image::wsug_graphics/ws-export-selected.png[{screenshot-attrs}]
+{missing}
-* _Name:_ the filename to export the packet data to.
+[[ChIOExportTLSSessionKeys]]
-* The _Save in folder:_ field lets you select the folder to save to (from some predefined folders).
+==== The “Export TLS Session Keys...” Dialog Box
-* _Browse for other folders_ provides a flexible way to choose a folder.
+{missing}
[[ChIOExportObjectsDialog]]
@@ -734,33 +818,43 @@ image::wsug_graphics/ws-export-objects.png[{screenshot-attrs}]
Columns:
-* _Packet:_ The packet number in which this object was found. In some
- cases, there can be multiple objects in the same packet.
+Packet::
+The packet number in which this object was found. In some
+cases, there can be multiple objects in the same packet.
-* _Hostname:_ The hostname of the server that sent this object.
+Hostname::
+The hostname of the server that sent this object.
-* _Content Type:_ The content type of this object.
+Content Type::
+The content type of this object.
-* _Size:_ The size of this object in bytes.
+Size::
+The size of this object in bytes.
-* _Filename:_ The filename for this object. Each protocol generates
- the filename differently. For example, HTTP uses the
- final part of the URI and IMF uses the subject of the email.
+Filename:
+The filename for this object. Each protocol generates
+the filename differently. For example, HTTP uses the
+final part of the URI and IMF uses the subject of the email.
Inputs:
-* _Text Filter:_ Only displays objects containing the specified text string.
+Text Filter::
+Only displays objects containing the specified text string.
-* _Help:_ Opens the “Export Objects” section in the user’s guide.
+Help::
+Opens this section of the “User’s Guide”.
-* _Save All:_ Saves all objects (including those not displayed) using the filename from the
- filename column. You will be asked what directory / folder to save them in.
+Save All::
+Saves all objects (including those not displayed) using the filename from the
+filename column. You will be asked what directory or folder to save them in.
-* _Close:_ Closes the “Export Objects” dialog.
+Close::
+Closes the dialog without exporting.
-* _Save:_ Saves the currently selected object as a filename you specify. The
- default filename to save as is taken from the filename column of the objects
- list.
+Save::
+Saves the currently selected object as a filename you specify. The
+default filename to save as is taken from the filename column of the objects
+list.
[[ChIOPrintSection]]
@@ -814,64 +908,71 @@ btn:[Help] will display this section of the “User’s Guide”.
=== The “Packet Range” Frame
-The packet range frame is a part of various output related dialog boxes. It
-provides options to select which packets should be processed by the output
-function.
+The packet range frame is a part of the “<<ChIOExportSpecifiedPacketsDialog,Export Specified Packets>>,” “<<ChIOExportPacketDissectionsDialog,Export Packet Dissections>>,” and “<<ChIOPrintSection,Print>>” dialog boxes.
+You can use it to specify which packets will be exported or printed.
[[ChIOPacketRangeFrame]]
.The “Packet Range” frame
image::wsug_graphics/ws-packet-range.png[{medium-screenshot-attrs}]
-If the btn:[Captured] button is set (default), all packets from the selected rule
-will be processed. If the btn:[Displayed] button is set, only the currently
-displayed packets are taken into account to the selected rule.
+By default the btn:[Displayed] button is set, which only exports or prints the packets that match the current display filter.
+Selecting btn:[Captured] will export or print all packets.
+You can further limit what you export or print to the following:
+
+All packets::
+All captured or displayed packets depending on the primary selection above.
-* _All packets_ will process all packets.
+Selected packet::
+Only the selected packet.
-* _Selected packet only_ process only the selected packet.
+Marked packets::
+Only marked packets. See <<ChWorkMarkPacketSection>>.
-* _Marked packets only_ process only the marked packets.
+First to last marked::
+Lets you mark an inclusive range of packets.
-* _From first to last marked packet_ process the packets from the first to the
- last marked one.
+Range::
+Lets you manually specify a range of packets, e.g. _5,10-15,20-_ will process the packet number five, the packets from packet number ten to fifteen (inclusive) and every packet from number twenty to the end of the capture.
-* _Specify a packet range_ process a user specified range of packets, e.g.
- specifying _5,10-15,20-_ will process the packet number five, the packets from
- packet number ten to fifteen (inclusive) and every packet from number twenty
- to the end of the capture.
+Remove ignored packets::
+Don't export or print ignored packets.
+See <<ChWorkIgnorePacketSection>>.
[[ChIOPacketFormatSection]]
=== The Packet Format Frame
-The packet format frame is a part of various output related dialog boxes. It
-provides options to select which parts of a packet should be used for the output
-function.
+The packet format frame is also a part of the “<<ChIOExportPacketDissectionsDialog,Export Packet Dissections>>” and “<<ChIOPrintSection,Print>>” dialog boxes.
+You can use it to specify which parts of dissection are exported or printed.
[[ChIOPacketFormatFrame]]
.The “Packet Format” frame
image::wsug_graphics/ws-packet-format.png[{small-screenshot-attrs}]
-* _Packet summary line_ enable the output of the summary line, just as in the
- “Packet List” pane.
+Each of the settings below correspond to the packet list, packet detail, and packet bytes in the main window.
+
+Packet summary line::
+Export or print each summary line as shown in the “Packet List” pane.
-* _Packet details_ enable the output of the packet details tree.
+Packet details::
+Export or print the contents of the “Packet Details” tree.
-* _All collapsed_ the info from the “Packet Details” pane in “all collapsed”
- state.
+All collapsed:::
+Export or print as if the “Packet Details” tree is in the “all collapsed” state.
-* _As displayed_ the info from the “Packet Details” pane in the current state.
+As displayed:::
+Export or print as if the “Packet Details” tree is in the “as displayed” state.
-* _All expanded_ the info from the “Packet Details” pane in “all expanded”
- state.
+All expanded:::
+Export or print as if the “Packet Details” tree is in the “all expanded” state.
-* _Packet bytes_ enable the output of the packet bytes, just as in the “Packet
- Bytes” pane.
+Packet Bytes::
+Export or print the contents of the “Packet Bytes” pane.
-* _Each packet on a new page_ put each packet on a separate page (e.g. when
- saving/printing to a text file, this will put a form feed character between
- the packets).
+Each packet on a new page::
+For printing and some export formats, put each packet on a separate page.
+For example, when exporting to a text file this will put a form feed character between each packet.
// End of WSUG Chapter IO