diff options
author | Gerald Combs <gerald@wireshark.org> | 2010-04-23 21:21:11 +0000 |
---|---|---|
committer | Gerald Combs <gerald@wireshark.org> | 2010-04-23 21:21:11 +0000 |
commit | cfb892e316dab27282dee47a6f767ad107367ada (patch) | |
tree | 0b7dec996076668aaad281bcbabb660a5617fc13 /docbook | |
parent | f2a66480df931454f7fd6e835b6113ff7d7d4a4c (diff) | |
download | wireshark-cfb892e316dab27282dee47a6f767ad107367ada.tar.gz wireshark-cfb892e316dab27282dee47a6f767ad107367ada.tar.bz2 wireshark-cfb892e316dab27282dee47a6f767ad107367ada.zip |
From Vincenzo Condoleo via bug 3724:
Update the compare stats documentation.
From me: Add a screen shot and editorial updates. Change some lables to
better match the IP and TCP dissectors.
svn path=/trunk/; revision=32545
Diffstat (limited to 'docbook')
-rw-r--r-- | docbook/user-guide.xml | 27 | ||||
-rwxr-xr-x | docbook/wsug_graphics/ws-stats-compare.png | bin | 0 -> 42659 bytes | |||
-rw-r--r-- | docbook/wsug_src/WSUG_chapter_statistics.xml | 92 |
3 files changed, 104 insertions, 15 deletions
diff --git a/docbook/user-guide.xml b/docbook/user-guide.xml index 0c09cc6399..348a100d86 100644 --- a/docbook/user-guide.xml +++ b/docbook/user-guide.xml @@ -1,5 +1,5 @@ <?xml version="1.0"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ <!-- $Id$ --> @@ -24,7 +24,7 @@ BIOGRAPHICAL SECTION <!ENTITY AuthorFirstName3 "Ed"> <!ENTITY AuthorOtherName3 ""> <!ENTITY AuthorSurname3 "Warnicke"> - + <!ENTITY AuthorFullName4 "Luis E. Garcia Ontanon"> <!ENTITY AuthorFirstName4 "Luis"> <!ENTITY AuthorOtherName4 "Enrique"> @@ -135,7 +135,7 @@ FILE SECTION <!-- These refer to graphics files and figures contained in the document --> <!-- --> <!ENTITY WiresharkLogo SYSTEM "./wsug_graphics/ws-logo.png" NDATA PNG> - + <!-- 1st Chapter --> <!ENTITY WiresharkMain1 SYSTEM "./wsug_graphics/ws-main.png" NDATA PNG> @@ -158,7 +158,7 @@ FILE SECTION <!ENTITY WiresharkStatusbarFilter SYSTEM "./wsug_graphics/ws-statusbar-filter.png" NDATA PNG> <!ENTITY WiresharkPacketSelected1 SYSTEM "./wsug_graphics/ws-packet-selected.png" NDATA PNG> <!ENTITY WiresharkPacketSepView SYSTEM "./wsug_graphics/ws-packet-sep-win.png" NDATA PNG> - <!ENTITY WiresharkFilterTCP SYSTEM "./wsug_graphics/ws-display-filter-tcp.png" NDATA PNG> + <!ENTITY WiresharkFilterTCP SYSTEM "./wsug_graphics/ws-display-filter-tcp.png" NDATA PNG> <!ENTITY WiresharkColoringRulesDialog SYSTEM "./wsug_graphics/ws-coloring-rules-dialog.png" NDATA PNG> <!ENTITY WiresharkColoringFields SYSTEM "./wsug_graphics/ws-coloring-fields.png" NDATA PNG> <!ENTITY WiresharkEditColorDialog SYSTEM "./wsug_graphics/ws-edit-color-rule-dialog.png" NDATA PNG> @@ -167,8 +167,8 @@ FILE SECTION <!ENTITY WiresharkExpertInfoDialog SYSTEM "./wsug_graphics/ws-expert-infos.png" NDATA PNG> <!ENTITY WiresharkChooseColorDialog SYSTEM "./wsug_graphics/ws-choose-color-rule.png" NDATA PNG> <!ENTITY WiresharkFollowStream SYSTEM "./wsug_graphics/ws-follow-stream.png" NDATA PNG> - <!ENTITY WiresharkFindPacket SYSTEM "./wsug_graphics/ws-find-packet.png" NDATA PNG> - <!ENTITY WiresharkGoToPacket SYSTEM "./wsug_graphics/ws-goto-packet.png" NDATA PNG> + <!ENTITY WiresharkFindPacket SYSTEM "./wsug_graphics/ws-find-packet.png" NDATA PNG> + <!ENTITY WiresharkGoToPacket SYSTEM "./wsug_graphics/ws-goto-packet.png" NDATA PNG> <!ENTITY WiresharkGUIPreferences SYSTEM "./wsug_graphics/ws-gui-preferences.png" NDATA PNG> <!ENTITY WiresharkGUIInterfaceOptions SYSTEM "./wsug_graphics/ws-gui-interface-options.png" NDATA PNG> <!ENTITY WiresharkGUILayoutPreferences SYSTEM "./wsug_graphics/ws-gui-layout-preferences.png" NDATA PNG> @@ -240,6 +240,7 @@ FILE SECTION <!ENTITY WiresharkStatsEndpoints SYSTEM "./wsug_graphics/ws-stats-endpoints.png" NDATA PNG> <!ENTITY WiresharkStatsConversations SYSTEM "./wsug_graphics/ws-stats-conversations.png" NDATA PNG> <!ENTITY WiresharkStatsIOGraphs SYSTEM "./wsug_graphics/ws-stats-iographs.png" NDATA PNG> + <!ENTITY WiresharkStatsCompare SYSTEM "./wsug_graphics/ws-stats-compare.png" NDATA PNG> <!ENTITY WiresharkStatsWLANTraffic SYSTEM "./wsug_graphics/ws-stats-wlan-traffic.png" NDATA PNG> <!ENTITY WiresharkStatsLTEMACTraffic SYSTEM "./wsug_graphics/ws-stats-lte-mac-traffic.png" NDATA PNG> <!ENTITY WiresharkStatsLTERLCTraffic SYSTEM "./wsug_graphics/ws-stats-lte-rlc-traffic.png" NDATA PNG> @@ -261,13 +262,13 @@ FILE SECTION <!ENTITY WiresharkCaptureOptionsRemoteSettingsDialog SYSTEM "./wsug_graphics/ws-capture-options-remote-settings.png" NDATA PNG> <!-- Fifth Chapter --> - <!ENTITY WiresharkOpenDialog20 SYSTEM "./wsug_graphics/ws-open-gtk20.png" NDATA PNG> + <!ENTITY WiresharkOpenDialog20 SYSTEM "./wsug_graphics/ws-open-gtk20.png" NDATA PNG> <!ENTITY WiresharkSaveAsDialog20 SYSTEM "./wsug_graphics/ws-save-as-gtk20.png" NDATA PNG> <!ENTITY WiresharkMergeDialog20 SYSTEM "./wsug_graphics/ws-merge-gtk20.png" NDATA PNG> - <!ENTITY WiresharkOpenDialog24 SYSTEM "./wsug_graphics/ws-open-gtk24.png" NDATA PNG> + <!ENTITY WiresharkOpenDialog24 SYSTEM "./wsug_graphics/ws-open-gtk24.png" NDATA PNG> <!ENTITY WiresharkSaveAsDialog24 SYSTEM "./wsug_graphics/ws-save-as-gtk24.png" NDATA PNG> <!ENTITY WiresharkMergeDialog24 SYSTEM "./wsug_graphics/ws-merge-gtk24.png" NDATA PNG> - <!ENTITY WiresharkOpenDialogWin32 SYSTEM "./wsug_graphics/ws-open-win32.png" NDATA PNG> + <!ENTITY WiresharkOpenDialogWin32 SYSTEM "./wsug_graphics/ws-open-win32.png" NDATA PNG> <!ENTITY WiresharkSaveAsDialogWin32 SYSTEM "./wsug_graphics/ws-save-as-win32.png" NDATA PNG> <!ENTITY WiresharkMergeDialogWin32 SYSTEM "./wsug_graphics/ws-merge-win32.png" NDATA PNG> <!ENTITY WiresharkFileSetDialog SYSTEM "./wsug_graphics/ws-file-set-dialog.png" NDATA PNG> @@ -343,18 +344,18 @@ WSLua Reference Manual &ChapterCustomize; &WsLuaRm; - + &AppFiles; &AppProtocols; - &AppMessages; + &AppMessages; &AppTools; - + &AppGPL; <!-- Removed, as these chapters must be reworked &Glossary; &Index; &AppHowItWorks; - &ChapterTroubleshoot; + &ChapterTroubleshoot; --> </book> diff --git a/docbook/wsug_graphics/ws-stats-compare.png b/docbook/wsug_graphics/ws-stats-compare.png Binary files differnew file mode 100755 index 0000000000..462ca9c3e6 --- /dev/null +++ b/docbook/wsug_graphics/ws-stats-compare.png diff --git a/docbook/wsug_src/WSUG_chapter_statistics.xml b/docbook/wsug_src/WSUG_chapter_statistics.xml index 3fa2ed79cc..f2b9fb3d05 100644 --- a/docbook/wsug_src/WSUG_chapter_statistics.xml +++ b/docbook/wsug_src/WSUG_chapter_statistics.xml @@ -594,14 +594,102 @@ </para> </section> </section> -<!-- <section id="ChStatCompareCaptureFiles"> <title>Compare two capture files</title> <para> Compare two capture files. </para> + + <para> + This feature works best when you have merged two capture files + chronologically, one from each side of a client/server connection. + </para> + + <para> + The merged capture data is checked for missing packets. If a matching + connection is found it is checked for: + <itemizedlist> + <listitem> + <para> + IP header checksums + </para> + </listitem> + <listitem> + <para> + Excessive delay (defined by the "Time variance" setting) + </para> + </listitem> + <listitem> + <para> + Packet order + </para> + </listitem> + </itemizedlist> + </para> + + <figure><title>The "Compare" window</title> + <graphic entityref="WiresharkStatsCompare" format="PNG"/> + </figure> + + <para> + You can configure the following: + <itemizedlist> + <listitem> + <para> + <command>Start compare:</command> Start comparing when this many + IP IDs are matched. A zero value starts comparing immediately. + </para> + </listitem> + <listitem> + <para> + <command>Stop compare:</command> Stop comparing when we can no longer + match this many IP IDs. Zero always compares. + </para> + </listitem> + <listitem> + <para> + <command>Endpoint distinction:</command> Use MAC addresses or IP + time-to-live values to determine connection enpoints. + </para> + </listitem> + <listitem> + <para> + <command>Check order:</command> Check for the same IP ID in the + previous packet at each end. + </para> + </listitem> + <listitem> + <para> + <command>Time variance:</command> Trigger an error if the packet + arrives this many milliseconds after the average delay. + </para> + </listitem> + <listitem> + <para> + <command>Filter:</command> Limit comparison to packets that match + this display filter. + </para> + </listitem> + </itemizedlist> + </para> + + <para> + The info column contains new numbering so the same packets are parallel. + </para> + <para> + The color filtering differentiate the two files from each other. A + “zebra” effect is create if the Info column is sorted. + </para> + + <tip><title>Tip!</title> + <para> + If you click on an item in the error list its corresponding packet will + be selected in the main window. + </para> + </tip> + + </section> ---> <section id="ChStatWLANTraffic"> <title>WLAN Traffic Statistics</title> <para> |