Updated the statusbar documentation:
authorStig Bjørlykke <stig@bjorlykke.org>
Sat, 21 Jun 2008 17:30:44 +0000 (17:30 -0000)
committerStig Bjørlykke <stig@bjorlykke.org>
Sat, 21 Jun 2008 17:30:44 +0000 (17:30 -0000)
- Added description of the expert info bullet
- Added description of the configuration profile with menu
- Show the correct Packets/Displayed/Marked(/Dropped) names
- Describe the display filter message when using the != operator

svn path=/trunk/; revision=25513

docbook/user-guide.xml
docbook/wsug_graphics/ws-statusbar-empty.png
docbook/wsug_graphics/ws-statusbar-filter.png [new file with mode: 0644]
docbook/wsug_graphics/ws-statusbar-loaded.png
docbook/wsug_graphics/ws-statusbar-profile.png [new file with mode: 0644]
docbook/wsug_graphics/ws-statusbar-selected.png
docbook/wsug_src/WSUG_chapter_use.xml

index 1bbf2b808a998ac3f397a6bf7f18753fdddd29de..56997b9a573a910f6bcae870883ab789a0756216 100644 (file)
@@ -158,7 +158,9 @@ FILE SECTION
   <!ENTITY WiresharkBytesPaneTabs SYSTEM "./wsug_graphics/ws-bytes-pane-tabs.png" NDATA PNG>
   <!ENTITY WiresharkStatusbarEmpty SYSTEM "./wsug_graphics/ws-statusbar-empty.png" NDATA PNG>
   <!ENTITY WiresharkStatusbarLoaded SYSTEM "./wsug_graphics/ws-statusbar-loaded.png" NDATA PNG>
+  <!ENTITY WiresharkStatusbarProfile SYSTEM "./wsug_graphics/ws-statusbar-profile.png" NDATA PNG>
   <!ENTITY WiresharkStatusbarSelected SYSTEM "./wsug_graphics/ws-statusbar-selected.png" NDATA PNG>
+  <!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>  
index fb5a03afd3606fd9c3bc948f9aacea0d5206a6b0..562a9815b7553dacd6130b9ef4c158991531b5f0 100644 (file)
Binary files a/docbook/wsug_graphics/ws-statusbar-empty.png and b/docbook/wsug_graphics/ws-statusbar-empty.png differ
diff --git a/docbook/wsug_graphics/ws-statusbar-filter.png b/docbook/wsug_graphics/ws-statusbar-filter.png
new file mode 100644 (file)
index 0000000..267e768
Binary files /dev/null and b/docbook/wsug_graphics/ws-statusbar-filter.png differ
index 1ef0ac4cbe0ad38336c4fc6ba5957d7898d0627d..663b90cbbfed174b61d48672c8408b42320975dc 100644 (file)
Binary files a/docbook/wsug_graphics/ws-statusbar-loaded.png and b/docbook/wsug_graphics/ws-statusbar-loaded.png differ
diff --git a/docbook/wsug_graphics/ws-statusbar-profile.png b/docbook/wsug_graphics/ws-statusbar-profile.png
new file mode 100644 (file)
index 0000000..309e403
Binary files /dev/null and b/docbook/wsug_graphics/ws-statusbar-profile.png differ
index b8b4bd68a3d70d0d008138e9d26d82f4f940320b..f0261ac48489a9254764fc914ded0de5febdf36a 100644 (file)
Binary files a/docbook/wsug_graphics/ws-statusbar-selected.png and b/docbook/wsug_graphics/ws-statusbar-selected.png differ
index 35462821f73b67858d253d1ba99aae2b01e116cd..98b0b62fc9edfc0d4322f0e2900176df6ab06e74 100644 (file)
       The statusbar displays informational messages.
     </para>
     <para>
-       In general, the left side will show context related information, while the
-       right side will show the current number of packets.
+      In general, the left side will show context related information, the
+      middle part will show the current number of packets, and the right side will
+      show the selected configuration profile.  Drag the handles between the text
+      areas to change the size.
     </para>
     <para>
