osmith
/
wireshark
forked from osmocom/wireshark
1
0
Fork 0
Code Pull Requests Releases Wiki Activity

Updated some chapters in the User Guide. 

svn path=/trunk/; revision=25523
This commit is contained in:
Stig Bjørlykke 2008-06-22 13:25:57 +00:00
parent 50e372dd66
commit 55b2064946
4 changed files with 229 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docbook/wsug_graphics/ws-menu.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 751 B

After

Width:  |  Height:  |  Size: 3.8 KiB

24
docbook/wsug_src/WSUG_chapter_io.xml
View File

@ -858,6 +858,30 @@
</para></listitem>
</itemizedlist>
</para>
</section>
<section id="ChIOExportCArraysDialog">
<title>The "Export as C Arrays (packet bytes) file" dialog box</title>
<para>XXX - add screenshot</para>
<para>
Export packet bytes into C arrays so you can import the stream data
into your own C program.
<!--
<figure>
<title>The "Export as C Arrays (packet bytes) file" dialog box</title>
<graphic entityref="WiresharkExportCArraysDialog" format="PNG"/>
</figure>
-->
<itemizedlist>
<listitem><para>
<command>Export to file:</command> frame chooses the file to export
the packet data to.
</para></listitem>
<listitem><para>
The <command>Packet Range</command> frame is described in <xref
linkend="ChIOPacketRangeSection"/>.
</para></listitem>
</itemizedlist>
</para>
</section>
<section id="ChIOExportPSMLDialog">
<title>The "Export as PSML File" dialog box</title>

217
docbook/wsug_src/WSUG_chapter_use.xml
View File

