1 <!-- WSUG Chapter IO -->
4 <chapter id="ChapterIO">
5 <title>File Input / Output and Printing</title>
7 <section id="ChIOIntroductionSection"><title>Introduction</title>
9 This chapter will describe input and output of capture data.
13 Open capture files in various capture file formats
18 Save/Export capture files in various capture file formats
23 Merge capture files together
28 Import text files containing hex dumps of packets
40 <section id="ChIOOpenSection"><title>Open capture files</title>
42 Wireshark can read in previously saved capture files.
43 To read them, simply select the menu or toolbar item: "File/
44 <inlinegraphic entityref="WiresharkToolbarOpen" format="PNG"/>
45 <command>Open</command>".
46 Wireshark will then pop up the File
47 Open dialog box, which is discussed in more detail in
48 <xref linkend="ChIOOpen"/>.
50 <tip><title>It's convenient to use drag-and-drop!</title>
52 ... to open a file, by simply dragging the desired file from your file
53 manager and dropping it onto Wireshark's main window.
54 However, drag-and-drop is not available/won't work in all desktop
59 If you haven't previously saved the current capture file, you will be asked
60 to do so, to prevent data loss (this behaviour can be disabled in the
64 In addition to its native file format (libpcap format, also used by
65 tcpdump/WinDump and other libpcap/WinPcap-based programs), Wireshark can
66 read capture files from a large number of other packet capture programs
67 as well. See <xref linkend="ChIOInputFormatsSection"/> for the list of
68 capture formats Wireshark understands.
71 <section id="ChIOOpen">
72 <title>The "Open Capture File" dialog box</title>
74 The "Open Capture File" dialog box allows you to search for a
75 capture file containing previously captured packets for display in
76 Wireshark. <xref linkend="ChIOOpenFileTab"/> shows some examples
77 of the Wireshark Open File Dialog box.
80 <title>The dialog appearance depends on your system!</title>
82 The appearance of this dialog depends on the system and/or GTK+
83 toolkit version used. However, the functionality remains basically
84 the same on any particular system.
89 <command>Common dialog behaviour</command> on all systems:
94 Select files and directories.
99 Click the Open/Ok button to accept your selected file and open it.
104 Click the Cancel button to go back to Wireshark and not load a capture
111 <command>Wireshark extensions</command> to the standard behaviour of
117 View file preview information (like the filesize, the number of
118 packets, ...), if you've selected a capture file.
123 Specify a display filter with the "Filter:" button and filter
124 field. This filter will be used when opening the new file.
125 The text field background becomes green for a valid filter string
126 and red for an invalid one.
127 Clicking on the Filter button causes Wireshark to pop up
128 the Filters dialog box (which is discussed further in
129 <xref linkend="ChWorkDisplayFilterSection"/>).
132 XXX - we need a better description of these read filters
137 Specify which type of name resolution is to be performed for all packets by
138 clicking on one of the "... name resolution" check buttons.
139 Details about name resolution can be found in
140 <xref linkend="ChAdvNameResolutionSection"/>.
145 <tip><title>Save a lot of time loading huge capture files!</title>
147 You can change the display filter and name resolution settings later
148 while viewing the packets.
149 However, loading huge capture files can take a significant amount of
150 extra time if these settings are changed later, so in such situations it can
151 be a good idea to set at least the filter in advance here.
155 <!-- frame="none" -->
156 <table id="ChIOOpenFileTab">
157 <title>The system specific "Open Capture File" dialog box</title>
163 <figure id="ChIOOpenFileDialogWin32">
164 <title>"Open" on native Windows</title>
165 <graphic entityref="WiresharkOpenDialogWin32" format="PNG"/>
170 <para><command>Microsoft Windows</command></para>
172 This is the common Windows file open dialog -
173 plus some Wireshark extensions.
176 Specific for this dialog:
181 If available, the "Help" button will lead you to this section of
187 The "Filter:" button currently doesn't work on Windows!
196 <figure id="ChIOOpenFileDialog">
197 <title>"Open" - new GTK version</title>
198 <graphic entityref="WiresharkOpenDialog24" format="PNG"/>
203 <para><command>Unix/Linux: GTK version >= 2.4</command></para>
205 This is the common Gimp/GNOME file open dialog -
206 plus some Wireshark extensions.
209 Specific for this dialog:
214 The "+ Add" button allows you to add a directory, selected in the
215 right-hand pane, to the favorites list on the left. Those changes
221 The "- Remove" button allows you to remove a selected directory from
222 that list again (the items like: "Home", "Desktop", and "Filesystem"
228 If Wireshark doesn't recognize the selected file as a capture file,
229 it will grey out the "Open" button.
238 <figure id="ChIOOpenFileDialog1">
239 <title>"Open" - old GTK version</title>
240 <graphic entityref="WiresharkOpenDialog20" format="PNG"/>
246 <command>Unix/Linux: GTK version < 2.4</command></para>
248 This is the file open dialog of former Gimp/GNOME versions -
249 plus some Wireshark extensions.
252 Specific for this dialog:
257 If Wireshark doesn't recognize the selected file as a capture file,
258 it will grey out the "Ok" button.
271 <section id="ChIOInputFormatsSection">
272 <title>Input File Formats</title>
274 The following file formats from other capture tools can be opened by
275 <application>Wireshark</application>:
277 <listitem><para>libpcap - captures from <emphasis>Wireshark</emphasis>/<emphasis>TShark</emphasis>/<emphasis>dumpcap</emphasis>, <emphasis>tcpdump</emphasis>, and various other tools using libpcap's/tcpdump's capture format</para></listitem>
278 <listitem><para>pcap-ng - "next-generation" successor to libpcap format</para></listitem>
279 <listitem><para>Sun snoop and atmsnoop</para></listitem>
280 <listitem><para>Shomiti/Finisar <emphasis>Surveyor</emphasis> captures</para></listitem>
281 <listitem><para>Novell <emphasis>LANalyzer</emphasis> captures</para></listitem>
282 <listitem><para>Microsoft Network Monitor captures</para></listitem>
283 <listitem><para>AIX's iptrace captures</para></listitem>
284 <listitem><para>Cinco Networks NetXray captures</para></listitem>
285 <listitem><para>Network Associates Windows-based Sniffer and Sniffer Pro captures</para></listitem>
286 <listitem><para>Network General/Network Associates DOS-based Sniffer (compressed or uncompressed) captures</para></listitem>
287 <listitem><para>AG Group/WildPackets EtherPeek/TokenPeek/AiroPeek/EtherHelp/PacketGrabber captures</para></listitem>
288 <listitem><para>RADCOM's WAN/LAN Analyzer captures</para></listitem>
289 <listitem><para>Network Instruments Observer version 9 captures</para></listitem>
290 <listitem><para>Lucent/Ascend router debug output</para></listitem>
291 <listitem><para>HP-UX's nettl</para></listitem>
292 <listitem><para>Toshiba's ISDN routers dump output</para></listitem>
293 <listitem><para>ISDN4BSD <emphasis>i4btrace</emphasis> utility</para></listitem>
294 <listitem><para>traces from the EyeSDN USB S0</para></listitem>
295 <listitem><para>IPLog format from the Cisco Secure Intrusion Detection System</para></listitem>
296 <listitem><para>pppd logs (pppdump format)</para></listitem>
297 <listitem><para>the output from VMS's TCPIPtrace/TCPtrace/UCX$TRACE utilities</para></listitem>
298 <listitem><para>the text output from the DBS Etherwatch VMS utility</para></listitem>
299 <listitem><para>Visual Networks' Visual UpTime traffic capture</para></listitem>
300 <listitem><para>the output from CoSine L2 debug</para></listitem>
301 <listitem><para>the output from Accellent's 5Views LAN agents</para></listitem>
302 <listitem><para>Endace Measurement Systems' ERF format captures</para></listitem>
303 <listitem><para>Linux Bluez Bluetooth stack hcidump -w traces</para></listitem>
304 <listitem><para>Catapult DCT2000 .out files</para></listitem>
305 <listitem><para>Gammu generated text output from Nokia DCT3 phones in Netmonitor mode</para></listitem>
306 <listitem><para>IBM Series (OS/400) Comm traces (ASCII & UNICODE)</para></listitem>
307 <listitem><para>Juniper Netscreen snoop captures</para></listitem>
308 <listitem><para>Symbian OS btsnoop captures</para></listitem>
309 <listitem><para>Tamosoft CommView captures</para></listitem>
310 <listitem><para>Textronix K12xx 32bit .rf5 format captures</para></listitem>
311 <listitem><para>Textronix K12 text file format captures</para></listitem>
312 <listitem><para>Apple PacketLogger captures</para></listitem>
313 <listitem><para>Captures from Aethra Telecommunications' PC108 software for their test instruments</para></listitem>
314 <listitem><para>... new file formats are added from time to time</para></listitem>
317 <note><title>Opening a file may fail due to invalid packet types!</title>
319 It may not be possible to read some formats dependent on the packet types
320 captured. Ethernet captures are usually supported for most file formats but
321 it may not be possible to read other packet types (e.g. token ring packets)
322 from all file formats.
330 <section id="ChIOSaveSection"><title>Saving captured packets</title>
332 You can save captured packets simply by using the Save As... menu
333 item from the File menu under Wireshark. You can choose which
334 packets to save and which file format to be used.
337 <title>Saving may reduce the available information!</title>
339 Saving the captured packets will slightly reduce the amount of
340 information, e.g. the number of dropped packets will be lost;
341 see <xref linkend="ChAppFilesCaptureFilesSection"/> for details.
344 <section id="ChIOSaveAs">
345 <title>The "Save Capture File As" dialog box</title>
347 The "Save Capture File As" dialog box allows you to save
348 the current capture to a file.
349 <xref linkend="ChIOSaveFileTab"/> shows some examples of this
353 <title>The dialog appearance depends on your system!</title>
355 The appearance of this dialog depends on the system and GTK+ toolkit
356 version used. However, the functionality remains basically the same
357 on any particular system.
361 <table id="ChIOSaveFileTab">
362 <title>The system specific "Save Capture File As" dialog box</title>
368 <figure id="ChIOSaveAsFileWin32">
369 <title>"Save" on native Windows</title>
370 <graphic entityref="WiresharkSaveAsDialogWin32" format="PNG"/>
375 <para><command>Microsoft Windows</command></para>
377 This is the common Windows file save dialog -
378 plus some Wireshark extensions.
381 Specific for this dialog:
386 If available, the "Help" button will lead you to this section of
392 If you don't provide a file extension to the filename - e.g. .pcap,
393 Wireshark will append the standard file extension for that file
403 <figure id="ChIOSaveAsFile2">
404 <title>"Save" - new GTK version</title>
405 <graphic entityref="WiresharkSaveAsDialog24" format="PNG"/>
410 <para><command>Unix/Linux: GTK version >= 2.4</command></para>
412 This is the common Gimp/GNOME file save dialog -
413 plus some Wireshark extensions.
416 Specific for this dialog:
421 Clicking on the + at "Browse for other folders" will allow you
422 to browse files and folders in your file system.
431 <figure id="ChIOSaveAsFile1">
432 <title>"Save" - old GTK version</title>
433 <graphic entityref="WiresharkSaveAsDialog20" format="PNG"/>
438 <para><command>Unix/Linux: GTK version < 2.4</command></para>
440 This is the file save dialog of former Gimp/GNOME versions -
441 plus some Wireshark extensions.
450 With this dialog box, you can perform the following actions:
454 Type in the name of the file you wish to save the captured
455 packets in, as a standard file name in your file system.
460 Select the directory to save the file into.
465 Select the range of the packets to be saved, see
466 <xref linkend="ChIOPacketRangeSection"/>
471 Specify the format of the saved capture file by clicking on
472 the File type drop down box. You can choose from the
473 types, described in <xref linkend="ChIOOutputFormatsSection"/>.
476 <title>The selection of capture formats may be reduced!</title>
478 Some capture formats may not be available, depending on the
479 packet types captured.
483 <title>File formats can be converted!</title>
485 You can convert capture files from one format to another
486 by reading in a capture file and writing it out using a
493 Click on the Save/Ok button to accept your selected file and save to
494 it. If Wireshark has a problem saving the captured packets to
495 the file you specified, it will display an error dialog box.
496 After clicking OK on that error dialog box, you can try again.
501 Click on the Cancel button to go back to Wireshark and not save the
508 <section id="ChIOOutputFormatsSection">
509 <title>Output File Formats</title>
511 Wireshark can save the packet data in its "native" file format (libpcap)
512 and in the file formats of some other protocol analyzers, so other tools
513 can read the capture data.
515 <warning><title>File formats have different time stamp accuracies!</title>
517 Saving from the currently used file format to a different format may reduce the
518 time stamp accuracy; see the <xref linkend="ChAdvTimestamps"/> for details.
522 The following file formats can be saved by <application>Wireshark</application> (with the known file extensions):
524 <listitem><para>libpcap, tcpdump and various other tools using tcpdump's capture format (*.pcap,*.cap,*.dmp)</para></listitem>
525 <listitem><para>Accellent 5Views (*.5vw)</para></listitem>
526 <listitem><para>HP-UX's nettl (*.TRC0,*.TRC1)</para></listitem>
527 <listitem><para>Microsoft Network Monitor - NetMon (*.cap)</para></listitem>
528 <listitem><para>Network Associates Sniffer - DOS (*.cap,*.enc,*.trc,*fdc,*.syc)</para></listitem>
529 <listitem><para>Network Associates Sniffer - Windows (*.cap)</para></listitem>
530 <listitem><para>Network Instruments Observer version 9 (*.bfr)</para></listitem>
531 <listitem><para>Novell LANalyzer (*.tr1)</para></listitem>
532 <listitem><para>Sun snoop (*.snoop,*.cap)</para></listitem>
533 <listitem><para>Visual Networks Visual UpTime traffic (*.*)</para></listitem>
534 <listitem><para>... new file formats are added from time to time</para></listitem>
538 If the above tools will be more helpful than Wireshark is a different question ;-)
540 <note><title>Third party protocol analyzers may require specific file extensions!</title>
542 Other protocol analyzers than Wireshark may require that the file has a
543 certain file extension in order to read the files you generate with Wireshark, e.g.:
546 ".cap" for Network Associates Sniffer - Windows
552 <section id="ChIOMergeSection"><title>Merging capture files</title>
554 Sometimes you need to merge several capture files into one. For example
555 this can be useful, if you have captured simultaneously from multiple
556 interfaces at once (e.g. using multiple instances of Wireshark).
559 Merging capture files can be done in three ways:
562 Use the <command>menu item "Merge"</command> from the "File" menu,
563 to open the merge dialog, see <xref linkend="ChIOMergeDialog"/>.
564 This menu item will be disabled, until you have loaded a capture file.
567 Use <command>drag-and-drop</command> to drop multiple files on the
568 main window. Wireshark will try to merge the packets in chronological
569 order from the dropped files into a newly created temporary file. If
570 you drop only a single file, it will simply replace a (maybe) existing
574 Use the <command>mergecap</command> tool, which is a command
575 line tool to merge capture files. This tool provides the most options
576 to merge capture files, see <xref linkend="AppToolsmergecap"/>.
580 <section id="ChIOMergeDialog">
581 <title>The "Merge with Capture File" dialog box</title>
584 This dialog box let you select a file to be merged into the currently
587 <note><title>You will be prompted for an unsaved file first!</title>
588 <para>If your current data wasn't saved before, you will be asked to save
589 it first, before this dialog box is shown.</para>
593 Most controls of this dialog will work the same way as described in the
594 "Open Capture File" dialog box, see <xref linkend="ChIOOpen"/>.
597 Specific controls of this merge dialog are:
602 <term><command>Prepend packets to existing file</command></term>
605 Prepend the packets from the selected file before the currently loaded
611 <term><command>Merge packets chronologically</command></term>
614 Merge both the packets from the selected and currently loaded file in
620 <term><command>Append packets to existing file</command></term>
623 Append the packets from the selected file after the currently loaded
630 <table id="ChIOMergeFileTab">
631 <title>The system specific "Merge Capture File As" dialog box</title>
637 <figure id="ChIOMergeFileWin32">
638 <title>"Merge" on native Windows</title>
639 <graphic entityref="WiresharkMergeDialogWin32" format="PNG"/>
644 <para><command>Microsoft Windows</command></para>
646 This is the common Windows file open dialog -
647 plus some Wireshark extensions.
654 <figure id="ChIOMergeFile2">
655 <title>"Merge" - new GTK version</title>
656 <graphic entityref="WiresharkMergeDialog24" format="PNG"/>
661 <para><command>Unix/Linux: GTK version >= 2.4</command></para>
663 This is the common Gimp/GNOME file open dialog -
664 plus some Wireshark extensions.
671 <figure id="ChIOMergeFile1">
672 <title>"Merge" - old GTK version</title>
673 <graphic entityref="WiresharkMergeDialog20" format="PNG"/>
678 <para><command>Unix/Linux: GTK version < 2.4</command></para>
680 This is the file open dialog of former Gimp/GNOME versions -
681 plus some Wireshark extensions.
692 <section id="ChIOImportSection"><title>Import hex dump</title>
694 Wireshark can read in an ASCII hex dump and write the data described
695 into a temporary libpcap capture file. It can read hex dumps with multiple
696 packets in them, and build a capture file of multiple packets. It is also
697 capable of generating dummy Ethernet, IP and UDP, TCP, or SCTP headers,
698 in order to build fully processable packet dumps from hexdumps of
699 application-level data only.
702 Wireshark understands a hexdump of the form generated by
703 <command>od -Ax -tx1 -v</command>.
704 In other words, each byte is individually displayed and surrounded with a space.
705 Each line begins with an offset describing the position in the file. The offset
706 is a hex number (can also be octal or decimal), of more than two hex
707 digits. Here is a sample dump that can be imported:
710 000000 00 e0 1e a7 05 6f 00 10 ........
711 000008 5a a0 b9 12 08 00 46 00 ........
712 000010 03 68 00 00 00 00 0a 2e ........
713 000018 ee 33 0f 19 08 7f 0f 19 ........
714 000020 03 80 94 04 00 00 10 01 ........
715 000028 16 a2 0a 00 03 50 00 0c ........
716 000030 01 01 0f 19 03 80 11 01 ........
719 There is no limit on the width or number of bytes per line. Also the text dump at
720 the end of the line is ignored. Bytes/hex numbers can be uppercase or lowercase.
721 Any text before the offset is ignored, including email forwarding characters '>'.
722 Any lines of text between the bytestring lines are ignored. The offsets are used
723 to track the bytes, so offsets must be correct. Any line which has only bytes
724 without a leading offset is ignored. An offset is recognized as being a hex
725 number longer than two characters. Any text after the bytes is ignored (e.g. the
726 character dump). Any hex numbers in this text are also ignored. An offset of zero
727 is indicative of starting a new packet, so a single text file with a series of
728 hexdumps can be converted into a packet capture with multiple packets. Packets may
729 be preceded by a timestamp. These are interpreted according to the format
730 given. If not the first packet is timestamped with the current time the import
731 takes place. Multiple packets are read in with timestamps differing by one
732 microsecond each. In general, short of these restrictions, Wireshark is pretty
733 liberal about reading in hexdumps and has been tested with a variety of mangled
734 outputs (including being forwarded through email multiple times, with limited
738 There are a couple of other special features to note. Any line where the first
739 non-whitespace character is '#' will be ignored as a comment. Any line beginning
740 with #TEXT2PCAP is a directive and options can be inserted after this command to
741 be processed by Wireshark. Currently there are no directives implemented; in the
742 future, these may be used to give more fine grained control on the dump and the
743 way it should be processed e.g. timestamps, encapsulation type etc.
744 Wireshark also allows the user to read in dumps of application-level data, by
745 inserting dummy L2, L3 and L4 headers before each packet. The user can elect to
746 insert Ethernet headers, Ethernet and IP, or Ethernet, IP and UDP/TCP/SCTP headers
747 before each packet. This allows Wireshark or any other full-packet decoder to
750 <section id="ChIOImportDialog">
751 <title>The "Import from Hex Dump" dialog box</title>
753 This dialog box lets you select a text file, containing a hex dump
754 of packet data, to be imported and set import parameters.
757 <figure id="ChIOFileImportDialog">
758 <title>The "Import from Hex Dump" dialog</title>
759 <graphic entityref="WiresharkFileImportDialog" format="PNG"/>
763 Specific controls of this import dialog are split in two sections:
767 <listitem><para>Determine which input file has to be imported and
768 how it is to be interpreted.
773 <listitem><para>Determine how the data is to be imported.</para></listitem>
778 The input parameters are as follows:
782 <term><command>Filename / Browse</command></term>
785 Enter the name of the text file to import. You can use
786 <command>Browse</command> to browse for a file.
791 <term><command>Offsets</command></term>
794 Select the radix of the offsets given in the text file to import.
795 This is usually hexadecimal, but decimal and octal are also supported.
800 <term><command>Date/Time</command></term>
803 Tick this checkbox if there are timestamps associated with the frames
804 in the text file to import you would like to use. Otherwise the current time
805 is used for timestamping the frames.
810 <term><command>Format</command></term>
813 This is the format specifier used to parse the timestamps in the text file
814 to import. It uses a simple syntax to describe the format of the timestamps,
815 using %H for hours, %M for minutes, %S for seconds, etc. The straightforward
816 HH:MM:SS format is covered by %T. For a full definition of the syntax look for
817 <command>strptime(3)</command>.
823 The import parameters are as follows:
827 <term><command>Encapsulation type</command></term>
830 Here you can select which type of frames you are importing. This all depends on
831 from what type of medium the dump to import was taken. It lists all types that
832 Wireshark understands, so as to pass the capture file contents to the right dissector.
837 <term><command>Dummy header</command></term>
840 When Ethernet encapsulation is selected you have to option to prepend dummy
841 headers to the frames to import. These headers can provide artificial Ethernet, IP,
842 UDP or TCP or SCTP headers and SCTP data chunks. When selecting a type of dummy
843 header the applicable entries are enabled, others are grayed out and default values
849 <term><command>Max. frame length</command></term>
852 You may not be interested in the full frames from the text file, just the first part.
853 Here you can define how much data from the start of the frame you want to import.
854 If you leave this open the maximum is set to 65535 bytes.
860 Once all input and import parameters are setup click <command>OK</command>
864 <note><title>You will be prompted for an unsaved file first!</title>
865 <para>If your current data wasn't saved before, you will be asked to save
866 it first, before this dialog box is shown.</para>
870 When completed there will be a new capture file loaded with the frames imported
876 <section id="ChIOFileSetSection"><title>File Sets</title>
878 When using the "Multiple Files" option while doing a capture
879 (see: <xref linkend="ChCapCaptureFiles"/>),
880 the capture data is spread over several capture files, called a file
884 As it can become tedious to work with a file set by hand, Wireshark
885 provides some features to handle these file sets in a convenient way.
887 <sidebar><title>How does Wireshark detect the files of a file set?</title>
889 A filename in a file set uses the format Prefix_Number_DateTimeSuffix
890 which might look like this: "test_00001_20060420183910.pcap".
891 All files of a file set share the same prefix (e.g. "test") and suffix
892 (e.g. ".pcap") and a varying middle part.
895 To find the files of a file set, Wireshark scans the directory where the
896 currently loaded file resides and checks for files matching the filename
897 pattern (prefix and suffix) of the currently loaded file.
900 This simple mechanism usually works well, but has its drawbacks. If several
901 file sets were captured with the same prefix and suffix, Wireshark will detect
902 them as a single file set. If files were renamed or spread over several
903 directories the mechanism will fail to find all files of a set.
907 The following features in the "File Set" submenu of the "File" menu are
908 available to work with file sets in a convenient way:
912 The <command>List Files</command> dialog box will list the files
913 Wireshark has recognized as being part of the current file set.
916 <command>Next File</command> closes the current and opens the next
917 file in the file set.
920 <command>Previous File</command> closes the current and opens the
921 previous file in the file set.
924 <section id="ChIOFileSetListDialog">
925 <title>The "List Files" dialog box</title>
927 <title>The "List Files" dialog box</title>
928 <graphic entityref="WiresharkFileSetDialog" format="PNG"/>
931 Each line contains information about a file of the file set:
934 <command>Filename</command> the name of the file. If you click on
935 the filename (or the radio button left to it), the current file will
936 be closed and the corresponding capture file will be opened.
939 <command>Created</command> the creation time of the file
942 <command>Last Modified</command> the last time the file was modified
945 <command>Size</command> the size of the file
948 The last line will contain info about the currently used directory where
949 all of the files in the file set can be found.
952 The content of this dialog box is updated each time a capture file is
956 The Close button will, well, close the dialog box.
960 <section id="ChIOExportSection"><title>Exporting data</title>
962 Wireshark provides several ways and formats to export packet data. This
963 section describes general ways to export data from Wireshark.
965 <note><title>Note!</title>
967 There are more specialized functions to export specific data,
968 which will be described at the appropriate places.
972 XXX - add detailed descriptions of the output formats and some sample
975 <section id="ChIOExportPlainDialog">
976 <title>The "Export as Plain Text File" dialog box</title>
977 <para id="ChIOExportPlain">
978 Export packet data into a plain ASCII text file, much like the format
979 used to print packets.
980 <tip><title>Tip!</title>
982 If you would like to be able to import any previously exported
983 packets from a plain text file, it is recommended that you:
986 Add the "Absolute date and time" column.
989 Temporarily hide all other columns.
992 Turn off: Edit/Preferences/Protocols/Data/
993 "Show not dissected data on new Packet Bytes pane". More detail is
994 provided in <xref linkend="ChCustPreferencesSection"/>
997 Include the packet summary line.
1000 Exclude the column headings.
1003 Exclude the packet details.
1006 Include the packet bytes.
1012 <title>The "Export as Plain Text File" dialog box</title>
1013 <graphic entityref="WiresharkExportPlainDialog" format="PNG"/>
1017 <command>Export to file:</command> frame chooses the file to export
1021 The <command>Packet Range</command> frame is described in <xref
1022 linkend="ChIOPacketRangeSection"/>.
1025 The <command>Packet Details</command> frame is described in <xref
1026 linkend="ChIOPacketFormatSection"/>.
1031 <section id="ChIOExportPSDialog">
1032 <title>The "Export as PostScript File" dialog box</title>
1034 Export packet data into PostScript, much like the format used
1036 <tip><title>Tip!</title>
1038 You can easily convert PostScript files to PDF files using ghostscript.
1039 For example: export to a file named foo.ps and then call:
1040 <command>ps2pdf foo.ps</command>
1044 <title>The "Export as PostScript File" dialog box</title>
1045 <graphic entityref="WiresharkExportPSDialog" format="PNG"/>
1049 <command>Export to file:</command> frame chooses the file to export
1053 The <command>Packet Range</command> frame is described in <xref
1054 linkend="ChIOPacketRangeSection"/>.
1057 The <command>Packet Details</command> frame is described in <xref
1058 linkend="ChIOPacketFormatSection"/>.
1063 <section id="ChIOExportCSVDialog">
1064 <title>The "Export as CSV (Comma Separated Values) File" dialog box</title>
1065 <para>XXX - add screenshot</para>
1067 Export packet summary into CSV, used e.g. by spreadsheet programs to
1070 <title>The "Export as Comma Separated Values File" dialog box</title>
1071 <graphic entityref="WiresharkExportCSVDialog" format="PNG"/>
1075 <command>Export to file:</command> frame chooses the file to export
1079 The <command>Packet Range</command> frame is described in <xref
1080 linkend="ChIOPacketRangeSection"/>.
1085 <section id="ChIOExportCArraysDialog">
1086 <title>The "Export as C Arrays (packet bytes) file" dialog box</title>
1087 <para>XXX - add screenshot</para>
1089 Export packet bytes into C arrays so you can import the stream data
1090 into your own C program.
1093 <title>The "Export as C Arrays (packet bytes) file" dialog box</title>
1094 <graphic entityref="WiresharkExportCArraysDialog" format="PNG"/>
1099 <command>Export to file:</command> frame chooses the file to export
1103 The <command>Packet Range</command> frame is described in <xref
1104 linkend="ChIOPacketRangeSection"/>.
1109 <section id="ChIOExportPSMLDialog">
1110 <title>The "Export as PSML File" dialog box</title>
1112 Export packet data into PSML. This is an XML based format including
1113 only the packet summary. The PSML file specification is available at:
1114 <ulink url="http://www.nbee.org/doku.php?id=netpdl:psml_specification"/>.
1116 <title>The "Export as PSML File" dialog box</title>
1117 <graphic entityref="WiresharkExportPSMLDialog" format="PNG"/>
1121 <command>Export to file:</command> frame chooses the file to export
1125 The <command>Packet Range</command> frame is described in <xref
1126 linkend="ChIOPacketRangeSection"/>.
1129 There's no such thing as a packet details frame for PSML export, as the
1130 packet format is defined by the PSML specification.
1133 <section id="ChIOExportPDMLDialog">
1134 <title>The "Export as PDML File" dialog box</title>
1136 Export packet data into PDML. This is an XML based format including
1137 the packet details. The PDML file specification is available at:
1138 <ulink url="http://www.nbee.org/doku.php?id=netpdl:pdml_specification"/>.
1139 <note><title></title>
1141 The PDML specification is not officially released and Wireshark's
1142 implementation of it is still in an early beta state, so please expect
1143 changes in future Wireshark versions.
1147 <title>The "Export as PDML File" dialog box</title>
1148 <graphic entityref="WiresharkExportPDMLDialog" format="PNG"/>
1152 <command>Export to file:</command> frame chooses the file to export
1156 The <command>Packet Range</command> frame is described in <xref
1157 linkend="ChIOPacketRangeSection"/>.
1160 There's no such thing as a packet details frame for PDML export, as the
1161 packet format is defined by the PDML specification.
1164 <section id="ChIOExportSelectedDialog">
1165 <title>The "Export selected packet bytes" dialog box</title>
1167 Export the bytes selected in the "Packet Bytes" pane into a raw
1170 <title>The "Export Selected Packet Bytes" dialog box</title>
1171 <graphic entityref="WiresharkExportSelectedDialog" format="PNG"/>
1175 <command>Name:</command> the filename to export the packet data to.
1178 The <command>Save in folder:</command> field lets you select the
1179 folder to save to (from some predefined folders).
1182 <command>Browse for other folders</command> provides a flexible
1183 way to choose a folder.
1188 <section id="ChIOExportObjectsDialog">
1189 <title>The "Export Objects" dialog box</title>
1191 This feature scans through HTTP streams in the currently
1192 open capture file or running capture and takes reassembled
1193 objects such as HTML documents, image files, executables
1194 and anything else that can be transferred over HTTP and
1195 lets you save them to disk. If you have a capture
1196 running, this list is automatically updated every few
1197 seconds with any new objects seen. The saved objects can then be
1198 opened with the proper viewer or executed in the case of
1199 executables (if it is for the same platform you are
1200 running Wireshark on) without any further work on your
1201 part. This feature is not available when using GTK2 versions
1205 <title>The "Export Objects" dialog box</title>
1206 <graphic entityref="WiresharkExportObjectsDialog" format="PNG"/>
1210 <para>Columns:</para>
1212 <command>Packet num:</command> The packet number in
1213 which this object was found. In some cases, there can
1214 be multiple objects in the same packet.
1218 <command>Hostname:</command> The hostname of the
1219 server that sent the object as a response to an HTTP request.
1223 <command>Content Type:</command> The HTTP content type
1228 <command>Bytes:</command> The size of this object in bytes.
1232 <command>Filename:</command> The final part of the URI
1233 (after the last slash). This is typically a filename,
1234 but may be a long complex looking string, which
1235 typically indicates that the file was received in response to
1236 a HTTP POST request.
1241 <para>Buttons:</para>
1243 <command>Help:</command> Opens this section in the
1248 <command>Close:</command> Closes this dialog.
1252 <command>Save As:</command> Saves the currently
1253 selected object as a filename you specify. The
1254 default filename to save as is taken from the filename
1255 column of the objects list.
1259 <command>Save All:</command> Saves all objects in the
1260 list using the filename from the filename column. You
1261 will be asked what directory / folder to save them
1262 in. If the filename is invalid for the operating system /
1263 file system you are running Wireshark on, then an error
1264 will appear and that object will not be saved (but all
1265 of the others will be).
1271 <section id="ChIOPrintSection"><title>Printing packets</title>
1273 To print packets, select the "Print..." menu item from the File menu.
1274 When you do this, Wireshark pops up the Print dialog box as shown in
1275 <xref linkend="ChIOPrintDialogBox"/>.
1277 <section><title>The "Print" dialog box</title>
1278 <figure id="ChIOPrintDialogBox">
1279 <title>The "Print" dialog box</title>
1280 <graphic entityref="WiresharkPrint" format="PNG"/>
1283 The following fields are available in the Print dialog box:
1285 <varlistentry><term><command>Printer</command></term>
1288 This field contains a pair of mutually exclusive radio buttons:
1292 <command>Plain Text</command> specifies that
1293 the packet print should be in plain text.
1298 <command>PostScript</command> specifies that
1299 the packet print process should use PostScript to
1300 generate a better print output on PostScript aware printers.
1305 <command>Output to file:</command> specifies that printing
1306 be done to a file, using the filename entered in the field or selected
1307 with the browse button.
1310 This field is where you enter the <command>file</command> to
1311 print to if you have selected Print to a file, or you can click the
1312 button to browse the filesystem. It is greyed out if Print to a file
1318 <command>Print command</command> specifies that a
1319 command be used for printing.
1321 <note><title>Note!</title>
1323 These <command>Print command</command> fields are not available on
1328 This field specifies the command to use for printing. It
1329 is typically <command>lpr</command>. You would change it
1330 to specify a particular queue if you need to print to a
1331 queue other than the default. An example might be:
1335 This field is greyed out if <command>Output to file:</command> is
1344 <term><command>Packet Range</command></term>
1347 Select the packets to be printed, see <xref
1348 linkend="ChIOPacketRangeSection"/>
1353 <term><command>Packet Format</command></term>
1356 Select the output format of the packets to be printed. You can
1357 choose, how each packet is printed, see
1358 <xref linkend="ChIOPacketFormatFrame"/>
1367 <section id="ChIOPacketRangeSection"><title>The Packet Range frame</title>
1369 The packet range frame is a part of various output related dialog boxes.
1370 It provides options to select which packets should be processed by the
1372 <figure id="ChIOPacketRangeFrame">
1373 <title>The "Packet Range" frame</title>
1374 <graphic entityref="WiresharkPacketRangeFrame" format="PNG"/>
1378 If the <command>Captured</command> button is set (default), all packets
1379 from the selected rule will be processed. If the <command>Displayed
1380 </command> button is set, only the currently displayed packets are taken
1381 into account to the selected rule.
1387 <command>All packets</command> will process all packets.
1392 <command>Selected packet only</command> process only the selected
1398 <command>Marked packets only</command> process only the marked
1404 <command>From first to last marked packet</command> process the
1405 packets from the first to the last marked one.
1410 <command>Specify a packet range</command> process a user specified
1411 range of packets, e.g. specifying <command>5,10-15,20-</command> will
1412 process the packet number five, the packets from packet number ten
1413 to fifteen (inclusive) and every packet from number twenty to the
1421 <section id="ChIOPacketFormatSection"><title>The Packet Format frame</title>
1423 The packet format frame is a part of various output related dialog boxes.
1424 It provides options to select which parts of a packet should be used for
1425 the output function.
1426 <figure id="ChIOPacketFormatFrame">
1427 <title>The "Packet Format" frame</title>
1428 <graphic entityref="WiresharkPacketFormatFrame" format="PNG"/>
1433 <command>Packet summary line</command> enable the output of the
1434 summary line, just as in the "Packet List" pane.
1439 <command>Packet details</command> enable the output of the packet
1445 <command>All collapsed</command> the info from the "Packet Details"
1446 pane in "all collapsed" state.
1451 <command>As displayed</command> the info from the "Packet Details"
1452 pane in the current state.
1457 <command>All expanded</command> the info from the "Packet Details"
1458 pane in "all expanded" state.
1465 <command>Packet bytes</command> enable the output of the packet
1466 bytes, just as in the "Packet Bytes" pane.
1471 <command>Each packet on a new page</command> put each packet on a
1472 separate page (e.g. when saving/printing to a text file, this will
1473 put a form feed character between the packets).
1481 <!-- End of WSUG Chapter IO -->