From f0fd052185ddfb9ead3a998b22aa7b0698fff31f Mon Sep 17 00:00:00 2001 From: Gerald Combs Date: Sat, 9 Jan 2016 14:24:45 -0800 Subject: Update the packet list documentation. Update images and describe related packets and the intelligent scrollbar. Suggest a way to make it easier to get a screenshot of related packets. Change-Id: I5bf27b0c53fb62f3e567765400141a374a465e4e Reviewed-on: https://code.wireshark.org/review/13159 Reviewed-by: Gerald Combs --- docbook/CMakeLists.txt | 9 +++++ docbook/wsug_graphics/related-ack.png | Bin 0 -> 272 bytes docbook/wsug_graphics/related-current.png | Bin 0 -> 120 bytes docbook/wsug_graphics/related-dup-ack.png | Bin 0 -> 296 bytes docbook/wsug_graphics/related-first.png | Bin 0 -> 131 bytes docbook/wsug_graphics/related-last.png | Bin 0 -> 133 bytes docbook/wsug_graphics/related-other.png | Bin 0 -> 128 bytes docbook/wsug_graphics/related-request.png | Bin 0 -> 182 bytes docbook/wsug_graphics/related-response.png | Bin 0 -> 182 bytes docbook/wsug_graphics/related-segment.png | Bin 0 -> 205 bytes docbook/wsug_graphics/ws-list-pane.png | Bin 13438 -> 179959 bytes docbook/wsug_src/WSUG_chapter_use.asciidoc | 56 +++++++++++++++++++++++++++-- 12 files changed, 63 insertions(+), 2 deletions(-) create mode 100644 docbook/wsug_graphics/related-ack.png create mode 100644 docbook/wsug_graphics/related-current.png create mode 100644 docbook/wsug_graphics/related-dup-ack.png create mode 100644 docbook/wsug_graphics/related-first.png create mode 100644 docbook/wsug_graphics/related-last.png create mode 100644 docbook/wsug_graphics/related-other.png create mode 100644 docbook/wsug_graphics/related-request.png create mode 100644 docbook/wsug_graphics/related-response.png create mode 100644 docbook/wsug_graphics/related-segment.png (limited to 'docbook') diff --git a/docbook/CMakeLists.txt b/docbook/CMakeLists.txt index c99692ed68..b257b69a7c 100644 --- a/docbook/CMakeLists.txt +++ b/docbook/CMakeLists.txt @@ -77,6 +77,15 @@ set(WSUG_FILES ) set(WSUG_GRAPHICS + wsug_graphics/related-ack.png + wsug_graphics/related-current.png + wsug_graphics/related-dup-ack.png + wsug_graphics/related-first.png + wsug_graphics/related-last.png + wsug_graphics/related-other.png + wsug_graphics/related-request.png + wsug_graphics/related-response.png + wsug_graphics/related-segment.png wsug_graphics/ws-analyze-menu.png wsug_graphics/ws-bytes-pane-tabs.png wsug_graphics/ws-bytes-pane.png diff --git a/docbook/wsug_graphics/related-ack.png b/docbook/wsug_graphics/related-ack.png new file mode 100644 index 0000000000..cfb853121b Binary files /dev/null and b/docbook/wsug_graphics/related-ack.png differ diff --git a/docbook/wsug_graphics/related-current.png b/docbook/wsug_graphics/related-current.png new file mode 100644 index 0000000000..6f17eb191b Binary files /dev/null and b/docbook/wsug_graphics/related-current.png differ diff --git a/docbook/wsug_graphics/related-dup-ack.png b/docbook/wsug_graphics/related-dup-ack.png new file mode 100644 index 0000000000..f43e8a4e3c Binary files /dev/null and b/docbook/wsug_graphics/related-dup-ack.png differ diff --git a/docbook/wsug_graphics/related-first.png b/docbook/wsug_graphics/related-first.png new file mode 100644 index 0000000000..c4bc21b1ca Binary files /dev/null and b/docbook/wsug_graphics/related-first.png differ diff --git a/docbook/wsug_graphics/related-last.png b/docbook/wsug_graphics/related-last.png new file mode 100644 index 0000000000..1a62cddbe9 Binary files /dev/null and b/docbook/wsug_graphics/related-last.png differ diff --git a/docbook/wsug_graphics/related-other.png b/docbook/wsug_graphics/related-other.png new file mode 100644 index 0000000000..fb6a51fac4 Binary files /dev/null and b/docbook/wsug_graphics/related-other.png differ diff --git a/docbook/wsug_graphics/related-request.png b/docbook/wsug_graphics/related-request.png new file mode 100644 index 0000000000..680b9fa57d Binary files /dev/null and b/docbook/wsug_graphics/related-request.png differ diff --git a/docbook/wsug_graphics/related-response.png b/docbook/wsug_graphics/related-response.png new file mode 100644 index 0000000000..24767ee4a3 Binary files /dev/null and b/docbook/wsug_graphics/related-response.png differ diff --git a/docbook/wsug_graphics/related-segment.png b/docbook/wsug_graphics/related-segment.png new file mode 100644 index 0000000000..529b96e919 Binary files /dev/null and b/docbook/wsug_graphics/related-segment.png differ diff --git a/docbook/wsug_graphics/ws-list-pane.png b/docbook/wsug_graphics/ws-list-pane.png index 5a4056e2f6..6d1e91327c 100644 Binary files a/docbook/wsug_graphics/ws-list-pane.png and b/docbook/wsug_graphics/ws-list-pane.png differ diff --git a/docbook/wsug_src/WSUG_chapter_use.asciidoc b/docbook/wsug_src/WSUG_chapter_use.asciidoc index 20104055f3..af4bbc78db 100644 --- a/docbook/wsug_src/WSUG_chapter_use.asciidoc +++ b/docbook/wsug_src/WSUG_chapter_use.asciidoc @@ -781,7 +781,7 @@ The packet list pane displays all the packets in the current capture file. [[ChUseWiresharkListPane]] .The ``Packet List'' pane -image::wsug_graphics/ws-list-pane.png[] +image::wsug_graphics/ws-list-pane.png[scaledwidth="100%"] Each line in the packet list corresponds to one packet in the capture file. If you select a line in this pane, more details will be displayed in the ``Packet @@ -814,9 +814,61 @@ The default columns will show: * button:[Protocol] The protocol name in a short (perhaps abbreviated) version. +* button:[Length] The length of each packet. + * button:[Info] Additional information about the packet content. -There is a context menu (right mouse click) available, see details in +The first column shows how each packet is related to the selected packet. For +example, in the image above the first packet is selected, which is a DNS +request. Wireshark shows a rightward arrow for the request itself, followed by a +leftward arrow for the response in packet 2. Why is there a dashed line? There +are more DNS packets further down that use the same port numbers. Wireshark +treats them as belonging to the same conversation and draws a line connecting +them. + +// Images were created on OS X 10.11 using a retina display. Lines were +// 36 physical pixels high. + +[horizontal] +.Related packet symbols + +image:wsug_graphics/related-first.png[height="18px"]:: + First packet in a conversation. + +image:wsug_graphics/related-current.png[height="18px"]:: + Part of the selected conversation + +image:wsug_graphics/related-other.png[height="18px"]:: + _Not_ part of the selected conversation + +image:wsug_graphics/related-last.png[height="18px"]:: + Last packet in a conversation. + +image:wsug_graphics/related-request.png[height="18px"]:: + Request. + +image:wsug_graphics/related-response.png[height="18px"]:: + Response. + +image:wsug_graphics/related-ack.png[height="18px"]:: + The selected packet acknowledges this packet. + +image:wsug_graphics/related-dup-ack.png[height="18px"]:: + The selected packet is a duplicate acknowledgement of this packet. + +image:wsug_graphics/related-segment.png[height="18px"]:: + The selected packet is related to this packet in some other way, e.g. as part + of reassembly. + +The packet list has an _Intelligent Scrollbar_ which shows a miniature map of +nearby packets. Each https://en.wikipedia.org/wiki/Raster_graphics[raster line] +of the scrollbar corresponds to a single packet, so the number of packets shown +in the map depends on your physical display and the height of the packet list. A +tall packet list on a high-resolution (``Retina'') display will show you quite a +few packets. In the image above the scrollbar shows the status of more than 500 +packets along with the 15 shown in the packet list itself. + +Right clicking will show a context menu, described in <>. [[ChUsePacketDetailsPaneSection]] -- cgit v1.2.3