@ -319,6 +319,15 @@
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>Tools</command></term>
<listitem>
<para>
This menu contains various tools available in Wireshark, such as
creating Firewall ACL Rules.
See <xref linkend="ChUseToolsMenuSection"/>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>Help</command></term>
<listitem>
<para>
@ -506,6 +515,22 @@
<xref linkend="ChIOExportCSVDialog"/>).
</para></entry>
</row>
<row>
<entry><command>Export > as "C Arrays" (packet bytes) file...</command></entry>
<entry></entry>
<entry><para>
This menu item allows you to export all (or some) of the packet bytes in
the capture file to a .c file so you can import the stream data into your
own C program.
It pops up the Wireshark Export dialog box (which is discussed further in
<xref linkend="ChIOExportCArraysDialog"/>).
</para></entry>
</row>
<row>
<entry><command>------</command></entry>
<entry></entry>
<entry></entry>
</row>
<row>
<entry><command>Export > as "PSML" file...</command></entry>
<entry></entry>
@ -526,6 +551,11 @@
<xref linkend="ChIOExportPDMLDialog"/>).
</para></entry>
</row>
<row>
<entry><command>------</command></entry>
<entry></entry>
<entry></entry>
</row>
<row>
<entry><command>Export > Selected Packet Bytes...</command></entry>
<entry>Ctrl+H</entry>
@ -536,6 +566,15 @@
<xref linkend="ChIOExportSelectedDialog"/>)
</para></entry>
</row>
<row>
<entry><command>Objects > HTTP</command></entry>
<entry></entry>
<entry><para>
This menu item allows you to export all or some of the captured HTTP objects
into local files. It pops up the Wireshark HTTP object list (which is discussed
further in <xref linkend="ChIOExportObjectsDialog"/>)
</para></entry>
</row>
<row>
<entry><command>------</command></entry>
<entry></entry>
@ -705,6 +744,15 @@
<entry></entry>
<entry></entry>
</row>
<row>
<entry><command>Configuration Profiles...</command></entry>
<entry>Shift-Ctrl-A</entry>
<entry><para>
This menu item brings up a dialog box for handling configuration
profiles. More detail is provided in
<xref linkend="ChCustConfigProfilesSection"/>.
</para></entry>
</row>
<row>
<entry><command>Preferences...</command></entry>
<entry>Shift+Ctrl+P</entry>
@ -854,6 +902,15 @@
<xref linkend="ChWorkTimeFormatsSection"/>.
</para></entry>
</row>
<row>
<entry><command>Time Display Format > Seconds Since Epoch (1970-01-01): 1234567890.123456</command></entry>
<entry></entry>
<entry><para>
Selecting this tells Wireshark to display time stamps in
seconds since 1970-01-01 00:00:00, see
<xref linkend="ChWorkTimeFormatsSection"/>.
</para></entry>
</row>
<row>
<entry><command>Time Display Format > ------</command></entry>
<entry></entry>
@ -1307,6 +1364,17 @@
<xref linkend="ChWorkDefineFilterSection"/>
</para></entry>
</row>
<row>
<entry><command>Display Filter Macros...</command></entry>
<entry></entry>
<entry><para>
This menu item brings up a dialog box that allows you
to create and edit display filter macros. You can name
filter macros, and you can save them for future use. More
detail on this subject is provided in
<xref linkend="ChWorkDefineFilterMacrosSection"/>
</para></entry>
</row>
<row>
<entry><command>Apply as Filter > ...</command></entry>
<entry></entry>
@ -1327,19 +1395,6 @@
by the selected protocol field in the packet details pane.
</para></entry>
</row>
<row>
<entry><command>Firewall ACL Rules</command></entry>
<entry></entry>
<entry><para>
This allows you to create command-line ACL rules for many different
firewall products, including Cisco IOS, Linux Netfilter (iptables),
OpenBSD pf and Windows Firewall (via netsh). Rules for MAC addresses,
IPv4 addresses, TCP and UDP ports, and IPv4+port combinations are
supported.
</para><para>
It is assumed that the rules will be applied to an outside interface.
</para></entry>
</row>
<row>
<entry><command>------</command></entry>
<entry></entry>
@ -1421,6 +1476,14 @@
together for faster analysis.
</para></entry>
</row>
<row>
<entry><command>Conversation Filter > ...</command></entry>
<entry></entry>
<entry><para>
In this menu you will find conversation filter for various
protocols.
</para></entry>
</row>
</tbody>
</tgroup>
</table>
@ -1533,6 +1596,11 @@
<entry></entry>
<entry><para>See <xref linkend="ChStatXXX"/></para></entry>
</row>
<row>
<entry><command>Fax T38 Analysis...</command></entry>
<entry></entry>
<entry><para>See <xref linkend="ChStatXXX"/></para></entry>
</row>
<row>
<entry><command>GSM</command></entry>
<entry></entry>
@ -1543,11 +1611,6 @@
<entry></entry>
<entry><para>See <xref linkend="ChStatXXX"/></para></entry>
</row>
<row>
<entry><command>ISUP Message Types</command></entry>
<entry></entry>
<entry><para>See <xref linkend="ChStatXXX"/></para></entry>
</row>
<row>
<entry><command>MTP3</command></entry>
<entry></entry>
@ -1584,7 +1647,12 @@
<entry></entry>
</row>
<row>
<entry><command>BOOTP-DHCP</command></entry>
<entry><command>BOOTP-DHCP...</command></entry>
<entry></entry>
<entry><para>See <xref linkend="ChStatXXX"/></para></entry>
</row>
<row>
<entry><command>Flow Graph...</command></entry>
<entry></entry>
<entry><para>See <xref linkend="ChStatXXX"/></para></entry>
</row>
@ -1593,6 +1661,21 @@
<entry></entry>
<entry><para>HTTP request/response statistics, see <xref linkend="ChStatXXX"/></para></entry>
</row>
<row>
<entry><command>IP Addresses...</command></entry>
<entry></entry>
<entry><para>See <xref linkend="ChStatXXX"/></para></entry>
</row>
<row>
<entry><command>IP Destinations...</command></entry>
<entry></entry>
<entry><para>See <xref linkend="ChStatXXX"/></para></entry>
</row>
<row>
<entry><command>IP Protocol Types...</command></entry>
<entry></entry>
<entry><para>See <xref linkend="ChStatXXX"/></para></entry>
</row>
<row>
<entry><command>ISUP Messages</command></entry>
<entry></entry>
@ -1603,11 +1686,78 @@
<entry></entry>
<entry><para>See <xref linkend="ChStatXXX"/></para></entry>
</row>
<row>
<entry><command>Packet Lengths...</command></entry>
<entry></entry>
<entry><para>See <xref linkend="ChStatXXX"/></para></entry>
</row>
<row>
<entry><command>SMPP Operations...</command></entry>
<entry></entry>
<entry><para>See <xref linkend="ChStatXXX"/></para></entry>
</row>
<row>
<entry><command>TCP Stream Graph</command></entry>
<entry></entry>
<entry><para>See <xref linkend="ChStatXXX"/></para></entry>
</row>
<row>
<entry><command>UCP Messages...</command></entry>
<entry></entry>
<entry><para>See <xref linkend="ChStatXXX"/></para></entry>
</row>
<row>
<entry><command>UDP Multicast Streams</command></entry>
<entry></entry>
<entry><para>See <xref linkend="ChStatXXX"/></para></entry>
</row>
<row>
<entry><command>WLAN Traffic</command></entry>
<entry></entry>
<entry><para>See <xref linkend="ChStatWLANTraffic"/></para></entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section id="ChUseToolsMenuSection"><title>The "Tools" menu</title>
<para>
The Wireshark Tools menu contains the fields shown in
<xref linkend="ChUseTools"/>.
</para>
<!--
<figure id="ChUseWiresharkToolsMenu">
<title>The "Tools" Menu</title>
<graphic entityref="WiresharkToolsMenu" format="PNG"/>
</figure>
-->
<table id="ChUseTools" frame="none">
<title>Tools menu items</title>
<tgroup cols="3">
<colspec colnum="1" colwidth="72pt"/>
<colspec colnum="2" colwidth="80pt"/>
<thead>
<row>
<entry>Menu Item</entry>
<entry>Accelerator</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><command>Firewall ACL Rules</command></entry>
<entry></entry>
<entry><para>
This allows you to create command-line ACL rules for many different
firewall products, including Cisco IOS, Linux Netfilter (iptables),
OpenBSD pf and Windows Firewall (via netsh). Rules for MAC addresses,
IPv4 addresses, TCP and UDP ports, and IPv4+port combinations are
supported.
</para><para>
It is assumed that the rules will be applied to an outside interface.
</para></entry>
</row>
</tbody>
</tgroup>
</table>
@ -1643,11 +1793,10 @@
</para></entry>
</row>
<row>
<entry><command>Supported Protocols</command></entry>
<entry><command>FAQ's</command></entry>
<entry></entry>
<entry><para>
This menu item brings up a dialog box showing the supported
protocols and protocol fields.
This menu item starts a Web browser showing various FAQ's.
</para></entry>
</row>
<row>
@ -1658,6 +1807,11 @@
installed html manual pages.
</para></entry>
</row>
<row>
<entry><command>------</command></entry>
<entry></entry>
<entry></entry>
</row>
<row>
<entry><command>Wireshark Online > ...</command></entry>
<entry></entry>
@ -1672,6 +1826,19 @@
<entry></entry>
<entry></entry>
</row>
<row>
<entry><command>Supported Protocols (slow!)</command></entry>
<entry></entry>
<entry><para>
This menu item brings up a dialog box showing the supported
protocols and protocol fields.
</para></entry>
</row>
<row>
<entry><command>------</command></entry>
<entry></entry>
<entry></entry>
</row>
<row>
<entry><command>About Wireshark</command></entry>
<entry></entry>
@ -2332,11 +2499,9 @@
<listitem>
<para><emphasis>Marked:</emphasis> the number of marked packets</para>
</listitem>
</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>
<para><emphasis>Dropped:</emphasis> the number of dropped packets (only displayed
if Wireshark was unable to capture all packets)</para>
</listitem>
</itemizedlist>
</para>

14
docbook/wsug_src/WSUG_chapter_work.xml
View File

@ -1219,6 +1219,17 @@ eth.src[1-2] == 00:83
</para>
</section>
<section id="ChWorkDefineFilterMacrosSection"><title>Defining and saving filter macros</title>
<para>
You can define filter macros with Wireshark and give them labels for
later use. This can save time in remembering and retyping some of
the more complex filters you use.
</para>
<para>
XXX - add an explanation of this.
</para>
</section>
<section id="ChWorkFindPacketSection"><title>Finding packets</title>
<para>
You can easily find packets once you have captured some packets or
@ -1440,6 +1451,9 @@ eth.src[1-2] == 00:83
<listitem><para><command>Seconds Since Previous Displayed Packet: 1.123456</command>
The time relative to the previous displayed packet.</para>
</listitem>
<listitem><para><command>Seconds Since Epoch (1970-01-01): 1234567890.123456</command>
The time relative to epoch (midnight UTC of January 1, 1970).</para>
</listitem>
</itemizedlist>
</para>
<para>