From ba22fd6da0503da55c5a3e5187b45190609a7af3 Mon Sep 17 00:00:00 2001 From: gerald Date: Wed, 16 Sep 1998 02:39:15 +0000 Subject: Initial revision git-svn-id: http://anonsvn.wireshark.org/wireshark/trunk@2 f5534014-38df-0310-8fa8-9805f1628bb7 --- doc/Makefile | 5 ++ doc/ethereal.pod | 233 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 238 insertions(+) create mode 100644 doc/Makefile create mode 100644 doc/ethereal.pod (limited to 'doc') diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000000..6105c9ca05 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,5 @@ +../ethereal.1: ethereal.pod + pod2man ethereal.pod \ + --center="The Ethereal Network Analyzer" \ + --release=`cat ../VERSION` \ + > ../ethereal.1 diff --git a/doc/ethereal.pod b/doc/ethereal.pod new file mode 100644 index 0000000000..f987e7103a --- /dev/null +++ b/doc/ethereal.pod @@ -0,0 +1,233 @@ + +=head1 NAME + +Ethereal - Interactively browse network traffic + +=head1 SYNOPSYS + +B +S<[ B<-v> ]> +S<[ B<-B> byte view height ]> +S<[ B<-c> count ]> +S<[ B<-i> interface ]> +S<[ B<-P> packet list height ]> +S<[ B<-r> infile ]> +S<[ B<-s> snaplen ]> +S<[ B<-T> tree view height ]> +S<[ B<-w> savefile]> + +=head1 DESCRIPTION + +B is a network protocol analyzer based on the B GUI toolkit. It lets +you interactively browse packet data from a live network or from a B +/ B formatted capture file. + +=head1 OPTIONS + +=over 4 + +=item -B + +Sets the initial height of the byte view (bottom) pane + +=item -c + +The default number of packets to read when capturing live data. + +=item -i + +The name of the interface to use for live packet capture. It should match +one of the names listed in "B" or "B". + +=item -P + +Sets the initial height of the packet list (top) pane + +=item -r + +Read packet data from I. Currently, B only understands +B / B formatted files. + +=item -s + +The default snapshot length to use when capturing live data. No more than +I bytes of each network packet will be read into memory, or saved +to disk. + +=item -T + +Sets the initial height of the tree view (top) pane + +=item -v + +Prints the version and exits. + +=item -w + +Sets the default capture file name. + +=back + +=head1 INTERFACE + +=head2 MENU ITEMS + +=over 4 + +=item File:Open, File:Close + +Open or close 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 menu item. + +=item File:Quit + +Exits the application. + +=item Edit:Printer Options + +Sets the packet printing options (see L<"Printer Options"> below). + +=item Tools:Capture + +Initiates a live packet capture (see L<"Capture Preferences"> below). + +=item Tools:Filter + +Sets the filter preferences (see L<"Filters"> below). + +=back + +=head2 WINDOWS + +=over 4 + +=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 top section contains the list of network packets that you can scroll +through and select. The packet number, 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 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 highlights the appropriate bytes +in this section. + +=item Printer Options + +The I dialog lets you select the output format of packets +printed using the I menu item. + +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 text entry +box is the command to send files to (usually B), and the I +entry box lets you enter the name of the file you wish to save to. +Additinally, you can select the I button to browse the file system +for a particular save file. + +=item Capture Preferences + +The I dialog lets you specify various parameters for +capturing live packet data. + +The I entry box lets you specify the interface from which to +capture packet data. The I entry specifies the number of packets +to capture. Entering 0 will capture packets indefinitely. The I +entry specifies the file to save to, as in the I 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 entry. + +=item Filters + +The I dialog lets you create and modify filters, and set the +default filter to use when capturing data or opening a capture file. + +The I entry specifies a descriptive name for a filter, e.g. +B. The I entry is the text that +actually describes the filtering action to take. It must have the same +format as B 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: + +=over 8 + +=item New + +If there is text in the two entry boxes, it creates a new associated list +item. + +=item Change + +Modifies the currently selected list item to match what's in the entry +boxes. + +=item Copy + +Makes a copy of the currently selected list item. + +=item Delete + +Deletes the currently selected list item. + +=item OK + +Sets the currently selected list item as the active filter. If nothing +is selected, turns filtering off. + +=item Save + +Saves the current filter list in F<$HOME/.ethereal/filters>. + +=item Cancel + +Closes the dialog without making any changes. + +=head1 SEE ALSO + +L, L + +=head1 NOTES + +The latest version of B can be found at +B. + +=head1 AUTHORS + + Original Author + -------- ------ + Gerald Combs + + + Contributors + ------------ + Gilbert Ramirez Jr. + Hannes R. Boehm + Mike Hall + cpg + + +Theo de Raadt was kind enough to give his +permission to use his version of snprintf.c. + +Dan Lasley gave permission for his dumpit() hex-dump +routine to be used. -- cgit v1.2.3