aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGerald Combs <gerald@wireshark.org>2019-12-15 14:25:54 -0800
committerAnders Broman <a.broman58@gmail.com>2019-12-17 05:10:44 +0000
commit5e8d79fd6915c5e0af6b3f9030a980270ffdf1d8 (patch)
tree0cc0383df666bdc6a74199958f44292d918f087a
parent7c61ab7cf25a4849efc2f46e67127b26b90b2388 (diff)
WSUG: Update the Expert Information and Status Bar docs.
Update the Expert Information section of the User's Guide. Use the term "Expert Information" to describe the dialog and "expert information item" to describe each generated item. Update related text elsewhere. Update the expert icon and other parts of the status bar docs. Change-Id: I0c2cba0cbb3c74a1f6e3a37d4a2a592faccb350f Reviewed-on: https://code.wireshark.org/review/35462 Reviewed-by: Anders Broman <a.broman58@gmail.com>
-rw-r--r--doc/wireshark.pod.template5
-rw-r--r--docbook/CMakeLists.txt2
-rw-r--r--docbook/wsug_graphics/ws-expert-information.pngbin0 -> 235306 bytes
-rw-r--r--docbook/wsug_graphics/ws-expert-infos.pngbin10084 -> 0 bytes
-rw-r--r--docbook/wsug_src/WSUG_chapter_advanced.adoc201
-rw-r--r--docbook/wsug_src/WSUG_chapter_use.adoc52
6 files changed, 139 insertions, 121 deletions
diff --git a/doc/wireshark.pod.template b/doc/wireshark.pod.template
index d055ea3a5a..7b5292dc32 100644
--- a/doc/wireshark.pod.template
+++ b/doc/wireshark.pod.template
@@ -2075,11 +2075,6 @@ This entry specifies the command line to launch a web browser. It is used
to access online content, like the Wiki and user guide. Use '%s' to place
the request URL in the command line.
-=item Display LEDs in the Expert Infos dialog tab labels
-
-This item determines if LED-like colored images are displayed in the
-Expert Infos dialog tab labels.
-
=back
=item Layout Preferences
diff --git a/docbook/CMakeLists.txt b/docbook/CMakeLists.txt
index e15d42eaca..a843c52294 100644
--- a/docbook/CMakeLists.txt
+++ b/docbook/CMakeLists.txt
@@ -141,7 +141,7 @@ set(WSUG_GRAPHICS
wsug_graphics/ws-enabled-protocols.png
wsug_graphics/ws-expert-colored-tree.png
wsug_graphics/ws-expert-column.png
- wsug_graphics/ws-expert-infos.png # Outdated
+ wsug_graphics/ws-expert-information.png
wsug_graphics/ws-export-objects.png
wsug_graphics/ws-export-packet-dissections.png
wsug_graphics/ws-export-specified-packets.png
diff --git a/docbook/wsug_graphics/ws-expert-information.png b/docbook/wsug_graphics/ws-expert-information.png
new file mode 100644
index 0000000000..8fa631076c
--- /dev/null
+++ b/docbook/wsug_graphics/ws-expert-information.png
Binary files differ
diff --git a/docbook/wsug_graphics/ws-expert-infos.png b/docbook/wsug_graphics/ws-expert-infos.png
deleted file mode 100644
index 132c40ce1e..0000000000
--- a/docbook/wsug_graphics/ws-expert-infos.png
+++ /dev/null
Binary files differ
diff --git a/docbook/wsug_src/WSUG_chapter_advanced.adoc b/docbook/wsug_src/WSUG_chapter_advanced.adoc
index 9b9d425d19..9c6d8c500e 100644
--- a/docbook/wsug_src/WSUG_chapter_advanced.adoc
+++ b/docbook/wsug_src/WSUG_chapter_advanced.adoc
@@ -189,95 +189,114 @@ pressing btn:[Find Next].
=== Expert Information
-The expert infos is a kind of log of the anomalies found by Wireshark in a
-capture file.
-
-The general idea behind the following “Expert Info” is to have a better
-display of “uncommon” or just notable network behaviour. This way, both novice
-and expert users will hopefully find probable network problems a lot faster,
-compared to scanning the packet list “manually” .
+Wireshark keeps track of any anomalies and other items of interest it finds in a capture file and shows them in the Expert Information dialog.
+The goal is to give you a better idea of uncommon or notable network behaviour and to let novice and expert users find network problems faster than manually scanning through the packet list.
[WARNING]
-.Expert infos are only a hint
+.Expert information is only a hint
====
-Take expert infos as a hint what’s worth looking at, but not more. For example,
-the absence of expert infos doesn’t necessarily mean everything is OK.
+Expert information is the starting point for investigation, not the stopping point.
+Every network is different, and it's up to you to verify that Wireshark’s expert information applies to your particular situation.
+The presence of expert informantion doesn't necessarily indicate a problem and absence of expert information doesn’t necessarily mean everything is OK.
====
-The amount of expert infos largely depends on the protocol being used. While
-some common protocols like TCP/IP will show detailed expert infos, most other
-protocols currently won’t show any expert infos at all.
+The amount of expert information largely depends on the protocol being used.
+While dissectors for some common protocols like TCP and IP will show detailed information, other dissectors will show little or none.
-The following will first describe the components of a single expert info, then
-the User Interface.
+The following describes the components of a single expert information entry along with the expert user interface.
[[ChAdvExpertInfoEntries]]
-==== Expert Info Entries
+==== Expert Information Entries
-Each expert info will contain the following things which will be described in
-detail below.
+Expert information entries are grouped by severity level (described below) and contain the following:
[[ChAdvTabExpertInfoEntries]]
-.Some example expert infos
+.Example expert information items
[options="header"]
|===
-|Packet #|Severity|Group|Protocol|Summary
-|1|Note|Sequence|TCP|Duplicate ACK (#1)
-|2|Chat|Sequence|TCP|Connection reset (RST)
-|8|Note|Sequence|TCP|Keep-Alive
-|9|Warn|Sequence|TCP|Fast retransmission (suspected)
+|Packet #|Summary|Group|Protocol
+|592|TCP: [TCP Out-Of-Order] ...|Malformed|TCP
+|1202|DNS: Standard query response ...|Protocol|DNS
+|443|TCP: 80 → 59322 [RST] Seq=12761 Win=0 Len=0|Sequence|TCP
|===
[[ChAdvExpertSeverity]]
===== Severity
-Every expert info has a specific severity level. The following severity levels
-are used, in parentheses are the colors in which the items will be marked in the
-GUI:
+Every expert information item has a severity level.
+The following levels are used, from lowest to highest.
+Wireshark marks them using different colors, which are shown in parentheses:
-* __Chat (grey)__: information about usual workflow, e.g. a TCP packet with the
- SYN flag set
+Chat [white blue-background]#(blue)#::
+Information about usual workflow, e.g. a TCP packet with the SYN flag set.
-* __Note (cyan)__: notable things, e.g. an application returned an “usual”
- error code like HTTP 404
+Note [black aqua-background]#(cyan)#::
+Notable events, e.g. an application returned a common error code such as HTTP 404.
-* __Warn (yellow)__: warning, e.g. application returned an “unusual” error
- code like a connection problem
+Warn [black yellow-background]#(yellow)#::
+Warnings, e.g. application returned an unusual error code like a connection problem.
-* __Error (red)__: serious problem, e.g. [Malformed Packet]
+Error [white red-background]#(red)#::
+Serious problems, such as malformed packets.
[[ChAdvExpertGroup]]
+===== Summary
+
+Short explanatory text for each expert information item.
+
===== Group
-There are some common groups of expert infos. The following are currently implemented:
+Along with severity levels, expert information items are categorized by group.
+The following groups are currently implemented:
+
+Assumption::
+The protocol field has incomplete data and was dissected based on assumed value.
+
+Checksum::
+A checksum was invalid.
+
+Comment::
+Packet comment.
+
+Debug::
+Debugging information.
+You shouldn’t see this group in release versions of Wireshark.
+
+Decryption::
+A decryption issue.
-* __Checksum__: a checksum was invalid
+Deprecated::
+The protocol field has been deprecated.
-* __Sequence__: protocol sequence suspicious, e.g. sequence wasn’t continuous or
- a retransmission was detected or ...
+Malformed::
+Malformed packet or dissector has a bug.
+Dissection of this packet aborted.
-* __Response Code__: problem with application response code, e.g. HTTP 404 page
- not found
+Protocol::
+Violation of a protocol’s specification (e.g. invalid field values or illegal lengths).
+Dissection of this packet probably continued.
-* __Request Code__: an application request (e.g. File Handle == x), usually Chat
- level
+Reassemble::
+Problems while reassembling, e.g. not all fragments were available or an exception happened during reassembly.
-* __Undecoded__: dissector incomplete or data can’t be decoded for other reasons
+Request Code::
+An application request (e.g. File Handle == _x_). Usually assigned the Chat severity level.
-* __Reassemble__: problems while reassembling, e.g. not all fragments were
- available or an exception happened while reassembling
+Response Code::
+An application response code indicates a potential problem, e.g. HTTP 404 page not found.
-* __Protocol__: violation of protocol specs (e.g. invalid field values or
- illegal lengths), dissection of this packet is probably continued
+Security::
+A security problem, e.g. an insecure implementation.
-* __Malformed__: malformed packet or dissector has a bug, dissection of this
- packet aborted
+Sequence::
+A protocol sequence number was suspicious, e.g. it wasn’t continuous or a retransmission was detected.
-* __Debug__: debugging (should not occur in release versions)
+Undecoded::
+Dissection incomplete or data can’t be decoded for other reasons.
It’s possible that more groups will be added in the future.
@@ -285,49 +304,65 @@ It’s possible that more groups will be added in the future.
===== Protocol
-The protocol in which the expert info was caused.
+The protocol dissector that created the expert information item.
[[ChAdvExpertSummary]]
-===== Summary
+[[ChAdvExpertDialog]]
-Each expert info will also have a short additional text with some further explanation.
+==== The “Expert Information” dialog
-[[ChAdvExpertDialog]]
+You can open the expert info dialog by selecting menu:Analyze[Expert Info] or by clicking the expert level indicator in the main status bar.
+
+Right-clicking on an item will allow you to apply or prepare a filter based on the item, copy its summary text, and other tasks.
+
+.The “Expert Information” dialog box
+image::wsug_graphics/ws-expert-information.png[{screenshot-attrs}]
+
+You can choose from the following actions:
+
+Limit to display filter::
+Only show expert information items present in packets that match the current display filter.
-==== “Expert Info” dialog
+Group by summary::
+Group items by their summary instead of the groups described above.
-You can open the expert info dialog by selecting menu:Analyze[Expert Info].
+Search::
+Only show items that match the search string, such as “dns”.
+Regular expressions are supported.
-// XXX - add explanation of the dialogs context menu.
+menu:Show...[]::
+Lets you show or hide each severity level.
+For example, you can deselect Chat and Note severities if desired.
-.The “Expert Info” dialog box
-image::wsug_graphics/ws-expert-infos.png[{screenshot-attrs}]
+btn:[Help]::
+Takes you to this section of the User’s Guide.
-[[ChAdvExpertDialogTabs]]
+btn:[Close]::
+Closes the dialog
-===== Errors / Warnings / Notes / Chats tabs
+// ===== Errors / Warnings / Notes / Chats tabs
-An easy and quick way to find the most interesting infos (rather than using the
-Details tab), is to have a look at the separate tabs for each severity level. As
-the tab label also contains the number of existing entries, it’s easy to find
-the tab with the most important entries.
+// An easy and quick way to find the most interesting infos (rather than using the
+// Details tab), is to have a look at the separate tabs for each severity level. As
+// the tab label also contains the number of existing entries, it’s easy to find
+// the tab with the most important entries.
-There are usually a lot of identical expert infos only differing in the packet
-number. These identical infos will be combined into a single line - with a count
-column showing how often they appeared in the capture file. Clicking on the plus
-sign shows the individual packet numbers in a tree view.
+// There are usually a lot of identical expert infos only differing in the packet
+// number. These identical infos will be combined into a single line - with a count
+// column showing how often they appeared in the capture file. Clicking on the plus
+// sign shows the individual packet numbers in a tree view.
-[[ChAdvExpertDialogDetails]]
+// [[ChAdvExpertDialogDetails]]
-===== Details tab
+// ===== Details tab
-The Details tab provides the expert infos in a “log like” view, each entry on
-its own line (much like the packet list). As the amount of expert infos for a
-capture file can easily become very large, getting an idea of the interesting
-infos with this view can take quite a while. The advantage of this tab is to
-have all entries in the sequence as they appeared, this is sometimes a help to
-pinpoint problems.
+// The Details tab provides the expert infos in a “log like” view, each entry on
+// its own line (much like the packet list). As the amount of expert infos for a
+// capture file can easily become very large, getting an idea of the interesting
+// infos with this view can take quite a while. The advantage of this tab is to
+// have all entries in the sequence as they appeared, this is sometimes a help to
+// pinpoint problems.
[[ChAdvExpertColorizedTree]]
@@ -336,15 +371,11 @@ pinpoint problems.
.The “Colorized” protocol details tree
image::wsug_graphics/ws-expert-colored-tree.png[{screenshot-attrs}]
-The protocol field causing an expert info is colorized, e.g. uses a cyan
-background for a note severity level. This color is propagated to the toplevel
-protocol item in the tree, so it’s easy to find the field that caused the expert
-info.
+The packet detail tree marks fields with expert information based on their severity level color, e.g. “Warning” severities have a yellow background.
+This color is propagated to the top-level protocol item in the tree in order to make it easy to find the field that created the expert information.
-For the example screenshot above, the IP “Time to live” value is very low
-(only 1), so the corresponding protocol field is marked with a cyan background.
-To easier find that item in the packet tree, the IP protocol toplevel item is
-marked cyan as well.
+For the example screenshot above, the IP “Time to live” value is very low (only 1), so the corresponding protocol field is marked with a cyan background.
+To make it easier find that item in the packet tree, the IP protocol toplevel item is marked cyan as well.
[[ChAdvExpertColumn]]
diff --git a/docbook/wsug_src/WSUG_chapter_use.adoc b/docbook/wsug_src/WSUG_chapter_use.adoc
index e37eab769a..4077e58360 100644
--- a/docbook/wsug_src/WSUG_chapter_use.adoc
+++ b/docbook/wsug_src/WSUG_chapter_use.adoc
@@ -1064,37 +1064,32 @@ This statusbar is shown while no capture file is loaded, e.g. when Wireshark is
.The Statusbar with a loaded capture file
image::wsug_graphics/ws-statusbar-loaded.png[{statusbar-attrs}]
-* *The colorized bullet* on the left shows the highest expert info level found
- in the currently loaded capture file. Hovering the mouse over this icon will
- show a textual description of the expert info level, and clicking the icon
- will bring up the Expert Infos dialog box. For a detailed description of
- expert info, see <<ChAdvExpert>>.
+The colorized bullet...:: on the left shows the highest expert information level found in the currently loaded capture file.
+Hovering the mouse over this icon will show a description of the expert info level, and clicking the icon will bring up the Expert Information dialog box.
+For a detailed description of this dialog and each expert level, see <<ChAdvExpert>>.
-* *The left side* shows information about the capture file, its name, its size
- and the elapsed time while it was being captured. Hovering over a file name
- will show its full path and size.
+The edit icon...:: on the left side lets you add a comment to the capture file using the <<ChStatSummary,Capture File Properties>> dialog.
-* *The middle part* shows the current number of packets in the capture file. The
- following values are displayed:
+The left side...:: shows the capture file name by default.
+It also shows field information when hovering over and selecting items in the packet detail and packet bytes panes, as well as general notifications.
- - _Packets:_ The number of captured packets.
+The middle...:: shows the current number of packets in the capture file.
+The following values are displayed:
- - _Displayed:_ The number of packets currently being displayed.
+Packets::: The number of captured packets.
- - _Marked:_ The number of marked packets (only displayed if packets are
- marked).
+Displayed::: The number of packets currently being displayed.
- - _Dropped:_ The number of dropped packets (only displayed if Wireshark was
- unable to capture all packets).
+Marked::: The number of marked packets. Only displayed if you marked any packets.
- - _Ignored:_ The number of ignored packets (only displayed if packets are
- ignored).
+Dropped::: The number of dropped packets Only displayed if Wireshark was unable to capture all packets.
- - _Load time:_ The time it took to load the capture (wall clock time).
+Ignored::: The number of ignored packets Only displayed if you ignored any packets.
-* *The right side* shows the selected configuration profile. Clicking in this
- part of the statusbar will bring up a menu with all available configuration
- profiles, and selecting from this list will change the configuration profile.
+//Load time::: The time it took to load the capture (wall clock time).
+
+The right side...:: shows the selected configuration profile.
+Clicking on this part of the statusbar will bring up a menu with all available configuration profiles, and selecting from this list will change the configuration profile.
[[ChUseWiresharkStatusbarProfile]]
.The Statusbar with a configuration profile menu
@@ -1106,14 +1101,12 @@ For a detailed description of configuration profiles, see <<ChCustConfigProfiles
.The Statusbar with a selected protocol field
image::wsug_graphics/ws-statusbar-selected.png[{statusbar-attrs}]
-This is displayed if you have selected a protocol field from the “Packet
-Details” pane.
-
+This is displayed if you have selected a protocol field in the “Packet Details” pane.
[TIP]
====
-The value between the parentheses (in this example “ipv6.src”) can be used as a
-display filter, representing the selected protocol field.
+The value between the parentheses (in this example “ipv6.src”) is the display filter field for the selected item.
+You can become more familiar with display filter fields by selecting different packet detail items.
====
[[ChUseWiresharkStatusbarFilter]]
@@ -1121,8 +1114,7 @@ display filter, representing the selected protocol field.
.The Statusbar with a display filter message
image::wsug_graphics/ws-statusbar-filter.png[{statusbar-attrs}]
-This is displayed if you are trying to use a display filter which may have
-unexpected results. For a detailed description, see
-<<ChWorkBuildDisplayFilterMistake>>.
+This is displayed if you are trying to use a display filter which may have unexpected results.
+For a detailed description see <<ChWorkBuildDisplayFilterMistake>>.
// End of WSUG Chapter 3