aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGerald Combs <gerald@wireshark.org>1998-10-13 02:10:57 +0000
committerGerald Combs <gerald@wireshark.org>1998-10-13 02:10:57 +0000
commit554e5d3f46ed36f866f40db9b9f2bdd8c4a7ea08 (patch)
tree1c04f0a8a506b8a8826ec8b4ff9a1946b2845a09 /doc
parent36607dd2d32e7d4ba31b2948edf833170b06a213 (diff)
* Pod page update
* Minor tweaks to the filter prefs svn path=/trunk/; revision=40
Diffstat (limited to 'doc')
-rw-r--r--doc/ethereal.pod106
1 files changed, 62 insertions, 44 deletions
diff --git a/doc/ethereal.pod b/doc/ethereal.pod
index cd06031b6b..e5f596609f 100644
--- a/doc/ethereal.pod
+++ b/doc/ethereal.pod
@@ -101,31 +101,32 @@ Sets the default capture file name.
=over 4
-=item File:Open, File:Close
+=item File:Open, File:Close, File:Reload
-Open or close a capture file.
+Open, close, or reload a capture file.
=item File:Print Packet
Print a description of each protocol header found in the packet, followed
by the packet data itself. Printing options can be set with the
-I<Edit:Menu Options> menu item.
+I<Edit:Preferences> menu item.
=item File:Quit
Exits the application.
-=item Edit:Printer Options
+=item Edit:Preferences
-Sets the packet printing options (see L<"Printer Options"> below).
+Sets the packet printing and filter options (see L<"Preferences"> below).
=item Tools:Capture
Initiates a live packet capture (see L<"Capture Preferences"> below).
-=item Tools:Filter
+=item Tools:Follow TCP Stream
-Sets the filter preferences (see L<"Filters"> below).
+If you have a TCP packet selected, it will display the contents of the TCP
+data stream in a separate window.
=back
@@ -135,66 +136,63 @@ Sets the filter preferences (see L<"Filters"> below).
=item Main Window
-The main window is split into three sections. You can resize each section
-using a "thumb" at the right end of each divider line. An informational
-message is also displayed at the bottom of the main window.
+The main window is split into three panes. You can resize each pane using
+a "thumb" at the right end of each divider line. Below the panes is a
+strip that shows the file load progress, current filter, and informational
+text.
-The top section contains the list of network packets that you can scroll
+The top pane contains the list of network packets that you can scroll
through and select. The packet number, packet timestamp, source and
destination addresses, protocol, and description are printed for each
packet. An effort is made to display information as high up the protocol
stack as possible, e.g. IP addresses are displayed for IP packets, but the
MAC layer address is displayed for unknown packet types.
-The middle section contains a I<protocol tree> for the currently-selected
+The middle pane contains a I<protocol tree> for the currently-selected
packet. The tree displays each field and its value in each protocol header
in the stack.
-The bottom section contains a hex dump of the actual packet data.
-Selecting a field in the I<protocol tree> highlights the appropriate bytes
-in this section.
+The lowest pane contains a hex dump of the actual packet data.
+Selecting a field in the I<protocol tree> highlights the corresponding
+bytes in this section.
-=item Printer Options
+A display filter can be entered into the strip at the bottom. It must
+have the same format as B<tcpdump> filter strings, since both programs use
+the same underlying library. A filter for HTTP, HTTPS, and DNS traffic
+might look like this:
-The I<Printer Options> dialog lets you select the output format of packets
-printed using the I<File:Print Packet> menu item.
+ tcp port 80 or tcp port 443 or port 53
-The radio buttons at the top of the dialog allow you choose between
-printing the packets as text or PostScript, and sending the output
-directly to a command or saving it to a file. The I<Command:> text entry
-box is the command to send files to (usually B<lpr>), and the I<File:>
-entry box lets you enter the name of the file you wish to save to.
-Additinally, you can select the I<File:> button to browse the file system
-for a particular save file.
+Selecting the I<Filter:> button lets you choose from a list of named
+filters that you can optionally save.
-=item Capture Preferences
+=item Preferences
-The I<Capture Preferences> dialog lets you specify various parameters for
-capturing live packet data.
+The I<Preferences> dialog lets you select the output format of packets
+printed using the I<File:Print Packet> menu item and configure
+commonly-used filters.
-The I<Interface:> entry box lets you specify the interface from which to
-capture packet data. The I<Count:> entry specifies the number of packets
-to capture. Entering 0 will capture packets indefinitely. The I<File:>
-entry specifies the file to save to, as in the I<Printer Options> dialog
-above. You can choose to open the file after capture, and you can also
-specify the maximum number of bytes to capture per packet with the
-I<Capture length> entry.
+=over 6
+
+=item Printing Preferences
+
+The radio buttons at the top of the I<Printing> page allow you choose
+between printing the packets as text or PostScript, and sending the
+output directly to a command or saving it to a file. The I<Command:> text
+entry box is the command to send files to (usually B<lpr>), and the
+I<File:> entry box lets you enter the name of the file you wish to save
+to. Additinally, you can select the I<File:> button to browse the file
+system for a particular save file.
=item Filters
-The I<Filters> dialog lets you create and modify filters, and set the
+The I<Filters> page lets you create and modify filters, and set the
default filter to use when capturing data or opening a capture file.
The I<Filter name> entry specifies a descriptive name for a filter, e.g.
B<Web and DNS traffic>. The I<Filter string> entry is the text that
-actually describes the filtering action to take. It must have the same
-format as B<tcpdump> filter strings, since both programs use the same
-underlying library. A filter for HTTP, HTTPS, and DNS traffic might look
-like this:
-
- tcp port 80 or tcp port 443 or port 53
-
-The dialog buttons perform the following actions:
+actually describes the filtering action to take, as described above.The
+dialog buttons perform the following actions:
=over 8
@@ -229,6 +227,26 @@ Saves the current filter list in F<$HOME/.ethereal/filters>.
Closes the dialog without making any changes.
+=back
+
+=back
+
+=item Capture Preferences
+
+The I<Capture Preferences> dialog lets you specify various parameters for
+capturing live packet data.
+
+The I<Interface:> entry box lets you specify the interface from which to
+capture packet data. The I<Count:> entry specifies the number of packets
+to capture. Entering 0 will capture packets indefinitely. The I<Filter:>
+entry lets you specify the capture filter using a tcpdump-style filter
+string as described above. The I<File:> entry specifies the file to save
+to, as in the I<Printer Options> dialog above. You can choose to open the
+file after capture, and you can also specify the maximum number of bytes
+to capture per packet with the I<Capture length> entry.
+
+=back
+
=head1 SEE ALSO
L<tcpdump(1)>, L<pcap(3)>