-    <figure id="ChUseWiresharkStatusbarEmpty">
-      <title>The initial Statusbar</title>
-      <graphic entityref="WiresharkStatusbarEmpty" format="PNG"/>
-    </figure>
-       This statusbar is shown while no capture file is loaded, e.g. when
-       Wireshark is started.
+      <figure id="ChUseWiresharkStatusbarEmpty">
+       <title>The initial Statusbar</title>
+       <graphic entityref="WiresharkStatusbarEmpty" format="PNG"/>
+      </figure>
+      This statusbar is shown while no capture file is loaded, e.g. when
+      Wireshark is started.
+    </para>
+    <para>
+      <figure id="ChUseWiresharkStatusbarLoaded">
+       <title>The Statusbar with a loaded capture file</title>
+       <graphic entityref="WiresharkStatusbarLoaded" format="PNG"/>
+      </figure>
+    </para>
+    <itemizedlist>
+      <listitem>
+       <para>
+         <command>The colorized bullet</command> 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 <xref linkend="ChAdvExpert"/>.
        </para>
+      </listitem>
+      <listitem>
        <para>
-               <figure id="ChUseWiresharkStatusbarLoaded">
-                 <title>The Statusbar with a loaded capture file</title>
-                 <graphic entityref="WiresharkStatusbarLoaded" format="PNG"/>
-               </figure>
-               The left side shows information about the capture file, its
-               name, its size and the elapsed time while it was being captured.
+         <command>The left side</command> shows information about the capture file, its
+         name, its size and the elapsed time while it was being captured.
        </para>
+      </listitem>
+      <listitem>
        <para>
-               The right side shows the current number of packets in the
-               capture file. The following values are displayed:
-           <itemizedlist mark="bullet">
+         <command>The middle part</command> shows the current number of packets in the capture file. 
+         The following values are displayed:
+         <itemizedlist mark="bullet">
            <listitem>
-               <para><emphasis>P:</emphasis> the number of captured packets</para>
+             <para><emphasis>Packets:</emphasis> the number of captured packets</para>
            </listitem>
            <listitem>
-               <para><emphasis>D:</emphasis> the number of packets currently being
-               displayed</para>
+             <para><emphasis>Displayed:</emphasis> the number of packets currently being
+             displayed</para>
            </listitem>
            <listitem>
-               <para><emphasis>M:</emphasis> the number of marked packets</para>
+             <para><emphasis>Marked:</emphasis> the number of marked packets</para>
            </listitem>
-           </itemizedlist>
+         </itemizedlist>
+         If Wireshark was unable to capture all packets the following value is also displayed:
+         <itemizedlist mark="bullet">
+           <listitem>
+             <para><emphasis>Dropped:</emphasis> the number of dropped packets</para>
+           </listitem>
+         </itemizedlist>
        </para>
+      </listitem>
+      <listitem>
        <para>
-    <figure id="ChUseWiresharkStatusbarSelected">
-      <title>The Statusbar with a selected protocol field</title>
-      <graphic entityref="WiresharkStatusbarSelected" format="PNG"/>
-    </figure>
-               This is displayed if you have selected a protocol field from the
-               "Packet Details" pane.
+         <command>The left side</command> 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 configuration profile.
+       </para>
+      </listitem>
+    </itemizedlist>
+    <para>
+      <figure id="ChUseWiresharkStatusbarProfile">
+       <title>The Statusbar with a configuration profile menu</title>
+       <graphic entityref="WiresharkStatusbarProfile" format="PNG"/>
+      </figure>
+      For a detailed description of configuration profiles, see 
+      <xref linkend="ChCustConfigProfilesSection"/>.
+    </para>
+    <para>
+      <figure id="ChUseWiresharkStatusbarSelected">
+       <title>The Statusbar with a selected protocol field</title>
+       <graphic entityref="WiresharkStatusbarSelected" format="PNG"/>
+      </figure>
+      This is displayed if you have selected a protocol field from the
+      "Packet Details" pane.
     </para>
     <tip><title>Tip!</title>
-       <para>
-               The value between the brackets (in this example
-               <command>arp.opcode</command>) can be used as a display filter string,
-               representing the selected protocol field.
-       </para>
+    <para>
+      The value between the brackets (in this example
+      <command>arp.opcode</command>) can be used as a display filter string,
+      representing the selected protocol field.
+    </para>
     </tip>
+    <para>
+      <figure id="ChUseWiresharkStatusbarFilter">
+       <title>The Statusbar with a display filter message</title>
+       <graphic entityref="WiresharkStatusbarFilter" format="PNG"/>
+      </figure>
+      This is displayed if you are trying to use a display filter with
+      unexpected results.  For a detailed description of the display filter,
+      see <xref linkend="ChWorkBuildDisplayFilterSection"/>.
+    </para>
+
   </section>
 
 </chapter>