aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGerald Combs <gerald@wireshark.org>2019-12-21 12:06:48 -0800
committerGerald Combs <gerald@wireshark.org>2019-12-31 20:39:58 +0000
commit3c77808cf3c6a9ea5c5050944a2b67f10ade7ded (patch)
tree345a37b29f5547ce75e848ec4de5d514615842aa
parente9014030fe2dc5926a7e7e8d9f29bf1ebcf6b6bd (diff)
WSUG: Update the Capture Properties dialog section.
Change-Id: Ib7ee22076c63fc1be339d4c1b586b73490a3a950 Reviewed-on: https://code.wireshark.org/review/35541 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
-rw-r--r--docbook/CMakeLists.txt2
-rw-r--r--docbook/wsug_graphics/ws-capture-file-properties.pngbin0 -> 22450 bytes
-rw-r--r--docbook/wsug_graphics/ws-stats-summary.pngbin37673 -> 0 bytes
-rw-r--r--docbook/wsug_src/WSUG_chapter_statistics.adoc97
4 files changed, 64 insertions, 35 deletions
diff --git a/docbook/CMakeLists.txt b/docbook/CMakeLists.txt
index a843c52294..ee03d98b6f 100644
--- a/docbook/CMakeLists.txt
+++ b/docbook/CMakeLists.txt
@@ -120,6 +120,7 @@ set(WSUG_GRAPHICS
wsug_graphics/ws-bytes-pane-popup-menu.png
wsug_graphics/ws-bytes-pane-tabs.png
wsug_graphics/ws-bytes-pane.png
+ wsug_graphics/ws-capture-file-properties.png
wsug_graphics/ws-capture-info.png
wsug_graphics/ws-capture-interfaces-main-macos.png
wsug_graphics/ws-capture-interfaces-main-win32.png
@@ -193,7 +194,6 @@ set(WSUG_GRAPHICS
wsug_graphics/ws-stats-iographs.png # GTK+
wsug_graphics/ws-stats-srt-dcerpc-filter.png # GTK+
wsug_graphics/ws-stats-srt-dcerpc.png # GTK+
- wsug_graphics/ws-stats-summary.png # GTK+
wsug_graphics/ws-stats-lte-mac-traffic.png
wsug_graphics/ws-stats-lte-rlc-traffic.png
wsug_graphics/ws-stats-wlan-traffic.png # GTK+
diff --git a/docbook/wsug_graphics/ws-capture-file-properties.png b/docbook/wsug_graphics/ws-capture-file-properties.png
new file mode 100644
index 0000000000..816987b320
--- /dev/null
+++ b/docbook/wsug_graphics/ws-capture-file-properties.png
Binary files differ
diff --git a/docbook/wsug_graphics/ws-stats-summary.png b/docbook/wsug_graphics/ws-stats-summary.png
deleted file mode 100644
index 61dd23bb01..0000000000
--- a/docbook/wsug_graphics/ws-stats-summary.png
+++ /dev/null
Binary files differ
diff --git a/docbook/wsug_src/WSUG_chapter_statistics.adoc b/docbook/wsug_src/WSUG_chapter_statistics.adoc
index 76f5011a45..bbe90026dd 100644
--- a/docbook/wsug_src/WSUG_chapter_statistics.adoc
+++ b/docbook/wsug_src/WSUG_chapter_statistics.adoc
@@ -15,7 +15,7 @@ These statistics range from general information about the loaded capture file
(like the number of captured packets), to statistics about specific protocols
(e.g. statistics about the number of HTTP requests and responses captured).
-* General statistics:
+.General statistics
- *Capture File Properties* about the capture file.
@@ -27,7 +27,7 @@ These statistics range from general information about the loaded capture file
- *I/O Graphs* visualizing the number of packets (or similar) in time.
-* Protocol specific statistics:
+.Protocol specific statistics
- *Service Response Time* between request and response of some protocols.
@@ -49,31 +49,56 @@ Some of these statistics are described at
[[ChStatSummary]]
-=== The “Capture File Properties” Window
+=== The “Capture File Properties” Dialog
-General statistics about the current capture file.
+General information about the current capture file.
-.The “Capture File Properties” window
-image::wsug_graphics/ws-stats-summary.png[{screenshot-attrs}]
+.The “Capture File Properties” dialog
+image::wsug_graphics/ws-capture-file-properties.png[{screenshot-attrs}]
-* __File__: general information about the capture file.
+This dialog shows the following information:
-* __Time__: the timestamps when the first and the last packet were captured (and
- the time between them).
+Details::
+Notable information about the capture file.
-* __Capture__: information from the time when the capture was done (only
- available if the packet data was captured from the network and not loaded from
- a file).
+File:::
+General information about the capture file, including its full path, size, cryptographic hashes, file format, and encapsulation.
-* __Interface__: information about the capture interface.
+Time:::
+The timestamps of the first and the last packet in the file along with their difference.
-* __Statistics__: some statistics of the network traffic seen. If a display
- filter is set, you will see values in the Captured column, and if any
- packages are marked, you will see values in the Marked column. The values
- in the _Captured_ column will remain the same as before, while the values
- in the _Displayed_ column will reflect the values corresponding to the
- packets shown in the display. The values in the _Marked_ column will
- reflect the values corresponding to the marked packages.
+Capture:::
+Information about the capture environment.
+This will only be shown for live captures or if this information is present in a saved capture file.
+The pcapng format supports this, while pcap doesn’t.
+
+Interfaces:::
+Information about the capture interface or interfaces.
+
+Statistics:::
+A statistical summary of the capture file.
+If a display filter is set, you will see values in the _Captured_ column, and if any packets are marked, you will see values in the _Marked_ column.
+The values in the _Captured_ column will remain the same as before, while the values in the _Displayed_ column will reflect the values corresponding to the packets shown in the display.
+The values in the _Marked_ column will reflect the values corresponding to the marked packages.
+
+Capture file comments::
+Some capture file formats (notably pcapng) allow a text comment for the entire file.
+You can view and edit this comment here.
+
+btn:[Refresh]::
+Updates the information in the dialog.
+
+btn:[Save Comments]::
+Saves the contents of the “Capture file comments” text entry.
+
+btn:[Close]::
+Closes the dialog
+
+btn:[Copy To Clipboard]::
+Copies the “Details” information to the clipboard.
+
+btn:[Help]::
+Opens this section of the User’s Guide.
[[ChStatResolvedAddresses]]
@@ -99,28 +124,32 @@ The btn:[Copy] button will let you copy the window contents as CSV or YAML.
.Protocol hierarchy columns
-Protocol:: This protocol’s name
+Protocol::
+This protocol’s name.
-Percent Packets:: The percentage of protocol packets relative to all packets in
- the capture
+Percent Packets::
+The percentage of protocol packets relative to all packets in the capture.
-Packets:: The total number of packets of this protocol
+Packets::
+The total number of packets of this protocol.
-Percent Bytes:: The percentage of protocol bytes relative to the total bytes in
- the capture
+Percent Bytes::
+The percentage of protocol bytes relative to the total bytes in the capture.
-Bytes:: The total number of bytes of this protocol
+Bytes::
+The total number of bytes of this protocol.
-Bits/s:: The bandwidth of this protocol relative to the capture time
+Bits/s::
+The bandwidth of this protocol relative to the capture time.
-End Packets:: The absolute number of packets of this protocol where it
- was the highest protocol in the stack (last dissected)
+End Packets::
+The absolute number of packets of this protocol where it was the highest protocol in the stack (last dissected).
-End Bytes:: The absolute number of bytes of this protocol where it
- was the highest protocol in the stack (last dissected)
+End Bytes::
+The absolute number of bytes of this protocol where it was the highest protocol in the stack (last dissected).
-End Bits/s:: The bandwidth of this protocol relative to the capture time where
- was the highest protocol in the stack (last dissected)
+End Bits/s::
+The bandwidth of this protocol relative to the capture time where was the highest protocol in the stack (last dissected).
Packets usually contain multiple protocols. As a result more than one protocol will
be counted for each packet. Example: In the screenshot IP has 99.9% and TCP