4 wireshark - Interactively dump and analyze network traffic
9 S<[ B<-a> E<lt>capture autostop conditionE<gt> ] ...>
10 S<[ B<-b> E<lt>capture ring buffer optionE<gt> ] ...>
11 S<[ B<-B> E<lt>capture buffer size (Win32 only)E<gt> ] >
12 S<[ B<-c> E<lt>capture packet countE<gt> ]>
13 S<[ B<-C> E<lt>configuration profileE<gt> ]>
14 S<[ B<-d> E<lt>display filterE<gt> ]>
16 S<[ B<--display=>E<lt>X display to useE<gt> ] >
17 S<[ B<-f> E<lt>capture filterE<gt> ]>
18 S<[ B<-g> E<lt>packet numberE<gt> ]>
21 S<[ B<-i> E<lt>capture interfaceE<gt>|- ]>
23 S<[ B<-J> E<lt>jump filterE<gt> ]>
26 S<[ B<-K> E<lt>keytabE<gt> ]>
29 S<[ B<-m> E<lt>fontE<gt> ]>
31 S<[ B<-N> E<lt>name resolving flagsE<gt> ] >
32 S<[ B<-o> E<lt>preference/recent settingE<gt> ] ...>
34 S<[ B<-P> E<lt>path settingE<gt>]>
35 S<[ B<-r> E<lt>infileE<gt> ]>
36 S<[ B<-R> E<lt>read (display) filterE<gt> ]>
38 S<[ B<-s> E<lt>capture snaplenE<gt> ]>
39 S<[ B<-t> ad|a|r|d|dd|e ]>
41 S<[ B<-w> E<lt>outfileE<gt> ]>
42 S<[ B<-y> E<lt>capture link typeE<gt> ]>
43 S<[ B<-X> E<lt>eXtension optionE<gt> ]>
44 S<[ B<-z> E<lt>statisticsE<gt> ]>
45 S<[ E<lt>infileE<gt> ]>
49 B<Wireshark> is a GUI network protocol analyzer. It lets you
50 interactively browse packet data from a live network or from a
51 previously saved capture file. B<Wireshark>'s native capture file format
52 is B<libpcap> format, which is also the format used by B<tcpdump> and
55 B<Wireshark> can read / import the following file formats:
60 libpcap, tcpdump and various other tools using tcpdump's capture format
63 B<snoop> and B<atmsnoop>
66 Shomiti/Finisar B<Surveyor> captures
69 Novell B<LANalyzer> captures
72 Microsoft B<Network Monitor> captures
75 AIX's B<iptrace> captures
78 Cinco Networks B<NetXRay> captures
81 Network Associates Windows-based B<Sniffer> captures
84 Network General/Network Associates DOS-based B<Sniffer> (compressed or uncompressed) captures
87 AG Group/WildPackets B<EtherPeek>/B<TokenPeek>/B<AiroPeek>/B<EtherHelp>/B<PacketGrabber> captures
90 B<RADCOM>'s WAN/LAN analyzer captures
93 Network Instruments B<Observer> version 9 captures
96 B<Lucent/Ascend> router debug output
99 files from HP-UX's B<nettl>
102 B<Toshiba's> ISDN routers dump output
105 the output from B<i4btrace> from the ISDN4BSD project
108 traces from the B<EyeSDN> USB S0.
111 the output in B<IPLog> format from the Cisco Secure Intrusion Detection System
114 B<pppd logs> (pppdump format)
117 the output from VMS's B<TCPIPtrace>/B<TCPtrace>/B<UCX$TRACE> utilities
120 the text output from the B<DBS Etherwatch> VMS utility
123 Visual Networks' B<Visual UpTime> traffic capture
126 the output from B<CoSine> L2 debug
129 the output from Accellent's B<5Views> LAN agents
132 Endace Measurement Systems' ERF format captures
135 Linux Bluez Bluetooth stack B<hcidump -w> traces
138 Catapult DCT2000 .out files
141 TamoSoft CommView files
144 Apple PacketLogger files
148 There is no need to tell B<Wireshark> what type of
149 file you are reading; it will determine the file type by itself.
150 B<Wireshark> is also capable of reading any of these file formats if they
151 are compressed using gzip. B<Wireshark> recognizes this directly from
152 the file; the '.gz' extension is not required for this purpose.
154 Like other protocol analyzers, B<Wireshark>'s main window shows 3 views
155 of a packet. It shows a summary line, briefly describing what the
156 packet is. A packet details display is shown, allowing you to drill
157 down to exact protocol or field that you interested in. Finally, a hex
158 dump shows you exactly what the packet looks like when it goes over the
161 In addition, B<Wireshark> has some features that make it unique. It can
162 assemble all the packets in a TCP conversation and show you the ASCII
163 (or EBCDIC, or hex) data in that conversation. Display filters in
164 B<Wireshark> are very powerful; more fields are filterable in B<Wireshark>
165 than in other protocol analyzers, and the syntax you can use to create
166 your filters is richer. As B<Wireshark> progresses, expect more and more
167 protocol fields to be allowed in display filters.
169 Packet capturing is performed with the pcap library. The capture filter
170 syntax follows the rules of the pcap library. This syntax is different
171 from the display filter syntax.
173 Compressed file support uses (and therefore requires) the zlib library.
174 If the zlib library is not present, B<Wireshark> will compile, but will
175 be unable to read compressed files.
177 The pathname of a capture file to be read can be specified with the
178 B<-r> option or can be specified as a command-line argument.
182 Most users will want to start B<Wireshark> without options and configure
183 it from the menus instead. Those users may just skip this section.
187 =item -a E<lt>capture autostop conditionE<gt>
189 Specify a criterion that specifies when B<Wireshark> is to stop writing
190 to a capture file. The criterion is of the form I<test>B<:>I<value>,
191 where I<test> is one of:
193 B<duration>:I<value> Stop writing to a capture file after I<value> seconds have
196 B<filesize>:I<value> Stop writing to a capture file after it reaches a size of
197 I<value> kilobytes (where a kilobyte is 1024 bytes). If this option is used
198 together with the -b option, Wireshark will stop writing to the current
199 capture file and switch to the next one if filesize is reached.
201 B<files>:I<value> Stop writing to capture files after I<value> number of files
204 =item -b E<lt>capture ring buffer optionE<gt>
206 Cause B<Wireshark> to run in "multiple files" mode. In "multiple files" mode,
207 B<Wireshark> will write to several capture files. When the first capture file
208 fills up, B<Wireshark> will switch writing to the next file and so on.
210 The created filenames are based on the filename given with the B<-w> flag,
211 the number of the file and on the creation date and time,
212 e.g. outfile_00001_20050604120117.pcap, outfile_00002_20050604120523.pcap, ...
214 With the I<files> option it's also possible to form a "ring buffer".
215 This will fill up new files until the number of files specified,
216 at which point B<Wireshark> will discard the data in the first file and start
217 writing to that file and so on. If the I<files> option is not set,
218 new files filled up until one of the capture stop conditions match (or
219 until the disk is full).
221 The criterion is of the form I<key>B<:>I<value>,
222 where I<key> is one of:
224 B<duration>:I<value> switch to the next file after I<value> seconds have
225 elapsed, even if the current file is not completely filled up.
227 B<filesize>:I<value> switch to the next file after it reaches a size of
228 I<value> kilobytes (where a kilobyte is 1024 bytes).
230 B<files>:I<value> begin again with the first file after I<value> number of
231 files were written (form a ring buffer). This value must be less than 100000.
232 Caution should be used when using large numbers of files: some filesystems do
233 not handle many files in a single directory well. The B<files> criterion
234 requires either B<duration> or B<filesize> to be specified to control when to
235 go to the next file. It should be noted that each B<-b> parameter takes exactly
236 one criterion; to specify two criterion, each must be preceded by the B<-b>
239 Example: B<-b filesize:1024 -b files:5> results in a ring buffer of five files
240 of size one megabyte.
242 =item -B E<lt>capture buffer sizeE<gt>
244 Set capture buffer size (in MB, default is 1MB). This is used by the
245 the capture driver to buffer packet data until that data can be written
246 to disk. If you encounter packet drops while capturing, try to increase
247 this size. Note that, while B<Tshark> attempts to set the buffer size
248 to 1MB by default, and can be told to set it to a larger value, the
249 system or interface on which you're capturing might silently limit the
250 capture buffer size to a lower value or raise it to a higher value.
252 This is available on UNIX systems with libpcap 1.0.0 or later and on
253 Windows. It is not available on UNIX systems with earlier versions of
256 This option can occur multiple times. If used before the first
257 occurrence of the B<-i> option, it sets the default capture buffer size.
258 If used after an B<-i> option, it sets the capture buffer size for
259 the interface specified by the last B<-i> option occurring before
260 this option. If the capture buffer size is not set specifically,
261 the default capture buffer size is used if provided.
263 =item -c E<lt>capture packet countE<gt>
265 Set the maximum number of packets to read when capturing live
268 =item -C E<lt>configuration profileE<gt>
270 Start with the given configuration profile.
272 =item -d E<lt>display filterE<gt>
274 Start with the given display filter.
278 Print a list of the interfaces on which B<Wireshark> can capture, and
279 exit. For each network interface, a number and an
280 interface name, possibly followed by a text description of the
281 interface, is printed. The interface name or the number can be supplied
282 to the B<-i> flag to specify an interface on which to capture.
284 This can be useful on systems that don't have a command to list them
285 (e.g., Windows systems, or UNIX systems lacking B<ifconfig -a>);
286 the number can be useful on Windows 2000 and later systems, where the
287 interface name is a somewhat complex string.
289 Note that "can capture" means that B<Wireshark> was able to open
290 that device to do a live capture; if, on your system, a program doing a
291 network capture must be run from an account with special privileges (for
292 example, as root), then, if B<Wireshark> is run with the B<-D> flag and
293 is not run from such an account, it will not list any interfaces.
295 =item --display=E<lt>X display to useE<gt>
297 Specifies the X display to use. A hostname and screen (otherhost:0.0)
298 or just a screen (:0.0) can be specified. This option is not available
301 =item -f E<lt>capture filterE<gt>
303 Set the capture filter expression.
305 This option can occur multiple times. If used before the first
306 occurrence of the B<-i> option, it sets the default capture filter expression.
307 If used after an B<-i> option, it sets the capture filter expression for
308 the interface specified by the last B<-i> option occurring before
309 this option. If the capture filter expression is not set specifically,
310 the default capture filter expression is used if provided.
312 =item -g E<lt>packet numberE<gt>
314 After reading in a capture file using the B<-r> flag, go to the given I<packet number>.
318 Print the version and options and exit.
322 Hide the capture info dialog during live packet capture.
324 =item -i E<lt>capture interfaceE<gt>|-
326 Set the name of the network interface or pipe to use for live packet
329 Network interface names should match one of the names listed in
330 "B<wireshark -D>" (described above); a number, as reported by
331 "B<wireshark -D>", can also be used. If you're using UNIX, "B<netstat
332 -i>" or "B<ifconfig -a>" might also work to list interface names,
333 although not all versions of UNIX support the B<-a> flag to B<ifconfig>.
335 If no interface is specified, B<Wireshark> searches the list of
336 interfaces, choosing the first non-loopback interface if there are any
337 non-loopback interfaces, and choosing the first loopback interface if
338 there are no non-loopback interfaces. If there are no interfaces at all,
339 B<Wireshark> reports an error and doesn't start the capture.
341 Pipe names should be either the name of a FIFO (named pipe) or ``-'' to
342 read data from the standard input. On Windows systems, pipe names must be
343 of the form ``\\pipe\.\B<pipename>''. Data read from pipes must be in
344 standard libpcap format.
346 This option can occur multiple times. When capturing from multiple
347 interfaces, the capture file will be saved in pcap-ng format.
351 Put the interface in "monitor mode"; this is supported only on IEEE
352 802.11 Wi-Fi interfaces, and supported only on some operating systems.
354 Note that in monitor mode the adapter might disassociate from the
355 network with which it's associated, so that you will not be able to use
356 any wireless networks with that adapter. This could prevent accessing
357 files on a network server, or resolving host names or network addresses,
358 if you are capturing in monitor mode and are not connected to another
359 network with another adapter.
361 This option can occur multiple times. If used before the first
362 occurrence of the B<-i> option, it enables the monitor mode for all interfaces.
363 If used after an B<-i> option, it enables the monitor mode for
364 the interface specified by the last B<-i> option occurring before
367 =item -J E<lt>jump filterE<gt>
369 After reading in a capture file using the B<-r> flag, jump to the packet
370 matching the filter (display filter syntax). If no exact match is found
371 the first packet after that is selected.
375 Use after B<-J> to change the behavior when no exact match is found for
376 the filter. With this option select the first packet before.
380 Start the capture session immediately. If the B<-i> flag was
381 specified, the capture uses the specified interface. Otherwise,
382 B<Wireshark> searches the list of interfaces, choosing the first
383 non-loopback interface if there are any non-loopback interfaces, and
384 choosing the first loopback interface if there are no non-loopback
385 interfaces; if there are no interfaces, B<Wireshark> reports an error and
386 doesn't start the capture.
388 =item -K E<lt>keytabE<gt>
390 Load kerberos crypto keys from the specified keytab file.
391 This option can be used multiple times to load keys from several files.
393 Example: B<-K krb5.keytab>
397 Turn on automatic scrolling if the packet display is being updated
398 automatically as packets arrive during a capture (as specified by the
403 List the data link types supported by the interface and exit.
405 =item -m E<lt>fontE<gt>
407 Set the name of the font used by B<Wireshark> for most text. B<Wireshark>
408 will construct the name of the bold font used for the data in the byte
409 view pane that corresponds to the field selected in the packet details
410 pane from the name of the main text font.
414 Disable network object name resolution (such as hostname, TCP and UDP port
415 names), the B<-N> flag might override this one.
417 =item -N E<lt>name resolving flagsE<gt>
419 Turn on name resolving only for particular types of addresses and port
420 numbers, with name resolving for other types of addresses and port
421 numbers turned off. This flag overrides B<-n> if both B<-N> and B<-n> are
422 present. If both B<-N> and B<-n> flags are not present, all name resolutions
425 The argument is a string that may contain the letters:
427 B<m> to enable MAC address resolution
429 B<n> to enable network address resolution
431 B<t> to enable transport-layer port number resolution
433 B<C> to enable concurrent (asynchronous) DNS lookups
435 =item -o E<lt>preference/recent settingE<gt>
437 Set a preference or recent value, overriding the default value and any value
438 read from a preference/recent file. The argument to the flag is a string of
439 the form I<prefname>B<:>I<value>, where I<prefname> is the name of the
440 preference/recent value (which is the same name that would appear in the
441 preference/recent file), and I<value> is the value to which it should be set.
442 Since B<Ethereal> 0.10.12, the recent settings replaces the formerly used
443 -B, -P and -T flags to manipulate the GUI dimensions.
445 If I<prefname> is "uat", you can override settings in various user access
446 tables using the form uatB<:>I<uat filename>:I<uat record>. I<uat filename>
447 must be the name of a UAT file, e.g. I<user_dlts>. I<uat_record> must be in
448 the form of a valid record for that file, including quotes. For instance, to
449 specify a user DLT from the command line, you would use
453 -o "uat:user_dlts:\"User 0 (DLT=147)\",\"cops\",\"0\",\"\",\"0\",\"\""
459 I<Don't> put the interface into promiscuous mode. Note that the
460 interface might be in promiscuous mode for some other reason; hence,
461 B<-p> cannot be used to ensure that the only traffic that is captured is
462 traffic sent to or from the machine on which B<Wireshark> is running,
463 broadcast traffic, and multicast traffic to addresses received by that
466 This option can occur multiple times. If used before the first
467 occurrence of the B<-i> option, no interface will be put into the
469 If used after an B<-i> option, the interface specified by the last B<-i>
470 option occurring before this option will not be put into the
473 =item -P E<lt>path settingE<gt>
475 Special path settings usually detected automatically. This is used for
476 special cases, e.g. starting Wireshark from a known location on an USB stick.
478 The criterion is of the form I<key>B<:>I<path>, where I<key> is one of:
480 B<persconf>:I<path> path of personal configuration files, like the
483 B<persdata>:I<path> path of personal data files, it's the folder initially
484 opened. After the very first initialization, the recent file will keep the
487 =item -r E<lt>infileE<gt>
489 Read packet data from I<infile>, can be any supported capture file format
490 (including gzipped files). It's not possible to use named pipes or stdin
493 =item -R E<lt>read (display) filterE<gt>
495 When reading a capture file specified with the B<-r> flag, causes the
496 specified filter (which uses the syntax of display filters, rather than
497 that of capture filters) to be applied to all packets read from the
498 capture file; packets not matching the filter are discarded.
502 Automatically update the packet display as packets are coming in.
504 =item -s E<lt>capture snaplenE<gt>
506 Set the default snapshot length to use when capturing live data.
507 No more than I<snaplen> bytes of each network packet will be read into
508 memory, or saved to disk. A value of 0 specifies a snapshot length of
509 65535, so that the full packet is captured; this is the default.
511 This option can occur multiple times. If used before the first
512 occurrence of the B<-i> option, it sets the default snapshot length.
513 If used after an B<-i> option, it sets the snapshot length for
514 the interface specified by the last B<-i> option occurring before
515 this option. If the snapshot length is not set specifically,
516 the default snapshot length is used if provided.
518 =item -t ad|a|r|d|dd|e
520 Set the format of the packet timestamp displayed in the packet list
521 window. The format can be one of:
523 B<ad> absolute with date: The absolute date and time is the actual time and
524 date the packet was captured
526 B<a> absolute: The absolute time is the actual time the packet was captured,
527 with no date displayed
529 B<r> relative: The relative time is the time elapsed between the first packet
530 and the current packet
532 B<d> delta: The delta time is the time since the previous packet was
535 B<dd> delta_displayed: The delta_displayed time is the time since the
536 previous displayed packet was captured
538 B<e> epoch: The time in seconds since epoch (Jan 1, 1970 00:00:00)
540 The default format is relative.
544 Print the version and exit.
546 =item -w E<lt>outfileE<gt>
548 Set the default capture file name.
550 =item -y E<lt>capture link typeE<gt>
552 If a capture is started from the command line with B<-k>, set the data
553 link type to use while capturing packets. The values reported by B<-L>
554 are the values that can be used.
556 This option can occur multiple times. If used before the first
557 occurrence of the B<-i> option, it sets the default capture link type.
558 If used after an B<-i> option, it sets the capture link type for
559 the interface specified by the last B<-i> option occurring before
560 this option. If the capture link type is not set specifically,
561 the default capture link type is used if provided.
563 =item -X E<lt>eXtension optionsE<gt>
565 Specify an option to be passed to an B<Wireshark> module. The eXtension option
566 is in the form I<extension_key>B<:>I<value>, where I<extension_key> can be:
568 B<lua_script>:I<lua_script_filename> tells B<Wireshark> to load the given script in addition to the
571 B<stdin_descr>:I<description> tells B<Wireshark> to use the given description when
572 capturing from standard input (B<-i ->).
574 =item -z E<lt>statisticsE<gt>
576 Get B<Wireshark> to collect various types of statistics and display the result
577 in a window that updates in semi-real time.
579 Currently implemented statistics are:
583 =item B<-z> dcerpc,srt,I<uuid>,I<major>.I<minor>[,I<filter>]
585 Collect call/reply SRT (Service Response Time) data for DCERPC interface I<uuid>,
586 version I<major>.I<minor>.
587 Data collected is the number of calls for each procedure, MinSRT, MaxSRT
590 Example: S<B<-z dcerpc,srt,12345778-1234-abcd-ef00-0123456789ac,1.0>> will collect data for the CIFS SAMR Interface.
592 This option can be used multiple times on the command line.
594 If the optional I<filter> is provided, the stats will only be calculated
595 on those calls that match that filter.
597 Example: S<B<-z dcerpc,srt,12345778-1234-abcd-ef00-0123456789ac,1.0,ip.addr==1.2.3.4>> will collect SAMR
598 SRT statistics for a specific host.
602 Collect packet/bytes statistics for the capture in intervals of 1 second.
603 This option will open a window with up to 5 color-coded graphs where
604 number-of-packets-per-second or number-of-bytes-per-second statistics
605 can be calculated and displayed.
607 This option can be used multiple times on the command line.
609 This graph window can also be opened from the Analyze:Statistics:Traffic:IO-Stat
612 =item B<-z> rpc,srt,I<program>,I<version>[,<filter>]
614 Collect call/reply SRT (Service Response Time) data for I<program>/I<version>. Data collected
615 is the number of calls for each procedure, MinSRT, MaxSRT and AvgSRT.
617 Example: B<-z rpc,srt,100003,3> will collect data for NFS v3.
619 This option can be used multiple times on the command line.
621 If the optional I<filter> is provided, the stats will only be calculated
622 on those calls that match that filter.
624 Example: S<B<-z rpc,srt,100003,3,nfs.fh.hash==0x12345678>> will collect NFS v3
625 SRT statistics for a specific file.
627 =item B<-z> rpc,programs
629 Collect call/reply SRT data for all known ONC-RPC programs/versions.
630 Data collected is the number of calls for each protocol/version, MinSRT,
633 =item B<-z> scsi,srt,I<cmdset>[,<filter>]
635 Collect call/reply SRT (Service Response Time) data for SCSI commandset <cmdset>.
637 Commandsets are 0:SBC 1:SSC 5:MMC
640 is the number of calls for each procedure, MinSRT, MaxSRT and AvgSRT.
642 Example: B<-z scsi,srt,0> will collect data for SCSI BLOCK COMMANDS (SBC).
644 This option can be used multiple times on the command line.
646 If the optional I<filter> is provided, the stats will only be calculated
647 on those calls that match that filter.
649 Example: B<-z scsi,srt,0,ip.addr==1.2.3.4> will collect SCSI SBC
650 SRT statistics for a specific iscsi/ifcp/fcip host.
652 =item B<-z> smb,srt[,I<filter>]
654 Collect call/reply SRT (Service Response Time) data for SMB. Data collected
655 is the number of calls for each SMB command, MinSRT, MaxSRT and AvgSRT.
657 Example: B<-z smb,srt>
659 The data will be presented as separate tables for all normal SMB commands,
660 all Transaction2 commands and all NT Transaction commands.
661 Only those commands that are seen in the capture will have their stats
663 Only the first command in a xAndX command chain will be used in the
664 calculation. So for common SessionSetupAndX + TreeConnectAndX chains,
665 only the SessionSetupAndX call will be used in the statistics.
666 This is a flaw that might be fixed in the future.
668 This option can be used multiple times on the command line.
670 If the optional I<filter> is provided, the stats will only be calculated
671 on those calls that match that filter.
673 Example: B<-z "smb,srt,ip.addr==1.2.3.4"> will collect stats only for
674 SMB packets exchanged by the host at IP address 1.2.3.4 .
676 =item B<-z> fc,srt[,I<filter>]
678 Collect call/reply SRT (Service Response Time) data for FC. Data collected
679 is the number of calls for each Fibre Channel command, MinSRT, MaxSRT and AvgSRT.
681 Example: B<-z fc,srt>
682 will calculate the Service Response Time as the time delta between the
683 First packet of the exchange and the Last packet of the exchange.
685 The data will be presented as separate tables for all normal FC commands,
686 Only those commands that are seen in the capture will have its stats
689 This option can be used multiple times on the command line.
691 If the optional I<filter> is provided, the stats will only be calculated
692 on those calls that match that filter.
694 Example: B<-z "fc,srt,fc.id==01.02.03"> will collect stats only for
695 FC packets exchanged by the host at FC address 01.02.03 .
697 =item B<-z> ldap,srt[,I<filter>]
699 Collect call/reply SRT (Service Response Time) data for LDAP. Data collected
700 is the number of calls for each implemented LDAP command, MinSRT, MaxSRT and AvgSRT.
702 Example: B<-z ldap,srt>
703 will calculate the Service Response Time as the time delta between the
704 Request and the Response.
706 The data will be presented as separate tables for all implemented LDAP commands,
707 Only those commands that are seen in the capture will have its stats
710 This option can be used multiple times on the command line.
712 If the optional I<filter> is provided, the stats will only be calculated
713 on those calls that match that filter.
715 Example: use B<-z "ldap,srt,ip.addr==10.1.1.1"> will collect stats only for
716 LDAP packets exchanged by the host at IP address 10.1.1.1 .
718 The only LDAP commands that are currently implemented and for which the stats will be available are:
728 =item B<-z> mgcp,srt[I<,filter>]
730 Collect request/response SRT (Service Response Time) data for MGCP.
731 (This is similar to B<-z smb,srt>). Data collected is the number of calls
732 for each known MGCP Type, Minimum SRT, Maximum SRT and Average SRT.
734 Example: B<-z mgcp,srt>
736 This option can be used multiple times on the command line.
738 If the optional I<filter> is provided, the stats will only be calculated
739 on those calls that match that filter.
741 Example: B<-z "mgcp,srt,ip.addr==1.2.3.4"> will collect stats only for
742 MGCP packets exchanged by the host at IP address 1.2.3.4 .
744 =item B<-z> megaco,srt[I<,filter>]
746 Collect request/response SRT (Service Response Time) data for MEGACO.
747 (This is similar to B<-z smb,srt>). Data collected is the number of calls
748 for each known MEGACO Command, Minimum SRT, Maximum SRT and Average SRT.
750 Example: B<-z megaco,srt>
752 This option can be used multiple times on the command line.
754 If the optional I<filter> is provided, the stats will only be calculated
755 on those calls that match that filter.
757 Example: B<-z "megaco,srt,ip.addr==1.2.3.4"> will collect stats only for
758 MEGACO packets exchanged by the host at IP address 1.2.3.4 .
760 =item B<-z> conv,I<type>[,I<filter>]
762 Create a table that lists all conversations that could be seen in the
763 capture. I<type> specifies the conversation endpoint types for which we
764 want to generate the statistics; currently the supported ones are:
766 "eth" Ethernet addresses
767 "fc" Fibre Channel addresses
768 "fddi" FDDI addresses
770 "ipv6" IPv6 addresses
772 "tcp" TCP/IP socket pairs Both IPv4 and IPv6 are supported
773 "tr" Token Ring addresses
774 "udp" UDP/IP socket pairs Both IPv4 and IPv6 are supported
776 If the optional I<filter> is specified, only those packets that match the
777 filter will be used in the calculations.
779 The table is presented with one line for each conversation and displays
780 the number of packets/bytes in each direction as well as the total
781 number of packets/bytes. By default, the table is sorted according to
782 the total number of packets.
784 These tables can also be generated at runtime by selecting the appropriate
785 conversation type from the menu "Tools/Statistics/Conversation List/".
787 =item B<-z> h225,counter[I<,filter>]
789 Count ITU-T H.225 messages and their reasons. In the first column you get a
790 list of H.225 messages and H.225 message reasons which occur in the current
791 capture file. The number of occurrences of each message or reason is displayed
792 in the second column.
794 Example: B<-z h225,counter>
796 This option can be used multiple times on the command line.
798 If the optional I<filter> is provided, the stats will only be calculated
799 on those calls that match that filter.
801 Example: B<-z "h225,counter,ip.addr==1.2.3.4"> will collect stats only for
802 H.225 packets exchanged by the host at IP address 1.2.3.4 .
804 =item B<-z> h225,srt[I<,filter>]
806 Collect request/response SRT (Service Response Time) data for ITU-T H.225 RAS.
807 Data collected is the number of calls of each ITU-T H.225 RAS Message Type,
808 Minimum SRT, Maximum SRT, Average SRT, Minimum in Packet, and Maximum in Packet.
809 You will also get the number of Open Requests (Unresponded Requests),
810 Discarded Responses (Responses without matching request) and Duplicate Messages.
812 Example: B<-z h225,srt>
814 This option can be used multiple times on the command line.
816 If the optional I<filter> is provided, the stats will only be calculated
817 on those calls that match that filter.
819 Example: B<-z "h225,srt,ip.addr==1.2.3.4"> will collect stats only for
820 ITU-T H.225 RAS packets exchanged by the host at IP address 1.2.3.4 .
822 =item B<-z> sip,stat[I<,filter>]
824 This option will activate a counter for SIP messages. You will get the number
825 of occurrences of each SIP Method and of each SIP Status-Code. Additionally you
826 also get the number of resent SIP Messages (only for SIP over UDP).
828 Example: B<-z sip,stat>
830 This option can be used multiple times on the command line.
832 If the optional I<filter> is provided, the stats will only be calculated
833 on those calls that match that filter.
835 Example: B<-z "sip,stat,ip.addr==1.2.3.4"> will collect stats only for
836 SIP packets exchanged by the host at IP address 1.2.3.4 .
838 =item B<-z> voip,calls
840 This option will show a window that shows VoIP calls found in the capture file.
841 This is the same window shown as when you go to the Statistics Menu and choose
844 Example: B<-z voip,calls>
858 =item File:Open Recent
862 Merge another capture file to the currently loaded one. The I<File:Merge>
863 dialog box allows the merge "Prepended", "Chronologically" or "Appended",
864 relative to the already loaded one.
868 Open or close a capture file. The I<File:Open> dialog box
869 allows a filter to be specified; when the capture file is read, the
870 filter is applied to all packets read from the file, and packets not
871 matching the filter are discarded. The I<File:Open Recent> is a submenu
872 and will show a list of previously opened files.
878 Save the current capture, or the packets currently displayed from that
879 capture, to a file. Check boxes let you select whether to save all
880 packets, or just those that have passed the current display filter and/or
881 those that are currently marked, and an option menu lets you select (from
882 a list of file formats in which at particular capture, or the packets
883 currently displayed from that capture, can be saved), a file format in
886 =item File:File Set:List Files
888 Show a dialog box that lists all files of the file set matching the currently
889 loaded file. A file set is a compound of files resulting from a capture using
890 the "multiple files" / "ringbuffer" mode, recognizable by the filename pattern,
891 e.g.: Filename_00001_20050604101530.pcap.
893 =item File:File Set:Next File
895 =item File:File Set:Previous File
897 If the currently loaded file is part of a file set (see above), open the
898 next / previous file in that set.
902 Export captured data into an external format. Note: the data cannot be
903 imported back into Wireshark, so be sure to keep the capture file.
907 Print packet data from the current capture. You can select the range of
908 packets to be printed (which packets are printed), and the output format of
909 each packet (how each packet is printed). The output format will be similar
910 to the displayed values, so a summary line, the packet details view, and/or
911 the hex dump of the packet can be printed.
913 Printing options can be set with the I<Edit:Preferences> menu item, or in the
914 dialog box popped up by this menu item.
918 Exit the application.
920 =item Edit:Copy:Description
922 Copies the description of the selected field in the protocol tree to
925 =item Edit:Copy:Fieldname
927 Copies the fieldname of the selected field in the protocol tree to
930 =item Edit:Copy:Value
932 Copies the value of the selected field in the protocol tree to
935 =item Edit:Copy:As Filter
937 Create a display filter based on the data currently highlighted in the
938 packet details and copy that filter to the clipboard.
940 If that data is a field that can be tested in a display filter
941 expression, the display filter will test that field; otherwise, the
942 display filter will be based on the absolute offset within the packet.
943 Therefore it could be unreliable if the packet contains protocols with
944 variable-length headers, such as a source-routed token-ring packet.
946 =item Edit:Find Packet
948 Search forward or backward, starting with the currently selected packet
949 (or the most recently selected packet, if no packet is selected). Search
950 criteria can be a display filter expression, a string of hexadecimal
951 digits, or a text string.
953 When searching for a text string, you can search the packet data, or you
954 can search the text in the Info column in the packet list pane or in the
957 Hexadecimal digits can be separated by colons, periods, or dashes.
958 Text string searches can be ASCII or Unicode (or both), and may be
963 =item Edit:Find Previous
965 Search forward / backward for a packet matching the filter from the previous
966 search, starting with the currently selected packet (or the most recently
967 selected packet, if no packet is selected).
969 =item Edit:Mark Packet (toggle)
971 Mark (or unmark if currently marked) the selected packet. The field
972 "frame.marked" is set for packets that are marked, so that, for example,
973 a display filters can be used to display only marked packets, and so that
974 the L<Edit:Find Packet|/item_edit_3afind_packet> dialog can be used to find the next or previous
977 =item Edit:Find Next Mark
979 =item Edit:Find Previous Mark
981 Find next/previous marked packet.
983 =item Edit:Mark All Packets
985 =item Edit:Unmark All Packets
987 Mark / Unmark all packets that are currently displayed.
989 =item Edit:Time Reference:Set Time Reference (toggle)
991 Set (or unset if currently set) the selected packet as a Time Reference packet.
992 When a packet is set as a Time Reference packet, the timestamps in the packet
993 list pane will be replaced with the string "*REF*".
994 The relative time timestamp in later packets will then be calculated relative
995 to the timestamp of this Time Reference packet and not the first packet in
998 Packets that have been selected as Time Reference packets will always be
999 displayed in the packet list pane. Display filters will not affect or
1002 If there is a column displayed for "Cumulative Bytes" this counter will
1003 be reset at every Time Reference packet.
1005 =item Edit:Time Reference:Find Next
1007 =item Edit:Time Reference:Find Previous
1009 Search forward / backward for a time referenced packet.
1011 =item Edit:Configuration Profiles
1013 Manage configuration profiles to be able to use more than one set of
1014 preferences and configurations.
1016 =item Edit:Preferences
1018 Set the GUI, capture, printing and protocol options
1019 (see L<Preferences|/item_preferences> dialog below).
1021 =item View:Main Toolbar
1023 =item View:Filter Toolbar
1025 =item View:Statusbar
1027 Show or hide the main window controls.
1029 =item View:Packet List
1031 =item View:Packet Details
1033 =item View:Packet Bytes
1035 Show or hide the main window panes.
1037 =item View:Time Display Format
1039 Set the format of the packet timestamp displayed in the packet list window.
1041 =item View:Name Resolution:Resolve Name
1043 Try to resolve a name for the currently selected item.
1045 =item View:Name Resolution:Enable for ... Layer
1047 Enable or disable translation of addresses to names in the display.
1049 =item View:Colorize Packet List
1051 Enable or disable the coloring rules. Disabling will improve performance.
1053 =item View:Auto Scroll in Live Capture
1055 Enable or disable the automatic scrolling of the
1056 packet list while a live capture is in progress.
1062 Zoom into / out of the main window data (by changing the font size).
1064 =item View:Normal Size
1066 Reset the zoom factor of zoom in / zoom out back to normal font size.
1068 =item View:Resize All Columns
1070 Resize all columns to best fit the current packet display.
1072 =item View:Expand Subtrees
1074 Expands the currently selected item and it's subtrees in the packet details.
1076 =item View:Expand All
1078 =item View:Collapse All
1080 Expand / Collapse all branches of the packet details.
1082 =item View:Colorize Conversation
1084 Select color for a conversation.
1086 =item View:Reset Coloring 1-10
1088 Reset Color for a conversation.
1090 =item View:Coloring Rules
1092 Change the foreground and background colors of the packet information in
1093 the list of packets, based upon display filters. The list of display
1094 filters is applied to each packet sequentially. After the first display
1095 filter matches a packet, any additional display filters in the list are
1096 ignored. Therefore, if you are filtering on the existence of protocols,
1097 you should list the higher-level protocols first, and the lower-level
1102 =item How Colorization Works
1104 Packets are colored according to a list of color filters. Each filter
1105 consists of a name, a filter expression and a coloration. A packet is
1106 colored according to the first filter that it matches. Color filter
1107 expressions use exactly the same syntax as display filter expressions.
1109 When Wireshark starts, the color filters are loaded from:
1113 1. The user's personal color filters file or, if that does not exist,
1115 2. The global color filters file.
1119 If neither of these exist then the packets will not be colored.
1123 =item View:Show Packet In New Window
1125 Create a new window containing a packet details view and a hex dump
1126 window of the currently selected packet; this window will continue to
1127 display that packet's details and data even if another packet is
1132 Reload a capture file. Same as I<File:Close> and I<File:Open> the same
1137 Go back in previously visited packets history.
1141 Go forward in previously visited packets history.
1143 =item Go:Go To Packet
1145 Go to a particular numbered packet.
1147 =item Go:Go To Corresponding Packet
1149 If a field in the packet details pane containing a packet number is
1150 selected, go to the packet number specified by that field. (This works
1151 only if the dissector that put that entry into the packet details put it
1152 into the details as a filterable field rather than just as text.) This
1153 can be used, for example, to go to the packet for the request
1154 corresponding to a reply, or the reply corresponding to a request, if
1155 that packet number has been put into the packet details.
1157 =item Go:Previous Packet
1159 =item Go:Next Packet
1161 =item Go:First Packet
1163 =item Go:Last Packet
1165 Go to the previous / next / first / last packet in the capture.
1167 =item Go:Previous Packet In Conversation
1169 =item Go:Next Packet In Conversation
1171 Go to the previous / next packet of the conversation (TCP, UDP or IP)
1173 =item Capture:Interfaces
1175 Shows a dialog box with all currently known interfaces and displaying the
1176 current network traffic amount. Capture sessions can be started from here.
1177 Beware: keeping this box open results in high system load!
1179 =item Capture:Options
1181 Initiate a live packet capture (see L<Capture Options|/item_capture_options>
1182 dialog below). If no filename is specified, a temporary file will be created
1183 to hold the capture. The location of the file can be chosen by setting your
1184 TMPDIR environment variable before starting B<Wireshark>. Otherwise, the
1185 default TMPDIR location is system-dependent, but is likely either F</var/tmp>
1190 Start a live packet capture with the previously selected options. This won't
1191 open the options dialog box, and can be convenient for repeatedly capturing
1192 with the same options.
1196 Stop a running live capture.
1198 =item Capture:Restart
1200 While a live capture is running, stop it and restart with the same options
1201 again. This can be convenient to remove irrelevant packets, if no valuable
1202 packets were captured so far.
1204 =item Capture:Capture Filters
1206 Edit the saved list of capture filters, allowing filters to be added,
1207 changed, or deleted.
1209 =item Analyze:Display Filters
1211 Edit the saved list of display filters, allowing filters to be added,
1212 changed, or deleted.
1214 =item Analyze:Display Filter Macros
1216 Create shortcuts for complex macros
1218 =item Analyze:Apply as Filter
1220 Create a display filter based on the data currently highlighted in the
1221 packet details and apply the filter.
1223 If that data is a field that can be tested in a display filter
1224 expression, the display filter will test that field; otherwise, the
1225 display filter will be based on the absolute offset within the packet.
1226 Therefore it could be unreliable if the packet contains protocols with
1227 variable-length headers, such as a source-routed token-ring packet.
1229 The B<Selected> option creates a display filter that tests for a match
1230 of the data; the B<Not Selected> option creates a display filter that
1231 tests for a non-match of the data. The B<And Selected>, B<Or Selected>,
1232 B<And Not Selected>, and B<Or Not Selected> options add to the end of
1233 the display filter in the strip at the top (or bottom) an AND or OR
1234 operator followed by the new display filter expression.
1236 =item Analyze:Prepare a Filter
1238 Create a display filter based on the data currently highlighted in the
1239 packet details. The filter strip at the top (or bottom) is updated but
1240 it is not yet applied.
1242 =item Analyze:Enabled Protocols
1244 Allow protocol dissection to be enabled or disabled for a specific
1245 protocol. Individual protocols can be enabled or disabled by clicking
1246 on them in the list or by highlighting them and pressing the space bar.
1247 The entire list can be enabled, disabled, or inverted using the buttons
1250 When a protocol is disabled, dissection in a particular packet stops
1251 when that protocol is reached, and Wireshark moves on to the next packet.
1252 Any higher-layer protocols that would otherwise have been processed will
1253 not be displayed. For example, disabling TCP will prevent the dissection
1254 and display of TCP, HTTP, SMTP, Telnet, and any other protocol exclusively
1257 The list of protocols can be saved, so that Wireshark will start up with
1258 the protocols in that list disabled.
1260 =item Analyze:Decode As
1262 If you have a packet selected, present a dialog allowing you to change
1263 which dissectors are used to decode this packet. The dialog has one
1264 panel each for the link layer, network layer and transport layer
1265 protocol/port numbers, and will allow each of these to be changed
1266 independently. For example, if the selected packet is a TCP packet to
1267 port 12345, using this dialog you can instruct Wireshark to decode all
1268 packets to or from that TCP port as HTTP packets.
1270 =item Analyze:User Specified Decodes
1272 Create a new window showing whether any protocol ID to dissector
1273 mappings have been changed by the user. This window also allows the
1274 user to reset all decodes to their default values.
1276 =item Analyze:Follow TCP Stream
1278 If you have a TCP packet selected, display the contents of the data
1279 stream for the TCP connection to which that packet belongs, as text, in
1280 a separate window, and leave the list of packets in a filtered state,
1281 with only those packets that are part of that TCP connection being
1282 displayed. You can revert to your old view by pressing ENTER in the
1283 display filter text box, thereby invoking your old display filter (or
1284 resetting it back to no display filter).
1286 The window in which the data stream is displayed lets you select:
1292 whether to display the entire conversation, or one or the other side of
1297 whether the data being displayed is to be treated as ASCII or EBCDIC
1298 text or as raw hex data;
1302 and lets you print what's currently being displayed, using the same
1303 print options that are used for the I<File:Print Packet> menu item, or
1304 save it as text to a file.
1306 =item Analyze:Follow UDP Stream
1308 =item Analyze:Follow SSL Stream
1310 (Similar to Analyze:Follow TCP Stream)
1312 =item Analyze:Expert Info
1314 =item Analyze:Expert Info Composite
1316 (Kind of) a log of anomalies found by Wireshark in a capture file.
1318 =item Analyze:Conversation Filter
1320 =item Statistics:Summary
1322 Show summary information about the capture, including elapsed time,
1323 packet counts, byte counts, and the like. If a display filter is in
1324 effect, summary information will be shown about the capture and about
1325 the packets currently being displayed.
1327 =item Statistics:Protocol Hierarchy
1329 Show the number of packets, and the number of bytes in those packets,
1330 for each protocol in the trace. It organizes the protocols in the same
1331 hierarchy in which they were found in the trace. Besides counting the
1332 packets in which the protocol exists, a count is also made for packets
1333 in which the protocol is the last protocol in the stack. These
1334 last-protocol counts show you how many packets (and the byte count
1335 associated with those packets) B<ended> in a particular protocol. In
1336 the table, they are listed under "End Packets" and "End Bytes".
1338 =item Statistics:Conversations
1340 Lists of conversations; selectable by protocol. See Statistics:Conversation List below.
1342 =item Statistics:End Points
1344 List of End Point Addresses by protocol with packets/bytes/.... counts.
1346 =item Statistics:Packet Lengths
1348 Grouped counts of packet lengths (0-19 bytes, 20-39 bytes, ...)
1350 =item Statistics:IO Graphs
1352 Open a window where up to 5 graphs in different colors can be displayed
1353 to indicate number of packets or number of bytes per second for all packets
1354 matching the specified filter.
1355 By default only one graph will be displayed showing number of packets per second.
1357 The top part of the window contains the graphs and scales for the X and
1358 Y axis. If the graph is too long to fit inside the window there is a
1359 horizontal scrollbar below the drawing area that can scroll the graphs
1360 to the left or the right. The horizontal axis displays the time into
1361 the capture and the vertical axis will display the measured quantity at
1364 Below the drawing area and the scrollbar are the controls. On the
1365 bottom left there will be five similar sets of controls to control each
1366 individual graph such as "Display:<button>" which button will toggle
1367 that individual graph on/off. If <button> is ticked, the graph will be
1368 displayed. "Color:<color>" which is just a button to show which color
1369 will be used to draw that graph (color is only available in Gtk2
1370 version) and finally "Filter:<filter-text>" which can be used to specify
1371 a display filter for that particular graph.
1373 If filter-text is empty then all packets will be used to calculate the
1374 quantity for that graph. If filter-text is specified only those packets
1375 that match that display filter will be considered in the calculation of
1378 To the right of the 5 graph controls there are four menus to control
1379 global aspects of the draw area and graphs. The "Unit:" menu is used to
1380 control what to measure; "packets/tick", "bytes/tick" or "advanced..."
1382 packets/tick will measure the number of packets matching the (if
1383 specified) display filter for the graph in each measurement interval.
1385 bytes/tick will measure the total number of bytes in all packets matching
1386 the (if specified) display filter for the graph in each measurement
1389 advanced... see below
1391 "Tick interval:" specifies what measurement intervals to use. The
1392 default is 1 second and means that the data will be counted over 1
1395 "Pixels per tick:" specifies how many pixels wide each measurement
1396 interval will be in the drawing area. The default is 5 pixels per tick.
1398 "Y-scale:" controls the max value for the y-axis. Default value is
1399 "auto" which means that B<Wireshark> will try to adjust the maxvalue
1402 "advanced..." If Unit:advanced... is selected the window will display
1403 two more controls for each of the five graphs. One control will be a
1404 menu where the type of calculation can be selected from
1405 SUM,COUNT,MAX,MIN,AVG and LOAD, and one control, textbox, where the name of a
1406 single display filter field can be specified.
1408 The following restrictions apply to type and field combinations:
1410 SUM: available for all types of integers and will calculate the SUM of
1411 all occurrences of this field in the measurement interval. Note that
1412 some field can occur multiple times in the same packet and then all
1413 instances will be summed up. Example: 'tcp.len' which will count the
1414 amount of payload data transferred across TCP in each interval.
1416 COUNT: available for all field types. This will COUNT the number of times
1417 certain field occurs in each interval. Note that some fields
1418 may occur multiple times in each packet and if that is the case
1419 then each instance will be counted independently and COUNT
1420 will be greater than the number of packets.
1422 MAX: available for all integer and relative time fields. This will calculate
1423 the max seen integer/time value seen for the field during the interval.
1424 Example: 'smb.time' which will plot the maximum SMB response time.
1426 MIN: available for all integer and relative time fields. This will calculate
1427 the min seen integer/time value seen for the field during the interval.
1428 Example: 'smb.time' which will plot the minimum SMB response time.
1430 AVG: available for all integer and relative time fields.This will
1431 calculate the average seen integer/time value seen for the field during
1432 the interval. Example: 'smb.time' which will plot the average SMB
1435 LOAD: available only for relative time fields (response times).
1437 Example of advanced:
1438 Display how NFS response time MAX/MIN/AVG changes over time:
1442 filter:nfs&&rpc.time
1447 filter:nfs&&rpc.time
1452 filter:nfs&&rpc.time
1455 Example of advanced:
1456 Display how the average packet size from host a.b.c.d changes over time.
1460 filter:ip.addr==a.b.c.d&&frame.pkt_len
1461 Calc:AVG frame.pkt_len
1464 The LOAD io-stat type is very different from anything you have ever seen
1465 before! While the response times themselves as plotted by MIN,MAX,AVG are
1466 indications on the Server load (which affects the Server response time),
1467 the LOAD measurement measures the Client LOAD.
1468 What this measures is how much workload the client generates,
1469 i.e. how fast will the client issue new commands when the previous ones
1471 i.e. the level of concurrency the client can maintain.
1472 The higher the number, the more and faster is the client issuing new
1473 commands. When the LOAD goes down, it may be due to client load making
1474 the client slower in issuing new commands (there may be other reasons as
1475 well, maybe the client just doesn't have any commands it wants to issue
1478 Load is measured in concurrency/number of overlapping i/o and the value
1479 1000 means there is a constant load of one i/o.
1481 In each tick interval the amount of overlap is measured.
1482 See the graph below containing three commands:
1483 Below the graph are the LOAD values for each interval that would be calculated.
1487 | | o=====* | | | | | |
1489 | o========* | o============* | | |
1491 --------------------------------------------------> Time
1492 500 1500 500 750 1000 500 0 0
1494 =item Statistics:Conversation List
1496 This option will open a new window that displays a list of all
1497 conversations between two endpoints. The list has one row for each
1498 unique conversation and displays total number of packets/bytes seen as
1499 well as number of packets/bytes in each direction.
1501 By default the list is sorted according to the number of packets but by
1502 clicking on the column header; it is possible to re-sort the list in
1503 ascending or descending order by any column.
1505 By first selecting a conversation by clicking on it and then using the
1506 right mouse button (on those platforms that have a right
1507 mouse button) wireshark will display a popup menu offering several different
1508 filter operations to apply to the capture.
1510 These statistics windows can also be invoked from the Wireshark command
1511 line using the B<-z conv> argument.
1513 =item Statistics:Service Response Time
1529 Open a window to display Service Response Time statistics for an
1530 arbitrary DCE-RPC program
1531 interface and display B<Procedure>, B<Number of Calls>, B<Minimum SRT>,
1532 B<Maximum SRT> and B<Average SRT> for all procedures for that
1533 program/version. These windows opened will update in semi-real time to
1534 reflect changes when doing live captures or when reading new capture
1535 files into B<Wireshark>.
1537 This dialog will also allow an optional filter string to be used.
1538 If an optional filter string is used only such DCE-RPC request/response pairs
1539 that match that filter will be used to calculate the statistics. If no filter
1540 string is specified all request/response pairs will be used.
1550 Open a window to display Service Response Time statistics for Fibre Channel
1551 and display B<FC Type>, B<Number of Calls>, B<Minimum SRT>,
1552 B<Maximum SRT> and B<Average SRT> for all FC types.
1553 These windows opened will update in semi-real time to
1554 reflect changes when doing live captures or when reading new capture
1555 files into B<Wireshark>.
1556 The Service Response Time is calculated as the time delta between the
1557 First packet of the exchange and the Last packet of the exchange.
1559 This dialog will also allow an optional filter string to be used.
1560 If an optional filter string is used only such FC first/last exchange pairs
1561 that match that filter will be used to calculate the statistics. If no filter
1562 string is specified all request/response pairs will be used.
1572 Collect requests/response SRT (Service Response Time) data for ITU-T H.225 RAS.
1573 Data collected is B<number of calls> for each known ITU-T H.225 RAS Message Type,
1574 B<Minimum SRT>, B<Maximum SRT>, B<Average SRT>, B<Minimum in Packet>, and B<Maximum in Packet>.
1575 You will also get the number of B<Open Requests> (Unresponded Requests),
1576 B<Discarded Responses> (Responses without matching request) and Duplicate Messages.
1577 These windows opened will update in semi-real time to reflect changes when
1578 doing live captures or when reading new capture files into B<Wireshark>.
1580 You can apply an optional filter string in a dialog box, before starting
1581 the calculation. The statistics will only be calculated
1582 on those calls matching that filter.
1596 Collect requests/response SRT (Service Response Time) data for MGCP.
1597 Data collected is B<number of calls> for each known MGCP Type,
1598 B<Minimum SRT>, B<Maximum SRT>, B<Average SRT>, B<Minimum in Packet>, and B<Maximum in Packet>.
1599 These windows opened will update in semi-real time to reflect changes when
1600 doing live captures or when reading new capture files into B<Wireshark>.
1602 You can apply an optional filter string in a dialog box, before starting
1603 the calculation. The statistics will only be calculated
1604 on those calls matching that filter.
1614 Open a window to display statistics for an arbitrary ONC-RPC program interface
1615 and display B<Procedure>, B<Number of Calls>, B<Minimum SRT>, B<Maximum SRT> and B<Average SRT> for all procedures for that program/version.
1616 These windows opened will update in semi-real time to reflect changes when
1617 doing live captures or when reading new capture files into B<Wireshark>.
1619 This dialog will also allow an optional filter string to be used.
1620 If an optional filter string is used only such ONC-RPC request/response pairs
1621 that match that filter will be used to calculate the statistics. If no filter
1622 string is specified all request/response pairs will be used.
1624 By first selecting a conversation by clicking on it and then using the
1625 right mouse button (on those platforms that have a right
1626 mouse button) wireshark will display a popup menu offering several different
1627 filter operations to apply to the capture.
1641 Collect call/reply SRT (Service Response Time) data for SMB. Data collected
1642 is the number of calls for each SMB command, MinSRT, MaxSRT and AvgSRT.
1644 The data will be presented as separate tables for all normal SMB commands,
1645 all Transaction2 commands and all NT Transaction commands.
1646 Only those commands that are seen in the capture will have its stats
1648 Only the first command in a xAndX command chain will be used in the
1649 calculation. So for common SessionSetupAndX + TreeConnectAndX chains,
1650 only the SessionSetupAndX call will be used in the statistics.
1651 This is a flaw that might be fixed in the future.
1653 You can apply an optional filter string in a dialog box, before starting
1654 the calculation. The stats will only be calculated
1655 on those calls matching that filter.
1657 By first selecting a conversation by clicking on it and then using the
1658 right mouse button (on those platforms that have a right
1659 mouse button) wireshark will display a popup menu offering several different
1660 filter operations to apply to the capture.
1668 =item Statistics:BOOTP-DHCP
1672 =item Statistics:Compare
1674 Compare two Capture Files
1676 =item Statistics:Flow Graph
1678 Flow Graph: General/TCP
1680 =item Statistics:HTTP
1682 HTTP Load Distribution, Packet Counter & Requests
1684 =item Statistics:IP Addresses
1686 Count/Rate/Percent by IP Address
1688 =item Statistics:IP Destinations
1690 Count/Rate/Percent by IP Address/protocol/port
1692 =item Statistics:IP Protocol Types
1694 Count/Rate/Percent by IP Protocol Types
1696 =item Statistics:ONC-RPC Programs
1698 This dialog will open a window showing aggregated SRT statistics for all
1699 ONC-RPC Programs/versions that exist in the capture file.
1701 =item Statistics:TCP Stream Graph
1703 Graphs: Round Trip; Throughput; Time-Sequence (Stevens); Time-Sequence (tcptrace)
1705 =item Statistics:UDP Multicast streams
1707 Multicast Streams Counts/Rates/... by Source/Destination Address/Port pairs
1709 =item Statistics:WLAN Traffic
1711 WLAN Traffic Statistics
1713 =item Telephony:ITU-T H.225
1715 Count ITU-T H.225 messages and their reasons. In the first column you get a
1716 list of H.225 messages and H.225 message reasons, which occur in the current
1717 capture file. The number of occurrences of each message or reason will be displayed
1718 in the second column.
1719 This window opened will update in semi-real time to reflect changes when
1720 doing live captures or when reading new capture files into B<Wireshark>.
1722 You can apply an optional filter string in a dialog box, before starting
1723 the counter. The statistics will only be calculated
1724 on those calls matching that filter.
1728 Activate a counter for SIP messages. You will get the number of occurrences of each
1729 SIP Method and of each SIP Status-Code. Additionally you also get the number of
1730 resent SIP Messages (only for SIP over UDP).
1732 This window opened will update in semi-real time to reflect changes when
1733 doing live captures or when reading new capture files into B<Wireshark>.
1735 You can apply an optional filter string in a dialog box, before starting
1736 the counter. The statistics will only be calculated
1737 on those calls matching that filter.
1739 =item Tools:Firewall ACL Rules
1747 =item Help:Supported Protocols
1749 List of supported protocols and display filter protocol fields.
1751 =item Help:Manual Pages
1753 Display locally installed HTML versions of these manual pages in a web browser.
1755 =item Help:Wireshark Online
1757 Various links to online resources to be open in a web browser, like
1758 L<http://www.wireshark.org>.
1760 =item Help:About Wireshark
1762 See various information about Wireshark (see L<About|/item_about> dialog below), like the
1763 version, the folders used, the available plugins, ...
1773 The main window contains the usual things like the menu, some toolbars, the
1774 main area and a statusbar. The main area is split into three panes, you can
1775 resize each pane using a "thumb" at the right end of each divider line.
1777 The main window is much more flexible than before. The layout of the main
1778 window can be customized by the I<Layout> page in the dialog box popped
1779 up by I<Edit:Preferences>, the following will describe the layout with the
1786 Some menu items are available for quick access here. There is no way to
1787 customize the items in the toolbar, however the toolbar can be hidden by
1788 I<View:Main Toolbar>.
1790 =item Filter Toolbar
1792 A display filter can be entered into the filter toolbar.
1793 A filter for HTTP, HTTPS, and DNS traffic might look like this:
1795 tcp.port == 80 || tcp.port == 443 || tcp.port == 53
1797 Selecting the I<Filter:> button lets you choose from a list of named
1798 filters that you can optionally save. Pressing the Return or Enter
1799 keys, or selecting the I<Apply> button, will cause the filter to be
1800 applied to the current list of packets. Selecting the I<Reset> button
1801 clears the display filter so that all packets are displayed (again).
1803 There is no way to customize the items in the toolbar, however the toolbar
1804 can be hidden by I<View:Filter Toolbar>.
1806 =item Packet List Pane
1808 The top pane contains the list of network packets that you can scroll
1809 through and select. By default, the packet number, packet timestamp,
1810 source and destination addresses, protocol, and description are
1811 displayed for each packet; the I<Columns> page in the dialog box popped
1812 up by I<Edit:Preferences> lets you change this (although, unfortunately,
1813 you currently have to save the preferences, and exit and restart
1814 Wireshark, for those changes to take effect).
1816 If you click on the heading for a column, the display will be sorted by
1817 that column; clicking on the heading again will reverse the sort order
1820 An effort is made to display information as high up the protocol stack
1821 as possible, e.g. IP addresses are displayed for IP packets, but the
1822 MAC layer address is displayed for unknown packet types.
1824 The right mouse button can be used to pop up a menu of operations.
1826 The middle mouse button can be used to mark a packet.
1828 =item Packet Details Pane
1830 The middle pane contains a display of the details of the
1831 currently-selected packet. The display shows each field and its value
1832 in each protocol header in the stack. The right mouse button can be
1833 used to pop up a menu of operations.
1835 =item Packet Bytes Pane
1837 The lowest pane contains a hex and ASCII dump of the actual packet data.
1838 Selecting a field in the packet details highlights the corresponding
1839 bytes in this section.
1841 The right mouse button can be used to pop up a menu of operations.
1845 The statusbar is divided into three parts, on the left some context dependent
1846 things are shown, like information about the loaded file, in the center the
1847 number of packets are displayed, and on the right the current configuration
1850 The statusbar can be hidden by I<View:Statusbar>.
1856 The I<Preferences> dialog lets you control various personal preferences
1857 for the behavior of B<Wireshark>.
1861 =item User Interface Preferences
1863 The I<User Interface> page is used to modify small aspects of the GUI to
1864 your own personal taste:
1868 =item Selection Bars
1870 The selection bar in the packet list and packet details can have either
1871 a "browse" or "select" behavior. If the selection bar has a "browse"
1872 behavior, the arrow keys will move an outline of the selection bar,
1873 allowing you to browse the rest of the list or details without changing
1874 the selection until you press the space bar. If the selection bar has a
1875 "select" behavior, the arrow keys will move the selection bar and change
1876 the selection to the new item in the packet list or packet details.
1878 =item Save Window Position
1880 If this item is selected, the position of the main Wireshark window will
1881 be saved when Wireshark exits, and used when Wireshark is started again.
1883 =item Save Window Size
1885 If this item is selected, the size of the main Wireshark window will
1886 be saved when Wireshark exits, and used when Wireshark is started again.
1888 =item Save Window Maximized state
1890 If this item is selected the maximize state of the main Wireshark window
1891 will be saved when Wireshark exists, and used when Wireshark is started again.
1893 =item File Open Dialog Behavior
1895 This item allows the user to select how Wireshark handles the listing
1896 of the "File Open" Dialog when opening trace files. "Remember Last
1897 Directory" causes Wireshark to automatically position the dialog in the
1898 directory of the most recently opened file, even between launches of Wireshark.
1899 "Always Open in Directory" allows the user to define a persistent directory
1900 that the dialog will always default to.
1904 Allows the user to specify a persistent File Open directory. Trailing
1905 slashes or backslashes will automatically be added.
1907 =item File Open Preview timeout
1909 This items allows the user to define how much time is spend reading the
1910 capture file to present preview data in the File Open dialog.
1912 =item Open Recent maximum list entries
1914 The File menu supports a recent file list. This items allows the user to
1915 specify how many files are kept track of in this list.
1917 =item Ask for unsaved capture files
1919 When closing a capture file or Wireshark itself if the file isn't saved yet
1920 the user is presented the option to save the file when this item is set.
1922 =item Wrap during find
1924 This items determines the behavior when reaching the beginning or the end
1925 of a capture file. When set the search wraps around and continues, otherwise
1928 =item Settings dialogs show a save button
1930 This item determines if the various dialogs sport an explicit Save button
1931 or that save is implicit in OK / Apply.
1933 =item Web browser command
1935 This entry specifies the command line to launch a web browser. It is used
1936 to access online content, like the Wiki and user guide. Use '%s' to place
1937 the request URL in the command line.
1939 =item Display LEDs in the Expert Infos dialog tab labels
1941 This item determines if LED-like colored images are displayed in the
1942 Expert Infos dialog tab labels.
1946 =item Layout Preferences
1948 The I<Layout> page lets you specify the general layout of the main window.
1949 You can choose from six different layouts and fill the three panes with the
1956 The vertical scrollbars in the three panes can be set to be either on
1957 the left or the right.
1959 =item Alternating row colors
1963 The highlight method in the hex dump display for the selected protocol
1964 item can be set to use either inverse video, or bold characters.
1968 =item Filter toolbar placement
1970 =item Custom window title
1974 =item Column Preferences
1976 The I<Columns> page lets you specify the number, title, and format
1977 of each column in the packet list.
1979 The I<Column title> entry is used to specify the title of the column
1980 displayed at the top of the packet list. The type of data that the column
1981 displays can be specified using the I<Column format> option menu.
1982 The row of buttons on the left perform the following actions:
1988 Adds a new column to the list.
1992 Deletes the currently selected list item.
1996 Moves the selected list item up or down one position.
2000 =item Font Preferences
2002 The I<Font> page lets you select the font to be used for most text.
2004 =item Color Preferences
2006 The I<Colors> page can be used to change the color of the text
2007 displayed in the TCP stream window and for marked packets. To change a color,
2008 simply select an attribute from the "Set:" menu and use the color selector to
2009 get the desired color. The new text colors are displayed as a sample text.
2011 =item Capture Preferences
2013 The I<Capture> page lets you specify various parameters for capturing
2014 live packet data; these are used the first time a capture is started.
2016 The I<Interface:> combo box lets you specify the interface from which to
2017 capture packet data, or the name of a FIFO from which to get the packet
2020 The I<Data link type:> option menu lets you, for some interfaces, select
2021 the data link header you want to see on the packets you capture. For
2022 example, in some OSes and with some versions of libpcap, you can choose,
2023 on an 802.11 interface, whether the packets should appear as Ethernet
2024 packets (with a fake Ethernet header) or as 802.11 packets.
2026 The I<Limit each packet to ... bytes> check box lets you set the
2027 snapshot length to use when capturing live data; turn on the check box,
2028 and then set the number of bytes to use as the snapshot length.
2030 The I<Filter:> text entry lets you set a capture filter expression to be
2031 used when capturing.
2033 If any of the environment variables SSH_CONNECTION, SSH_CLIENT,
2034 REMOTEHOST, DISPLAY, or SESSIONNAME are set, Wireshark will create a
2035 default capture filter that excludes traffic from the hosts and ports
2036 defined in those variables.
2038 The I<Capture packets in promiscuous mode> check box lets you specify
2039 whether to put the interface in promiscuous mode when capturing.
2041 The I<Update list of packets in real time> check box lets you specify
2042 that the display should be updated as packets are seen.
2044 The I<Automatic scrolling in live capture> check box lets you specify
2045 whether, in an "Update list of packets in real time" capture, the packet
2046 list pane should automatically scroll to show the most recently captured
2049 =item Printing Preferences
2051 The radio buttons at the top of the I<Printing> page allow you choose
2052 between printing packets with the I<File:Print Packet> menu item as text
2053 or PostScript, and sending the output directly to a command or saving it
2054 to a file. The I<Command:> text entry box, on UNIX-compatible systems,
2055 is the command to send files to (usually B<lpr>), and the I<File:> entry
2056 box lets you enter the name of the file you wish to save to.
2057 Additionally, you can select the I<File:> button to browse the file
2058 system for a particular save file.
2060 =item Name Resolution Preferences
2062 The I<Enable MAC name resolution>, I<Enable network name resolution> and
2063 I<Enable transport name resolution> check boxes let you specify whether
2064 MAC addresses, network addresses, and transport-layer port numbers
2065 should be translated to names.
2067 The I<Enable concurrent DNS name resolution> allows Wireshark to send out
2068 multiple name resolution requests and not wait for the result before
2069 continuing dissection. This speeds up dissection with network name
2070 resolution but initially may miss resolutions. The number of concurrent
2071 requests can be set here as well.
2077 =item RTP Player Preferences
2079 This page allows you to select the number of channels visible in the
2080 RTP player window. It determines the height of the window, more channels
2081 are possible and visible by means of a scroll bar.
2083 =item Protocol Preferences
2085 There are also pages for various protocols that Wireshark dissects,
2086 controlling the way Wireshark handles those protocols.
2090 =item Edit Capture Filter List
2092 =item Edit Display Filter List
2094 =item Capture Filter
2096 =item Display Filter
2102 The I<Edit Capture Filter List> dialog lets you create, modify, and
2103 delete capture filters, and the I<Edit Display Filter List> dialog lets
2104 you create, modify, and delete display filters.
2106 The I<Capture Filter> dialog lets you do all of the editing operations
2107 listed, and also lets you choose or construct a filter to be used when
2110 The I<Display Filter> dialog lets you do all of the editing operations
2111 listed, and also lets you choose or construct a filter to be used to
2112 filter the current capture being viewed.
2114 The I<Read Filter> dialog lets you do all of the editing operations
2115 listed, and also lets you choose or construct a filter to be used to
2116 as a read filter for a capture file you open.
2118 The I<Search Filter> dialog lets you do all of the editing operations
2119 listed, and also lets you choose or construct a filter expression to be
2120 used in a find operation.
2122 In all of those dialogs, the I<Filter name> entry specifies a
2123 descriptive name for a filter, e.g. B<Web and DNS traffic>. The
2124 I<Filter string> entry is the text that actually describes the filtering
2125 action to take, as described above.The dialog buttons perform the
2132 If there is text in the two entry boxes, creates a new associated list
2137 Modifies the currently selected list item to match what's in the entry
2142 Deletes the currently selected list item.
2144 =item Add Expression...
2146 For display filter expressions, pops up a dialog box to allow you to
2147 construct a filter expression to test a particular field; it offers
2148 lists of field names, and, when appropriate, lists from which to select
2149 tests to perform on the field and values with which to compare it. In
2150 that dialog box, the OK button will cause the filter expression you
2151 constructed to be entered into the I<Filter string> entry at the current
2156 In the I<Capture Filter> dialog, closes the dialog box and makes the
2157 filter in the I<Filter string> entry the filter in the I<Capture
2158 Preferences> dialog. In the I<Display Filter> dialog, closes the dialog
2159 box and makes the filter in the I<Filter string> entry the current
2160 display filter, and applies it to the current capture. In the I<Read
2161 Filter> dialog, closes the dialog box and makes the filter in the
2162 I<Filter string> entry the filter in the I<Open Capture File> dialog.
2163 In the I<Search Filter> dialog, closes the dialog box and makes the
2164 filter in the I<Filter string> entry the filter in the I<Find Packet>
2169 Makes the filter in the I<Filter string> entry the current display
2170 filter, and applies it to the current capture.
2174 If the list of filters being edited is the list of
2175 capture filters, saves the current filter list to the personal capture
2176 filters file, and if the list of filters being edited is the list of
2177 display filters, saves the current filter list to the personal display
2182 Closes the dialog without doing anything with the filter in the I<Filter
2187 =item The Color Filters Dialog
2189 This dialog displays a list of color filters and allows it to be
2194 =item THE FILTER LIST
2196 Single rows may be selected by clicking. Multiple rows may be selected
2197 by using the ctrl and shift keys in combination with the mouse button.
2201 Adds a new filter at the bottom of the list and opens the Edit Color
2202 Filter dialog box. You will have to alter the filter expression at
2203 least before the filter will be accepted. The format of color filter
2204 expressions is identical to that of display filters. The new filter is
2205 selected, so it may immediately be moved up and down, deleted or edited.
2206 To avoid confusion all filters are unselected before the new filter is
2211 Opens the Edit Color Filter dialog box for the selected filter. (If this
2212 button is disabled you may have more than one filter selected, making it
2213 ambiguous which is to be edited.)
2217 Enables the selected color filter(s).
2221 Disables the selected color filter(s).
2225 Deletes the selected color filter(s).
2229 Allows you to choose a file in which to save the current list of color
2230 filters. You may also choose to save only the selected filters. A
2231 button is provided to save the filters in the global color filters file
2232 (you must have sufficient permissions to write this file, of course).
2236 Allows you to choose a file containing color filters which are then
2237 added to the bottom of the current list. All the added filters are
2238 selected, so they may be moved to the correct position in the list as a
2239 group. To avoid confusion, all filters are unselected before the new
2240 filters are imported. A button is provided to load the filters from the
2241 global color filters file.
2245 Deletes your personal color filters file, reloads the global
2246 color filters file, if any, and closes the dialog.
2250 Moves the selected filter(s) up the list, making it more likely that
2251 they will be used to color packets.
2255 Moves the selected filter(s) down the list, making it less likely that
2256 they will be used to color packets.
2260 Closes the dialog and uses the color filters as they stand.
2264 Colors the packets according to the current list of color filters, but
2265 does not close the dialog.
2269 Saves the current list of color filters in your personal color filters
2270 file. Unless you do this they will not be used the next time you start
2275 Closes the dialog without changing the coloration of the packets. Note
2276 that changes you have made to the current list of color filters are not
2281 =item Capture Options
2283 The I<Capture Options> dialog lets you specify various parameters for
2284 capturing live packet data.
2286 The I<Interface:> field lets you specify the interface from which to
2287 capture packet data or a command from which to get the packet data via a
2290 The I<Link layer header type:> field lets you specify the interfaces link
2291 layer header type. This field is usually disabled, as most interface have
2292 only one header type.
2294 The I<Capture packets in promiscuous mode> check box lets you specify
2295 whether the interface should be put into promiscuous mode when
2298 The I<Limit each packet to ... bytes> check box and field lets you
2299 specify a maximum number of bytes per packet to capture and save; if the
2300 check box is not checked, the limit will be 65535 bytes.
2302 The I<Capture Filter:> entry lets you specify the capture filter using a
2303 tcpdump-style filter string as described above.
2305 The I<File:> entry lets you specify the file into which captured packets
2306 should be saved, as in the I<Printer Options> dialog above. If not
2307 specified, the captured packets will be saved in a temporary file; you
2308 can save those packets to a file with the I<File:Save As> menu item.
2310 The I<Use multiple files> check box lets you specify that the capture
2311 should be done in "multiple files" mode. This option is disabled, if the
2312 I<Update list of packets in real time> option is checked.
2314 The I<Next file every ... megabyte(s)> check box and fields lets
2315 you specify that a switch to a next file should be done
2316 if the specified filesize is reached. You can also select the appropriate
2317 unit, but beware that the filesize has a maximum of 2 GB.
2318 The check box is forced to be checked, as "multiple files" mode requires a
2319 file size to be specified.
2321 The I<Next file every ... minute(s)> check box and fields lets
2322 you specify that the switch to a next file should be done after the specified
2323 time has elapsed, even if the specified capture size is not reached.
2325 The I<Ring buffer with ... files> field lets you specify the number
2326 of files of a ring buffer. This feature will capture into to the first file
2327 again, after the specified amount of files were used.
2329 The I<Stop capture after ... files> field lets you specify the number
2330 of capture files used, until the capture is stopped.
2332 The I<Stop capture after ... packet(s)> check box and field let
2333 you specify that Wireshark should stop capturing after having captured
2334 some number of packets; if the check box is not checked, Wireshark will
2335 not stop capturing at some fixed number of captured packets.
2337 The I<Stop capture after ... megabyte(s)> check box and field lets
2338 you specify that Wireshark should stop capturing after the file to which
2339 captured packets are being saved grows as large as or larger than some
2340 specified number of megabytes. If the check box is not checked, Wireshark
2341 will not stop capturing at some capture file size (although the operating
2342 system on which Wireshark is running, or the available disk space, may still
2343 limit the maximum size of a capture file). This option is disabled, if
2344 "multiple files" mode is used,
2346 The I<Stop capture after ... second(s)> check box and field let you
2347 specify that Wireshark should stop capturing after it has been capturing
2348 for some number of seconds; if the check box is not checked, Wireshark
2349 will not stop capturing after some fixed time has elapsed.
2351 The I<Update list of packets in real time> check box lets you specify
2352 whether the display should be updated as packets are captured and, if
2353 you specify that, the I<Automatic scrolling in live capture> check box
2354 lets you specify the packet list pane should automatically scroll to
2355 show the most recently captured packets as new packets arrive.
2357 The I<Enable MAC name resolution>, I<Enable network name resolution> and
2358 I<Enable transport name resolution> check boxes let you specify whether
2359 MAC addresses, network addresses, and transport-layer port numbers
2360 should be translated to names.
2364 The I<About> dialog lets you view various information about Wireshark.
2366 =item About:Wireshark
2368 The I<Wireshark> page lets you view general information about Wireshark,
2369 like the installed version, licensing information and such.
2373 The I<Authors> page shows the author and all contributors.
2377 The I<Folders> page lets you view the directory names where Wireshark is
2378 searching it's various configuration and other files.
2382 The I<Plugins> page lets you view the dissector plugin modules
2383 available on your system.
2385 The I<Plugins List> shows the name and version of each dissector plugin
2386 module found on your system.
2388 On Unix-compatible systems, the plugins are looked for in the following
2389 directories: the F<lib/wireshark/plugins/$VERSION> directory under the
2390 main installation directory (for example,
2391 F</usr/local/lib/wireshark/plugins/$VERSION>), and then
2392 F<$HOME/.wireshark/plugins>.
2394 On Windows systems, the plugins are looked for in the following
2395 directories: F<plugins\$VERSION> directory under the main installation
2396 directory (for example, F<C:\Program Files\Wireshark\plugins\$VERSION>),
2397 and then F<%APPDATA%\Wireshark\plugins\$VERSION> (or, if %APPDATA% isn't
2398 defined, F<%USERPROFILE%\Application Data\Wireshark\plugins\$VERSION>).
2400 $VERSION is the version number of the plugin interface, which
2401 is typically the version number of Wireshark. Note that a dissector
2402 plugin module may support more than one protocol; there is not
2403 necessarily a one-to-one correspondence between dissector plugin modules
2404 and protocols. Protocols supported by a dissector plugin module are
2405 enabled and disabled using the I<Edit:Protocols> dialog box, just as
2406 protocols built into Wireshark are.
2410 =head1 CAPTURE FILTER SYNTAX
2412 See the manual page of pcap-filter(4) or, if that doesn't exist, tcpdump(8),
2413 or, if that doesn't exist, L<http://wiki.wireshark.org/CaptureFilters>.
2415 =head1 DISPLAY FILTER SYNTAX
2417 For a complete table of protocol and protocol fields that are filterable
2418 in B<Wireshark> see the wireshark-filter(4) manual page.
2422 These files contains various B<Wireshark> configuration settings.
2428 The F<preferences> files contain global (system-wide) and personal
2429 preference settings. If the system-wide preference file exists, it is
2430 read first, overriding the default settings. If the personal preferences
2431 file exists, it is read next, overriding any previous values. Note: If
2432 the command line flag B<-o> is used (possibly more than once), it will
2433 in turn override values from the preferences files.
2435 The preferences settings are in the form I<prefname>B<:>I<value>,
2437 where I<prefname> is the name of the preference
2438 and I<value> is the value to
2439 which it should be set; white space is allowed between B<:> and
2440 I<value>. A preference setting can be continued on subsequent lines by
2441 indenting the continuation lines with white space. A B<#> character
2442 starts a comment that runs to the end of the line:
2444 # Vertical scrollbars should be on right side?
2445 # TRUE or FALSE (case-insensitive).
2446 gui.scrollbar_on_right: TRUE
2448 The global preferences file is looked for in the F<wireshark> directory
2449 under the F<share> subdirectory of the main installation directory (for
2450 example, F</usr/local/share/wireshark/preferences>) on UNIX-compatible
2451 systems, and in the main installation directory (for example,
2452 F<C:\Program Files\Wireshark\preferences>) on Windows systems.
2454 The personal preferences file is looked for in F<$HOME/.wireshark/preferences> on
2455 UNIX-compatible systems and F<%APPDATA%\Wireshark\preferences> (or, if
2456 %APPDATA% isn't defined, F<%USERPROFILE%\Application
2457 Data\Wireshark\preferences>) on Windows systems.
2459 Note: Whenever the preferences are saved by using the I<Save> button
2460 in the I<Edit:Preferences> dialog box, your personal preferences file
2461 will be overwritten with the new settings, destroying any comments and
2462 unknown/obsolete settings that were in the file.
2466 The F<recent> file contains personal settings (mostly GUI related) such
2467 as the current B<Wireshark> window size. The file is saved at program exit and
2468 read in at program start automatically. Note: The command line flag B<-o>
2469 may be used to override settings from this file.
2471 The settings in this file have the same format as in the F<preferences>
2472 files, and the same directory as for the personal preferences file is
2475 Note: Whenever Wireshark is closed, your recent file
2476 will be overwritten with the new settings, destroying any comments and
2477 unknown/obsolete settings that were in the file.
2479 =item Disabled (Enabled) Protocols
2481 The F<disabled_protos> files contain system-wide and personal lists of
2482 protocols that have been disabled, so that their dissectors are never
2483 called. The files contain protocol names, one per line, where the
2484 protocol name is the same name that would be used in a display filter
2490 If a protocol is listed in the global F<disabled_protos> file, it is not
2491 displayed in the I<Analyze:Enabled Protocols> dialog box, and so cannot
2492 be enabled by the user.
2494 The global F<disabled_protos> file uses the same directory as the global
2497 The personal F<disabled_protos> file uses the same directory as the
2498 personal preferences file.
2500 Note: Whenever the disabled protocols list is saved by using the I<Save>
2501 button in the I<Analyze:Enabled Protocols> dialog box, your personal
2502 disabled protocols file will be overwritten with the new settings,
2503 destroying any comments that were in the file.
2505 =item Name Resolution (hosts)
2507 If the personal F<hosts> file exists, it is
2508 used to resolve IPv4 and IPv6 addresses before any other
2509 attempts are made to resolve them. The file has the standard F<hosts>
2510 file syntax; each line contains one IP address and name, separated by
2511 whitespace. The same directory as for the personal preferences file is used.
2513 Capture filter name resolution is handled by libpcap on UNIX-compatible
2514 systems and WinPCAP on Windows. As such the Wireshark personal F<hosts> file
2515 will not be consulted for capture filter name resolution.
2517 =item Name Resolution (ethers)
2519 The F<ethers> files are consulted to correlate 6-byte hardware addresses to
2520 names. First the personal F<ethers> file is tried and if an address is not
2521 found there the global F<ethers> file is tried next.
2523 Each line contains one hardware address and name, separated by
2524 whitespace. The digits of the hardware address are separated by colons
2525 (:), dashes (-) or periods (.). The same separator character must be
2526 used consistently in an address. The following three lines are valid
2527 lines of an F<ethers> file:
2529 ff:ff:ff:ff:ff:ff Broadcast
2530 c0-00-ff-ff-ff-ff TR_broadcast
2531 00.00.00.00.00.00 Zero_broadcast
2533 The global F<ethers> file is looked for in the F</etc> directory on
2534 UNIX-compatible systems, and in the main installation directory (for
2535 example, F<C:\Program Files\Wireshark>) on Windows systems.
2537 The personal F<ethers> file is looked for in the same directory as the personal
2540 Capture filter name resolution is handled by libpcap on UNIX-compatible
2541 systems and WinPCAP on Windows. As such the Wireshark personal F<ethers> file
2542 will not be consulted for capture filter name resolution.
2544 =item Name Resolution (manuf)
2546 The F<manuf> file is used to match the 3-byte vendor portion of a 6-byte
2547 hardware address with the manufacturer's name; it can also contain well-known
2548 MAC addresses and address ranges specified with a netmask. The format of the
2549 file is the same as the F<ethers> files, except that entries such as:
2553 can be provided, with the 3-byte OUI and the name for a vendor, and
2556 00-00-0C-07-AC/40 All-HSRP-routers
2558 can be specified, with a MAC address and a mask indicating how many bits
2559 of the address must match. The above entry, for example, has 40
2560 significant bits, or 5 bytes, and would match addresses from
2561 00-00-0C-07-AC-00 through 00-00-0C-07-AC-FF. The mask need not be a
2564 The F<manuf> file is looked for in the same directory as the global
2567 =item Name Resolution (ipxnets)
2569 The F<ipxnets> files are used to correlate 4-byte IPX network numbers to
2570 names. First the global F<ipxnets> file is tried and if that address is not
2571 found there the personal one is tried next.
2573 The format is the same as the F<ethers>
2574 file, except that each address is four bytes instead of six.
2575 Additionally, the address can be represented as a single hexadecimal
2576 number, as is more common in the IPX world, rather than four hex octets.
2577 For example, these four lines are valid lines of an F<ipxnets> file:
2581 00:00:BE:EF IT_Server1
2584 The global F<ipxnets> file is looked for in the F</etc> directory on
2585 UNIX-compatible systems, and in the main installation directory (for
2586 example, F<C:\Program Files\Wireshark>) on Windows systems.
2588 The personal F<ipxnets> file is looked for in the same directory as the
2589 personal preferences file.
2591 =item Capture Filters
2593 The F<cfilters> files contain system-wide and personal capture filters.
2594 Each line contains one filter, starting with the string displayed in the
2595 dialog box in quotation marks, followed by the filter string itself:
2600 The global F<cfilters> file uses the same directory as the
2601 global preferences file.
2603 The personal F<cfilters> file uses the same directory as the personal
2604 preferences file. It is written through the Capture:Capture Filters
2607 If the global F<cfilters> file exists, it is used only if the personal
2608 F<cfilters> file does not exist; global and personal capture filters are
2611 =item Display Filters
2613 The F<dfilters> files contain system-wide and personal display filters.
2614 Each line contains one filter, starting with the string displayed in the
2615 dialog box in quotation marks, followed by the filter string itself:
2620 The global F<dfilters> file uses the same directory as the
2621 global preferences file.
2623 The personal F<dfilters> file uses the same directory as the
2624 personal preferences file. It is written through the Analyze:Display
2627 If the global F<dfilters> file exists, it is used only if the personal
2628 F<dfilters> file does not exist; global and personal display filters are
2631 =item Color Filters (Coloring Rules)
2633 The F<colorfilters> files contain system-wide and personal color filters.
2634 Each line contains one filter, starting with the string displayed in the
2635 dialog box, followed by the corresponding display filter. Then the
2636 background and foreground colors are appended:
2639 @tcp@tcp@[59345,58980,65534][0,0,0]
2640 @udp@udp@[28834,57427,65533][0,0,0]
2642 The global F<colorfilters> file uses the same directory as the
2643 global preferences file.
2645 The personal F<colorfilters> file uses the same directory as the
2646 personal preferences file. It is written through the View:Coloring Rules
2649 If the global F<colorfilters> file exists, it is used only if the personal
2650 F<colorfilters> file does not exist; global and personal color filters are
2655 The F<gtkrc> files contain system-wide and personal GTK theme settings.
2657 The global F<gtkrc> file uses the same directory as the
2658 global preferences file.
2660 The personal F<gtkrc> file uses the same directory as the personal
2665 See above in the description of the About:Plugins page.
2669 =head1 ENVIRONMENT VARIABLES
2673 =item WIRESHARK_DEBUG_EP_NO_CHUNKS
2675 Normally per-packet memory is allocated in large "chunks." This behavior
2676 doesn't work well with debugging tools such as Valgrind or ElectricFence.
2677 Export this environment variable to force individual allocations.
2678 Note: disabling chunks also disables canaries (see below).
2680 =item WIRESHARK_DEBUG_SE_NO_CHUNKS
2682 Normally per-file memory is allocated in large "chunks." This behavior
2683 doesn't work well with debugging tools such as Valgrind or ElectricFence.
2684 Export this environment variable to force individual allocations.
2685 Note: disabling chunks also disables canaries (see below).
2687 =item WIRESHARK_DEBUG_EP_NO_CANARY
2689 Normally per-packet memory allocations are separated by "canaries" which
2690 allow detection of memory overruns. This comes at the expense of some extra
2691 memory usage. Exporting this environment variable disables these canaries.
2693 =item WIRESHARK_DEBUG_SE_USE_CANARY
2695 Exporting this environment variable causes per-file memory allocations to be
2696 protected with "canaries" which allow for detection of memory overruns.
2697 This comes at the expense of significant extra memory usage.
2699 =item WIRESHARK_DEBUG_SCRUB_MEMORY
2701 If this environment variable is exported, the contents of per-packet and
2702 per-file memory is initialized to 0xBADDCAFE when the memory is allocated
2703 and is reset to 0xDEADBEEF when the memory is freed. This functionality is
2704 useful mainly to developers looking for bugs in the way memory is handled.
2706 =item WIRESHARK_RUN_FROM_BUILD_DIRECTORY
2708 This environment variable causes the plugins and other data files to be loaded
2709 from the build directory (where the program was compiled) rather than from the
2710 standard locations. It has no effect when the program in question is running
2711 with root (or setuid) permissions on *NIX.
2713 =item WIRESHARK_DATA_DIR
2715 This environment variable causes the various data files to be loaded from
2716 a directory other than the standard locations. It has no effect when the
2717 program in question is running with root (or setuid) permissions on *NIX.
2719 =item WIRESHARK_PYTHON_DIR
2721 This environment variable points to an alternate location for Python.
2722 It has no effect when the program in question is running with root (or setuid)
2723 permissions on *NIX.
2725 =item ERF_RECORDS_TO_CHECK
2727 This environment variable controls the number of ERF records checked when
2728 deciding if a file really is in the ERF format. Setting this environment
2729 variable a number higher than the default (20) would make false positives
2732 =item IPFIX_RECORDS_TO_CHECK
2734 This environment variable controls the number of IPFIX records checked when
2735 deciding if a file really is in the IPFIX format. Setting this environment
2736 variable a number higher than the default (20) would make false positives
2739 =item WIRESHARK_ABORT_ON_DISSECTOR_BUG
2741 If this environment variable is set, B<Wireshark> will call abort(3)
2742 when a dissector bug is encountered. abort(3) will cause the program to
2743 exit abnormally; if you are running B<Wireshark> in a debugger, it
2744 should halt in the debugger and allow inspection of the process, and, if
2745 you are not running it in a debugger, it will, on some OSes, assuming
2746 your environment is configured correctly, generate a core dump file.
2747 This can be useful to developers attempting to troubleshoot a problem
2748 with a protocol dissector.
2750 =item WIRESHARK_EP_VERIFY_POINTERS
2752 This environment variable, if exported, causes certain uses of pointers to be
2753 audited to ensure they do not point to memory that is deallocated after each
2754 packet has been fully dissected. This can be useful to developers writing or
2757 =item WIRESHARK_SE_VERIFY_POINTERS
2759 This environment variable, if exported, causes certain uses of pointers to be
2760 audited to ensure they do not point to memory that is deallocated after when
2761 a capture file is closed. This can be useful to developers writing or
2764 =item WIRESHARK_QUIT_AFTER_CAPTURE
2766 Cause B<Wireshark> to exit after the end of the capture session. This
2767 doesn't automatically start a capture; you must still use B<-k> to do
2768 that. You must also specify an autostop condition, e.g. B<-c> or B<-a
2769 duration:...>. This means that you will not be able to see the results
2770 of the capture after it stops; it's primarily useful for testing.
2776 wireshark-filter(4), tshark(1), editcap(1), pcap-filter(4), tcpdump(8),
2777 pcap(3), dumpcap(1), mergecap(1), text2pcap(1)
2781 The latest version of B<Wireshark> can be found at
2782 L<http://www.wireshark.org>.
2784 HTML versions of the Wireshark project man pages are available at:
2785 L<http://www.wireshark.org/docs/man-pages>.