9 wireshark - Interactively dump and analyze network traffic
14 S<[ B<-a> E<lt>capture autostop conditionE<gt> ] ...>
15 S<[ B<-b> E<lt>capture ring buffer optionE<gt> ] ...>
16 S<[ B<-B> E<lt>capture buffer sizeE<gt> ] >
17 S<[ B<-c> E<lt>capture packet countE<gt> ]>
18 S<[ B<-C> E<lt>configuration profileE<gt> ]>
20 S<[ B<--display=>E<lt>X display to useE<gt> ] >
21 S<[ B<-f> E<lt>capture filterE<gt> ]>
22 S<[ B<-g> E<lt>packet numberE<gt> ]>
25 S<[ B<-i> E<lt>capture interfaceE<gt>|- ]>
28 S<[ B<-J> E<lt>jump filterE<gt> ]>
30 S<[ B<-K> E<lt>keytabE<gt> ]>
33 S<[ B<-m> E<lt>fontE<gt> ]>
35 S<[ B<-N> E<lt>name resolving flagsE<gt> ] >
36 S<[ B<-o> E<lt>preference/recent settingE<gt> ] ...>
38 S<[ B<-P> E<lt>path settingE<gt>]>
39 S<[ B<-r> E<lt>infileE<gt> ]>
40 S<[ B<-R> E<lt>read (display) filterE<gt> ]>
41 S<[ B<-s> E<lt>capture snaplenE<gt> ]>
43 S<[ B<-t> a|ad|adoy|d|dd|e|r|u|ud|udoy ]>
45 S<[ B<-w> E<lt>outfileE<gt> ]>
46 S<[ B<-X> E<lt>eXtension optionE<gt> ]>
47 S<[ B<-y> E<lt>capture link typeE<gt> ]>
48 S<[ B<-Y> E<lt>displaY filterE<gt> ]>
49 S<[ B<-z> E<lt>statisticsE<gt> ]>
50 S<[ E<lt>infileE<gt> ]>
54 B<Wireshark> is a GUI network protocol analyzer. It lets you
55 interactively browse packet data from a live network or from a
56 previously saved capture file. B<Wireshark>'s native capture file format
57 is B<pcap> format, which is also the format used by B<tcpdump> and
60 B<Wireshark> can read / import the following file formats:
65 pcap - captures from B<Wireshark>/B<TShark>/B<dumpcap>, B<tcpdump>,
66 and various other tools using libpcap's/WinPcap's/tcpdump's/WinDump's
70 pcap-ng - "next-generation" successor to pcap format
73 B<snoop> and B<atmsnoop> captures
76 Shomiti/Finisar B<Surveyor> captures
79 Novell B<LANalyzer> captures
82 Microsoft B<Network Monitor> captures
85 AIX's B<iptrace> captures
88 Cinco Networks B<NetXRay> captures
91 Network Associates Windows-based B<Sniffer> captures
94 Network General/Network Associates DOS-based B<Sniffer> (compressed or uncompressed) captures
97 AG Group/WildPackets B<EtherPeek>/B<TokenPeek>/B<AiroPeek>/B<EtherHelp>/B<PacketGrabber> captures
100 B<RADCOM>'s WAN/LAN analyzer captures
103 Network Instruments B<Observer> version 9 captures
106 B<Lucent/Ascend> router debug output
109 files from HP-UX's B<nettl>
112 B<Toshiba's> ISDN routers dump output
115 the output from B<i4btrace> from the ISDN4BSD project
118 traces from the B<EyeSDN> USB S0.
121 the output in B<IPLog> format from the Cisco Secure Intrusion Detection System
124 B<pppd logs> (pppdump format)
127 the output from VMS's B<TCPIPtrace>/B<TCPtrace>/B<UCX$TRACE> utilities
130 the text output from the B<DBS Etherwatch> VMS utility
133 Visual Networks' B<Visual UpTime> traffic capture
136 the output from B<CoSine> L2 debug
139 the output from InfoVista's B<5View> LAN agents
142 Endace Measurement Systems' ERF format captures
145 Linux Bluez Bluetooth stack B<hcidump -w> traces
148 Catapult DCT2000 .out files
151 Gammu generated text output from Nokia DCT3 phones in Netmonitor mode
154 IBM Series (OS/400) Comm traces (ASCII & UNICODE)
157 Juniper Netscreen snoop files
160 Symbian OS btsnoop files
163 TamoSoft CommView files
166 Textronix K12xx 32bit .rf5 format files
169 Textronix K12 text file format captures
172 Apple PacketLogger files
175 Files from Aethra Telecommunications' PC108 software for their test
179 MPEG-2 Transport Streams as defined in ISO/IEC 13818-1
182 Rabbit Labs CAM Inspector files
186 There is no need to tell B<Wireshark> what type of
187 file you are reading; it will determine the file type by itself.
188 B<Wireshark> is also capable of reading any of these file formats if they
189 are compressed using gzip. B<Wireshark> recognizes this directly from
190 the file; the '.gz' extension is not required for this purpose.
192 Like other protocol analyzers, B<Wireshark>'s main window shows 3 views
193 of a packet. It shows a summary line, briefly describing what the
194 packet is. A packet details display is shown, allowing you to drill
195 down to exact protocol or field that you interested in. Finally, a hex
196 dump shows you exactly what the packet looks like when it goes over the
199 In addition, B<Wireshark> has some features that make it unique. It can
200 assemble all the packets in a TCP conversation and show you the ASCII
201 (or EBCDIC, or hex) data in that conversation. Display filters in
202 B<Wireshark> are very powerful; more fields are filterable in B<Wireshark>
203 than in other protocol analyzers, and the syntax you can use to create
204 your filters is richer. As B<Wireshark> progresses, expect more and more
205 protocol fields to be allowed in display filters.
207 Packet capturing is performed with the pcap library. The capture filter
208 syntax follows the rules of the pcap library. This syntax is different
209 from the display filter syntax.
211 Compressed file support uses (and therefore requires) the zlib library.
212 If the zlib library is not present, B<Wireshark> will compile, but will
213 be unable to read compressed files.
215 The pathname of a capture file to be read can be specified with the
216 B<-r> option or can be specified as a command-line argument.
220 Most users will want to start B<Wireshark> without options and configure
221 it from the menus instead. Those users may just skip this section.
225 =item -a E<lt>capture autostop conditionE<gt>
227 Specify a criterion that specifies when B<Wireshark> is to stop writing
228 to a capture file. The criterion is of the form I<test>B<:>I<value>,
229 where I<test> is one of:
231 B<duration>:I<value> Stop writing to a capture file after I<value> seconds have
234 B<filesize>:I<value> Stop writing to a capture file after it reaches a size of
235 I<value> kB. If this option is used together with the -b option, Wireshark
236 will stop writing to the current capture file and switch to the next one if
237 filesize is reached. Note that the filesize is limited to a maximum value of
240 B<files>:I<value> Stop writing to capture files after I<value> number of files
243 =item -b E<lt>capture ring buffer optionE<gt>
245 Cause B<Wireshark> to run in "multiple files" mode. In "multiple files" mode,
246 B<Wireshark> will write to several capture files. When the first capture file
247 fills up, B<Wireshark> will switch writing to the next file and so on.
249 The created filenames are based on the filename given with the B<-w> flag,
250 the number of the file and on the creation date and time,
251 e.g. outfile_00001_20050604120117.pcap, outfile_00002_20050604120523.pcap, ...
253 With the I<files> option it's also possible to form a "ring buffer".
254 This will fill up new files until the number of files specified,
255 at which point B<Wireshark> will discard the data in the first file and start
256 writing to that file and so on. If the I<files> option is not set,
257 new files filled up until one of the capture stop conditions match (or
258 until the disk is full).
260 The criterion is of the form I<key>B<:>I<value>,
261 where I<key> is one of:
263 B<duration>:I<value> switch to the next file after I<value> seconds have
264 elapsed, even if the current file is not completely filled up.
266 B<filesize>:I<value> switch to the next file after it reaches a size of
267 I<value> kB. Note that the filesize is limited to a maximum value of 2 GiB.
269 B<files>:I<value> begin again with the first file after I<value> number of
270 files were written (form a ring buffer). This value must be less than 100000.
271 Caution should be used when using large numbers of files: some filesystems do
272 not handle many files in a single directory well. The B<files> criterion
273 requires either B<duration> or B<filesize> to be specified to control when to
274 go to the next file. It should be noted that each B<-b> parameter takes exactly
275 one criterion; to specify two criterion, each must be preceded by the B<-b>
278 Example: B<-b filesize:1000 -b files:5> results in a ring buffer of five files
279 of size one megabyte each.
281 =item -B E<lt>capture buffer sizeE<gt>
283 Set capture buffer size (in MiB, default is 2 MiB). This is used by
284 the capture driver to buffer packet data until that data can be written
285 to disk. If you encounter packet drops while capturing, try to increase
286 this size. Note that, while B<Wireshark> attempts to set the buffer size
287 to 2 MiB by default, and can be told to set it to a larger value, the
288 system or interface on which you're capturing might silently limit the
289 capture buffer size to a lower value or raise it to a higher value.
291 This is available on UNIX systems with libpcap 1.0.0 or later and on
292 Windows. It is not available on UNIX systems with earlier versions of
295 This option can occur multiple times. If used before the first
296 occurrence of the B<-i> option, it sets the default capture buffer size.
297 If used after an B<-i> option, it sets the capture buffer size for
298 the interface specified by the last B<-i> option occurring before
299 this option. If the capture buffer size is not set specifically,
300 the default capture buffer size is used instead.
302 =item -c E<lt>capture packet countE<gt>
304 Set the maximum number of packets to read when capturing live
307 =item -C E<lt>configuration profileE<gt>
309 Start with the given configuration profile.
313 Print a list of the interfaces on which B<Wireshark> can capture, and
314 exit. For each network interface, a number and an
315 interface name, possibly followed by a text description of the
316 interface, is printed. The interface name or the number can be supplied
317 to the B<-i> flag to specify an interface on which to capture.
319 This can be useful on systems that don't have a command to list them
320 (e.g., Windows systems, or UNIX systems lacking B<ifconfig -a>);
321 the number can be useful on Windows 2000 and later systems, where the
322 interface name is a somewhat complex string.
324 Note that "can capture" means that B<Wireshark> was able to open
325 that device to do a live capture; if, on your system, a program doing a
326 network capture must be run from an account with special privileges (for
327 example, as root), then, if B<Wireshark> is run with the B<-D> flag and
328 is not run from such an account, it will not list any interfaces.
330 =item --display=E<lt>X display to useE<gt>
332 Specifies the X display to use. A hostname and screen (otherhost:0.0)
333 or just a screen (:0.0) can be specified. This option is not available
336 =item -f E<lt>capture filterE<gt>
338 Set the capture filter expression.
340 This option can occur multiple times. If used before the first
341 occurrence of the B<-i> option, it sets the default capture filter expression.
342 If used after an B<-i> option, it sets the capture filter expression for
343 the interface specified by the last B<-i> option occurring before
344 this option. If the capture filter expression is not set specifically,
345 the default capture filter expression is used if provided.
347 =item -g E<lt>packet numberE<gt>
349 After reading in a capture file using the B<-r> flag, go to the given I<packet number>.
353 Print the version and options and exit.
357 Hide the capture info dialog during live packet capture.
359 =item -i E<lt>capture interfaceE<gt>|-
361 Set the name of the network interface or pipe to use for live packet
364 Network interface names should match one of the names listed in
365 "B<wireshark -D>" (described above); a number, as reported by
366 "B<wireshark -D>", can also be used. If you're using UNIX, "B<netstat
367 -i>" or "B<ifconfig -a>" might also work to list interface names,
368 although not all versions of UNIX support the B<-a> flag to B<ifconfig>.
370 If no interface is specified, B<Wireshark> searches the list of
371 interfaces, choosing the first non-loopback interface if there are any
372 non-loopback interfaces, and choosing the first loopback interface if
373 there are no non-loopback interfaces. If there are no interfaces at all,
374 B<Wireshark> reports an error and doesn't start the capture.
376 Pipe names should be either the name of a FIFO (named pipe) or ``-'' to
377 read data from the standard input. On Windows systems, pipe names must be
378 of the form ``\\pipe\.\B<pipename>''. Data read from pipes must be in
379 standard pcap format.
381 This option can occur multiple times. When capturing from multiple
382 interfaces, the capture file will be saved in pcap-ng format.
386 Put the interface in "monitor mode"; this is supported only on IEEE
387 802.11 Wi-Fi interfaces, and supported only on some operating systems.
389 Note that in monitor mode the adapter might disassociate from the
390 network with which it's associated, so that you will not be able to use
391 any wireless networks with that adapter. This could prevent accessing
392 files on a network server, or resolving host names or network addresses,
393 if you are capturing in monitor mode and are not connected to another
394 network with another adapter.
396 This option can occur multiple times. If used before the first
397 occurrence of the B<-i> option, it enables the monitor mode for all interfaces.
398 If used after an B<-i> option, it enables the monitor mode for
399 the interface specified by the last B<-i> option occurring before
404 Use after B<-J> to change the behavior when no exact match is found for
405 the filter. With this option select the first packet before.
407 =item -J E<lt>jump filterE<gt>
409 After reading in a capture file using the B<-r> flag, jump to the packet
410 matching the filter (display filter syntax). If no exact match is found
411 the first packet after that is selected.
415 Start the capture session immediately. If the B<-i> flag was
416 specified, the capture uses the specified interface. Otherwise,
417 B<Wireshark> searches the list of interfaces, choosing the first
418 non-loopback interface if there are any non-loopback interfaces, and
419 choosing the first loopback interface if there are no non-loopback
420 interfaces; if there are no interfaces, B<Wireshark> reports an error and
421 doesn't start the capture.
423 =item -K E<lt>keytabE<gt>
425 Load kerberos crypto keys from the specified keytab file.
426 This option can be used multiple times to load keys from several files.
428 Example: B<-K krb5.keytab>
432 Turn on automatic scrolling if the packet display is being updated
433 automatically as packets arrive during a capture (as specified by the
438 List the data link types supported by the interface and exit.
440 =item -m E<lt>fontE<gt>
442 Set the name of the font used by B<Wireshark> for most text. B<Wireshark>
443 will construct the name of the bold font used for the data in the byte
444 view pane that corresponds to the field selected in the packet details
445 pane from the name of the main text font.
449 Disable network object name resolution (such as hostname, TCP and UDP port
450 names), the B<-N> flag might override this one.
452 =item -N E<lt>name resolving flagsE<gt>
454 Turn on name resolving only for particular types of addresses and port
455 numbers, with name resolving for other types of addresses and port
456 numbers turned off. This flag overrides B<-n> if both B<-N> and B<-n> are
457 present. If both B<-N> and B<-n> flags are not present, all name resolutions
460 The argument is a string that may contain the letters:
462 B<m> to enable MAC address resolution
464 B<n> to enable network address resolution
466 B<N> to enable using external resolvers (e.g., DNS) for network address
469 B<t> to enable transport-layer port number resolution
471 B<C> to enable concurrent (asynchronous) DNS lookups
473 =item -o E<lt>preference/recent settingE<gt>
475 Set a preference or recent value, overriding the default value and any value
476 read from a preference/recent file. The argument to the flag is a string of
477 the form I<prefname>B<:>I<value>, where I<prefname> is the name of the
478 preference/recent value (which is the same name that would appear in the
479 preference/recent file), and I<value> is the value to which it should be set.
480 Since B<Ethereal> 0.10.12, the recent settings replaces the formerly used
481 -B, -P and -T flags to manipulate the GUI dimensions.
483 If I<prefname> is "uat", you can override settings in various user access
484 tables using the form uatB<:>I<uat filename>:I<uat record>. I<uat filename>
485 must be the name of a UAT file, e.g. I<user_dlts>. I<uat_record> must be in
486 the form of a valid record for that file, including quotes. For instance, to
487 specify a user DLT from the command line, you would use
489 -o "uat:user_dlts:\"User 0 (DLT=147)\",\"cops\",\"0\",\"\",\"0\",\"\""
493 I<Don't> put the interface into promiscuous mode. Note that the
494 interface might be in promiscuous mode for some other reason; hence,
495 B<-p> cannot be used to ensure that the only traffic that is captured is
496 traffic sent to or from the machine on which B<Wireshark> is running,
497 broadcast traffic, and multicast traffic to addresses received by that
500 This option can occur multiple times. If used before the first
501 occurrence of the B<-i> option, no interface will be put into the
503 If used after an B<-i> option, the interface specified by the last B<-i>
504 option occurring before this option will not be put into the
507 =item -P E<lt>path settingE<gt>
509 Special path settings usually detected automatically. This is used for
510 special cases, e.g. starting Wireshark from a known location on an USB stick.
512 The criterion is of the form I<key>B<:>I<path>, where I<key> is one of:
514 B<persconf>:I<path> path of personal configuration files, like the
517 B<persdata>:I<path> path of personal data files, it's the folder initially
518 opened. After the very first initialization, the recent file will keep the
521 =item -r E<lt>infileE<gt>
523 Read packet data from I<infile>, can be any supported capture file format
524 (including gzipped files). It's not possible to use named pipes or stdin
525 here! To capture from a pipe or from stdin use B<-i ->
527 =item -R E<lt>read (display) filterE<gt>
529 When reading a capture file specified with the B<-r> flag, causes the
530 specified filter (which uses the syntax of display filters, rather than
531 that of capture filters) to be applied to all packets read from the
532 capture file; packets not matching the filter are discarded.
534 =item -s E<lt>capture snaplenE<gt>
536 Set the default snapshot length to use when capturing live data.
537 No more than I<snaplen> bytes of each network packet will be read into
538 memory, or saved to disk. A value of 0 specifies a snapshot length of
539 65535, so that the full packet is captured; this is the default.
541 This option can occur multiple times. If used before the first
542 occurrence of the B<-i> option, it sets the default snapshot length.
543 If used after an B<-i> option, it sets the snapshot length for
544 the interface specified by the last B<-i> option occurring before
545 this option. If the snapshot length is not set specifically,
546 the default snapshot length is used if provided.
550 Automatically update the packet display as packets are coming in.
552 =item -t a|ad|adoy|d|dd|e|r|u|ud|udoy
554 Set the format of the packet timestamp displayed in the packet list
555 window. The format can be one of:
557 B<a> absolute: The absolute time, as local time in your time zone,
558 is the actual time the packet was captured, with no date displayed
560 B<ad> absolute with date: The absolute date, displayed as YYYY-MM-DD,
561 and time, as local time in your time zone, is the actual time and date
562 the packet was captured
564 B<adoy> absolute with date using day of year: The absolute date,
565 displayed as YYYY/DOY, and time, as local time in your time zone,
566 is the actual time and date the packet was captured
568 B<d> delta: The delta time is the time since the previous packet was
571 B<dd> delta_displayed: The delta_displayed time is the time since the
572 previous displayed packet was captured
574 B<e> epoch: The time in seconds since epoch (Jan 1, 1970 00:00:00)
576 B<r> relative: The relative time is the time elapsed between the first packet
577 and the current packet
579 B<u> UTC: The absolute time, as UTC, is the actual time the packet was
580 captured, with no date displayed
582 B<ud> UTC with date: The absolute date, displayed as YYYY-MM-DD,
583 and time, as UTC, is the actual time and date the packet was captured
585 B<udoy> UTC with date using day of year: The absolute date, displayed
586 as YYYY/DOY, and time, as UTC, is the actual time and date the packet
589 The default format is relative.
593 Print the version and exit.
595 =item -w E<lt>outfileE<gt>
597 Set the default capture file name.
599 =item -X E<lt>eXtension optionsE<gt>
601 Specify an option to be passed to an B<Wireshark> module. The eXtension option
602 is in the form I<extension_key>B<:>I<value>, where I<extension_key> can be:
604 B<lua_script>:I<lua_script_filename> tells B<Wireshark> to load the given script in addition to the
607 B<lua_script>I<num>:I<argument> tells B<Wireshark> to pass the given argument
608 to the lua script identified by 'num', which is the number indexed order of the 'lua_script' command.
609 For example, if only one script was loaded with '-X lua_script:my.lua', then '-X lua_script1:foo'
610 will pass the string 'foo' to the 'my.lua' script. If two scripts were loaded, such as '-X lua_script:my.lua'
611 and '-X lua_script:other.lua' in that order, then a '-X lua_script2:bar' would pass the string 'bar' to the second lua
612 script, namely 'other.lua'.
614 B<read_format>:I<file_format> tells B<Wireshark> to use the given file format to read in the
615 file (the file given in the B<-r> command option).
617 B<stdin_descr>:I<description> tells B<Wireshark> to use the given description when
618 capturing from standard input (B<-i ->).
620 =item -y E<lt>capture link typeE<gt>
622 If a capture is started from the command line with B<-k>, set the data
623 link type to use while capturing packets. The values reported by B<-L>
624 are the values that can be used.
626 This option can occur multiple times. If used before the first
627 occurrence of the B<-i> option, it sets the default capture link type.
628 If used after an B<-i> option, it sets the capture link type for
629 the interface specified by the last B<-i> option occurring before
630 this option. If the capture link type is not set specifically,
631 the default capture link type is used if provided.
633 =item -Y E<lt>displaY filterE<gt>
635 Start with the given display filter.
637 =item -z E<lt>statisticsE<gt>
639 Get B<Wireshark> to collect various types of statistics and display the result
640 in a window that updates in semi-real time.
642 Currently implemented statistics are:
646 =item B<-z> conv,I<type>[,I<filter>]
648 Create a table that lists all conversations that could be seen in the
649 capture. I<type> specifies the conversation endpoint types for which we
650 want to generate the statistics; currently the supported ones are:
652 "eth" Ethernet addresses
653 "fc" Fibre Channel addresses
654 "fddi" FDDI addresses
656 "ipv6" IPv6 addresses
658 "tcp" TCP/IP socket pairs Both IPv4 and IPv6 are supported
659 "tr" Token Ring addresses
660 "udp" UDP/IP socket pairs Both IPv4 and IPv6 are supported
662 If the optional I<filter> is specified, only those packets that match the
663 filter will be used in the calculations.
665 The table is presented with one line for each conversation and displays
666 the number of packets/bytes in each direction as well as the total
667 number of packets/bytes. By default, the table is sorted according to
668 the total number of packets.
670 These tables can also be generated at runtime by selecting the appropriate
671 conversation type from the menu "Tools/Statistics/Conversation List/".
673 =item B<-z> dcerpc,srt,I<uuid>,I<major>.I<minor>[,I<filter>]
675 Collect call/reply SRT (Service Response Time) data for DCERPC interface I<uuid>,
676 version I<major>.I<minor>.
677 Data collected is the number of calls for each procedure, MinSRT, MaxSRT
680 Example: S<B<-z dcerpc,srt,12345778-1234-abcd-ef00-0123456789ac,1.0>> will collect data for the CIFS SAMR Interface.
682 This option can be used multiple times on the command line.
684 If the optional I<filter> is provided, the stats will only be calculated
685 on those calls that match that filter.
687 Example: S<B<-z dcerpc,srt,12345778-1234-abcd-ef00-0123456789ac,1.0,ip.addr==1.2.3.4>> will collect SAMR
688 SRT statistics for a specific host.
690 =item B<-z> fc,srt[,I<filter>]
692 Collect call/reply SRT (Service Response Time) data for FC. Data collected
693 is the number of calls for each Fibre Channel command, MinSRT, MaxSRT and AvgSRT.
695 Example: B<-z fc,srt>
696 will calculate the Service Response Time as the time delta between the
697 First packet of the exchange and the Last packet of the exchange.
699 The data will be presented as separate tables for all normal FC commands,
700 Only those commands that are seen in the capture will have its stats
703 This option can be used multiple times on the command line.
705 If the optional I<filter> is provided, the stats will only be calculated
706 on those calls that match that filter.
708 Example: B<-z "fc,srt,fc.id==01.02.03"> will collect stats only for
709 FC packets exchanged by the host at FC address 01.02.03 .
711 =item B<-z> h225,counter[I<,filter>]
713 Count ITU-T H.225 messages and their reasons. In the first column you get a
714 list of H.225 messages and H.225 message reasons which occur in the current
715 capture file. The number of occurrences of each message or reason is displayed
716 in the second column.
718 Example: B<-z h225,counter>
720 This option can be used multiple times on the command line.
722 If the optional I<filter> is provided, the stats will only be calculated
723 on those calls that match that filter.
725 Example: B<-z "h225,counter,ip.addr==1.2.3.4"> will collect stats only for
726 H.225 packets exchanged by the host at IP address 1.2.3.4 .
728 =item B<-z> h225,srt[I<,filter>]
730 Collect request/response SRT (Service Response Time) data for ITU-T H.225 RAS.
731 Data collected is the number of calls of each ITU-T H.225 RAS Message Type,
732 Minimum SRT, Maximum SRT, Average SRT, Minimum in Packet, and Maximum in Packet.
733 You will also get the number of Open Requests (Unresponded Requests),
734 Discarded Responses (Responses without matching request) and Duplicate Messages.
736 Example: B<-z h225,srt>
738 This option can be used multiple times on the command line.
740 If the optional I<filter> is provided, the stats will only be calculated
741 on those calls that match that filter.
743 Example: B<-z "h225,srt,ip.addr==1.2.3.4"> will collect stats only for
744 ITU-T H.225 RAS packets exchanged by the host at IP address 1.2.3.4 .
748 Collect packet/bytes statistics for the capture in intervals of 1 second.
749 This option will open a window with up to 5 color-coded graphs where
750 number-of-packets-per-second or number-of-bytes-per-second statistics
751 can be calculated and displayed.
753 This option can be used multiple times on the command line.
755 This graph window can also be opened from the Analyze:Statistics:Traffic:IO-Stat
758 =item B<-z> ldap,srt[,I<filter>]
760 Collect call/reply SRT (Service Response Time) data for LDAP. Data collected
761 is the number of calls for each implemented LDAP command, MinSRT, MaxSRT and AvgSRT.
763 Example: B<-z ldap,srt>
764 will calculate the Service Response Time as the time delta between the
765 Request and the Response.
767 The data will be presented as separate tables for all implemented LDAP commands,
768 Only those commands that are seen in the capture will have its stats
771 This option can be used multiple times on the command line.
773 If the optional I<filter> is provided, the stats will only be calculated
774 on those calls that match that filter.
776 Example: use B<-z "ldap,srt,ip.addr==10.1.1.1"> will collect stats only for
777 LDAP packets exchanged by the host at IP address 10.1.1.1 .
779 The only LDAP commands that are currently implemented and for which the stats will be available are:
789 =item B<-z> megaco,srt[I<,filter>]
791 Collect request/response SRT (Service Response Time) data for MEGACO.
792 (This is similar to B<-z smb,srt>). Data collected is the number of calls
793 for each known MEGACO Command, Minimum SRT, Maximum SRT and Average SRT.
795 Example: B<-z megaco,srt>
797 This option can be used multiple times on the command line.
799 If the optional I<filter> is provided, the stats will only be calculated
800 on those calls that match that filter.
802 Example: B<-z "megaco,srt,ip.addr==1.2.3.4"> will collect stats only for
803 MEGACO packets exchanged by the host at IP address 1.2.3.4 .
805 =item B<-z> mgcp,srt[I<,filter>]
807 Collect request/response SRT (Service Response Time) data for MGCP.
808 (This is similar to B<-z smb,srt>). Data collected is the number of calls
809 for each known MGCP Type, Minimum SRT, Maximum SRT and Average SRT.
811 Example: B<-z mgcp,srt>
813 This option can be used multiple times on the command line.
815 If the optional I<filter> is provided, the stats will only be calculated
816 on those calls that match that filter.
818 Example: B<-z "mgcp,srt,ip.addr==1.2.3.4"> will collect stats only for
819 MGCP packets exchanged by the host at IP address 1.2.3.4 .
821 =item B<-z> rpc,programs
823 Collect call/reply SRT data for all known ONC-RPC programs/versions.
824 Data collected is the number of calls for each protocol/version, MinSRT,
827 =item B<-z> rpc,srt,I<program>,I<version>[,<filter>]
829 Collect call/reply SRT (Service Response Time) data for I<program>/I<version>. Data collected
830 is the number of calls for each procedure, MinSRT, MaxSRT and AvgSRT.
832 Example: B<-z rpc,srt,100003,3> will collect data for NFS v3.
834 This option can be used multiple times on the command line.
836 If the optional I<filter> is provided, the stats will only be calculated
837 on those calls that match that filter.
839 Example: S<B<-z rpc,srt,100003,3,nfs.fh.hash==0x12345678>> will collect NFS v3
840 SRT statistics for a specific file.
842 =item B<-z> scsi,srt,I<cmdset>[,<filter>]
844 Collect call/reply SRT (Service Response Time) data for SCSI commandset <cmdset>.
846 Commandsets are 0:SBC 1:SSC 5:MMC
849 is the number of calls for each procedure, MinSRT, MaxSRT and AvgSRT.
851 Example: B<-z scsi,srt,0> will collect data for SCSI BLOCK COMMANDS (SBC).
853 This option can be used multiple times on the command line.
855 If the optional I<filter> is provided, the stats will only be calculated
856 on those calls that match that filter.
858 Example: B<-z scsi,srt,0,ip.addr==1.2.3.4> will collect SCSI SBC
859 SRT statistics for a specific iscsi/ifcp/fcip host.
861 =item B<-z> sip,stat[I<,filter>]
863 This option will activate a counter for SIP messages. You will get the number
864 of occurrences of each SIP Method and of each SIP Status-Code. Additionally you
865 also get the number of resent SIP Messages (only for SIP over UDP).
867 Example: B<-z sip,stat>
869 This option can be used multiple times on the command line.
871 If the optional I<filter> is provided, the stats will only be calculated
872 on those calls that match that filter.
874 Example: B<-z "sip,stat,ip.addr==1.2.3.4"> will collect stats only for
875 SIP packets exchanged by the host at IP address 1.2.3.4 .
877 =item B<-z> smb,srt[,I<filter>]
879 Collect call/reply SRT (Service Response Time) data for SMB. Data collected
880 is the number of calls for each SMB command, MinSRT, MaxSRT and AvgSRT.
882 Example: B<-z smb,srt>
884 The data will be presented as separate tables for all normal SMB commands,
885 all Transaction2 commands and all NT Transaction commands.
886 Only those commands that are seen in the capture will have their stats
888 Only the first command in a xAndX command chain will be used in the
889 calculation. So for common SessionSetupAndX + TreeConnectAndX chains,
890 only the SessionSetupAndX call will be used in the statistics.
891 This is a flaw that might be fixed in the future.
893 This option can be used multiple times on the command line.
895 If the optional I<filter> is provided, the stats will only be calculated
896 on those calls that match that filter.
898 Example: B<-z "smb,srt,ip.addr==1.2.3.4"> will collect stats only for
899 SMB packets exchanged by the host at IP address 1.2.3.4 .
901 =item B<-z> voip,calls
903 This option will show a window that shows VoIP calls found in the capture file.
904 This is the same window shown as when you go to the Statistics Menu and choose
907 Example: B<-z voip,calls>
921 =item File:Open Recent
925 Merge another capture file to the currently loaded one. The I<File:Merge>
926 dialog box allows the merge "Prepended", "Chronologically" or "Appended",
927 relative to the already loaded one.
931 Open or close a capture file. The I<File:Open> dialog box
932 allows a filter to be specified; when the capture file is read, the
933 filter is applied to all packets read from the file, and packets not
934 matching the filter are discarded. The I<File:Open Recent> is a submenu
935 and will show a list of previously opened files.
941 Save the current capture, or the packets currently displayed from that
942 capture, to a file. Check boxes let you select whether to save all
943 packets, or just those that have passed the current display filter and/or
944 those that are currently marked, and an option menu lets you select (from
945 a list of file formats in which at particular capture, or the packets
946 currently displayed from that capture, can be saved), a file format in
949 =item File:File Set:List Files
951 Show a dialog box that lists all files of the file set matching the currently
952 loaded file. A file set is a compound of files resulting from a capture using
953 the "multiple files" / "ringbuffer" mode, recognizable by the filename pattern,
954 e.g.: Filename_00001_20050604101530.pcap.
956 =item File:File Set:Next File
958 =item File:File Set:Previous File
960 If the currently loaded file is part of a file set (see above), open the
961 next / previous file in that set.
965 Export captured data into an external format. Note: the data cannot be
966 imported back into Wireshark, so be sure to keep the capture file.
970 Print packet data from the current capture. You can select the range of
971 packets to be printed (which packets are printed), and the output format of
972 each packet (how each packet is printed). The output format will be similar
973 to the displayed values, so a summary line, the packet details view, and/or
974 the hex dump of the packet can be printed.
976 Printing options can be set with the I<Edit:Preferences> menu item, or in the
977 dialog box popped up by this menu item.
981 Exit the application.
983 =item Edit:Copy:Description
985 Copies the description of the selected field in the protocol tree to
988 =item Edit:Copy:Fieldname
990 Copies the fieldname of the selected field in the protocol tree to
993 =item Edit:Copy:Value
995 Copies the value of the selected field in the protocol tree to
998 =item Edit:Copy:As Filter
1000 Create a display filter based on the data currently highlighted in the
1001 packet details and copy that filter to the clipboard.
1003 If that data is a field that can be tested in a display filter
1004 expression, the display filter will test that field; otherwise, the
1005 display filter will be based on the absolute offset within the packet.
1006 Therefore it could be unreliable if the packet contains protocols with
1007 variable-length headers, such as a source-routed token-ring packet.
1009 =item Edit:Find Packet
1011 Search forward or backward, starting with the currently selected packet
1012 (or the most recently selected packet, if no packet is selected). Search
1013 criteria can be a display filter expression, a string of hexadecimal
1014 digits, or a text string.
1016 When searching for a text string, you can search the packet data, or you
1017 can search the text in the Info column in the packet list pane or in the
1018 packet details pane.
1020 Hexadecimal digits can be separated by colons, periods, or dashes.
1021 Text string searches can be ASCII or Unicode (or both), and may be
1024 =item Edit:Find Next
1026 =item Edit:Find Previous
1028 Search forward / backward for a packet matching the filter from the previous
1029 search, starting with the currently selected packet (or the most recently
1030 selected packet, if no packet is selected).
1032 =item Edit:Mark Packet (toggle)
1034 Mark (or unmark if currently marked) the selected packet. The field
1035 "frame.marked" is set for packets that are marked, so that, for example,
1036 a display filters can be used to display only marked packets, and so that
1037 the L</"Edit:Find Packet"> dialog can be used to find the next or previous
1040 =item Edit:Find Next Mark
1042 =item Edit:Find Previous Mark
1044 Find next/previous marked packet.
1046 =item Edit:Mark All Packets
1048 =item Edit:Unmark All Packets
1050 Mark / Unmark all packets that are currently displayed.
1052 =item Edit:Time Reference:Set Time Reference (toggle)
1054 Set (or unset if currently set) the selected packet as a Time Reference packet.
1055 When a packet is set as a Time Reference packet, the timestamps in the packet
1056 list pane will be replaced with the string "*REF*".
1057 The relative time timestamp in later packets will then be calculated relative
1058 to the timestamp of this Time Reference packet and not the first packet in
1061 Packets that have been selected as Time Reference packets will always be
1062 displayed in the packet list pane. Display filters will not affect or
1065 If there is a column displayed for "Cumulative Bytes" this counter will
1066 be reset at every Time Reference packet.
1068 =item Edit:Time Reference:Find Next
1070 =item Edit:Time Reference:Find Previous
1072 Search forward / backward for a time referenced packet.
1074 =item Edit:Configuration Profiles
1076 Manage configuration profiles to be able to use more than one set of
1077 preferences and configurations.
1079 =item Edit:Preferences
1081 Set the GUI, capture, printing and protocol options
1082 (see L</Preferences> dialog below).
1084 =item View:Main Toolbar
1086 =item View:Filter Toolbar
1088 =item View:Statusbar
1090 Show or hide the main window controls.
1092 =item View:Packet List
1094 =item View:Packet Details
1096 =item View:Packet Bytes
1098 Show or hide the main window panes.
1100 =item View:Time Display Format
1102 Set the format of the packet timestamp displayed in the packet list window.
1104 =item View:Name Resolution:Resolve Name
1106 Try to resolve a name for the currently selected item.
1108 =item View:Name Resolution:Enable for ... Layer
1110 Enable or disable translation of addresses to names in the display.
1112 =item View:Colorize Packet List
1114 Enable or disable the coloring rules. Disabling will improve performance.
1116 =item View:Auto Scroll in Live Capture
1118 Enable or disable the automatic scrolling of the
1119 packet list while a live capture is in progress.
1125 Zoom into / out of the main window data (by changing the font size).
1127 =item View:Normal Size
1129 Reset the zoom factor of zoom in / zoom out back to normal font size.
1131 =item View:Resize All Columns
1133 Resize all columns to best fit the current packet display.
1135 =item View:Expand / Collapse Subtrees
1137 Expands / Collapses the currently selected item and it's subtrees in the packet details.
1139 =item View:Expand All
1141 =item View:Collapse All
1143 Expand / Collapse all branches of the packet details.
1145 =item View:Colorize Conversation
1147 Select color for a conversation.
1149 =item View:Reset Coloring 1-10
1151 Reset Color for a conversation.
1153 =item View:Coloring Rules
1155 Change the foreground and background colors of the packet information in
1156 the list of packets, based upon display filters. The list of display
1157 filters is applied to each packet sequentially. After the first display
1158 filter matches a packet, any additional display filters in the list are
1159 ignored. Therefore, if you are filtering on the existence of protocols,
1160 you should list the higher-level protocols first, and the lower-level
1165 =item How Colorization Works
1167 Packets are colored according to a list of color filters. Each filter
1168 consists of a name, a filter expression and a coloration. A packet is
1169 colored according to the first filter that it matches. Color filter
1170 expressions use exactly the same syntax as display filter expressions.
1172 When Wireshark starts, the color filters are loaded from:
1178 The user's personal color filters file or, if that does not exist,
1182 The global color filters file.
1186 If neither of these exist then the packets will not be colored.
1190 =item View:Show Packet In New Window
1192 Create a new window containing a packet details view and a hex dump
1193 window of the currently selected packet; this window will continue to
1194 display that packet's details and data even if another packet is
1199 Reload a capture file. Same as I<File:Close> and I<File:Open> the same
1204 Go back in previously visited packets history.
1208 Go forward in previously visited packets history.
1210 =item Go:Go To Packet
1212 Go to a particular numbered packet.
1214 =item Go:Go To Corresponding Packet
1216 If a field in the packet details pane containing a packet number is
1217 selected, go to the packet number specified by that field. (This works
1218 only if the dissector that put that entry into the packet details put it
1219 into the details as a filterable field rather than just as text.) This
1220 can be used, for example, to go to the packet for the request
1221 corresponding to a reply, or the reply corresponding to a request, if
1222 that packet number has been put into the packet details.
1224 =item Go:Previous Packet
1226 =item Go:Next Packet
1228 =item Go:First Packet
1230 =item Go:Last Packet
1232 Go to the previous / next / first / last packet in the capture.
1234 =item Go:Previous Packet In Conversation
1236 =item Go:Next Packet In Conversation
1238 Go to the previous / next packet of the conversation (TCP, UDP or IP)
1240 =item Capture:Interfaces
1242 Shows a dialog box with all currently known interfaces and displaying the
1243 current network traffic amount. Capture sessions can be started from here.
1244 Beware: keeping this box open results in high system load!
1246 =item Capture:Options
1248 Initiate a live packet capture (see L</"Capture Options Dialog">
1249 below). If no filename is specified, a temporary file will be created
1250 to hold the capture. The location of the file can be chosen by setting your
1251 TMPDIR environment variable before starting B<Wireshark>. Otherwise, the
1252 default TMPDIR location is system-dependent, but is likely either F</var/tmp>
1257 Start a live packet capture with the previously selected options. This won't
1258 open the options dialog box, and can be convenient for repeatedly capturing
1259 with the same options.
1263 Stop a running live capture.
1265 =item Capture:Restart
1267 While a live capture is running, stop it and restart with the same options
1268 again. This can be convenient to remove irrelevant packets, if no valuable
1269 packets were captured so far.
1271 =item Capture:Capture Filters
1273 Edit the saved list of capture filters, allowing filters to be added,
1274 changed, or deleted.
1276 =item Analyze:Display Filters
1278 Edit the saved list of display filters, allowing filters to be added,
1279 changed, or deleted.
1281 =item Analyze:Display Filter Macros
1283 Create shortcuts for complex macros
1285 =item Analyze:Apply as Filter
1287 Create a display filter based on the data currently highlighted in the
1288 packet details and apply the filter.
1290 If that data is a field that can be tested in a display filter
1291 expression, the display filter will test that field; otherwise, the
1292 display filter will be based on the absolute offset within the packet.
1293 Therefore it could be unreliable if the packet contains protocols with
1294 variable-length headers, such as a source-routed token-ring packet.
1296 The B<Selected> option creates a display filter that tests for a match
1297 of the data; the B<Not Selected> option creates a display filter that
1298 tests for a non-match of the data. The B<And Selected>, B<Or Selected>,
1299 B<And Not Selected>, and B<Or Not Selected> options add to the end of
1300 the display filter in the strip at the top (or bottom) an AND or OR
1301 operator followed by the new display filter expression.
1303 =item Analyze:Prepare a Filter
1305 Create a display filter based on the data currently highlighted in the
1306 packet details. The filter strip at the top (or bottom) is updated but
1307 it is not yet applied.
1309 =item Analyze:Enabled Protocols
1311 Allow protocol dissection to be enabled or disabled for a specific
1312 protocol. Individual protocols can be enabled or disabled by clicking
1313 on them in the list or by highlighting them and pressing the space bar.
1314 The entire list can be enabled, disabled, or inverted using the buttons
1317 When a protocol is disabled, dissection in a particular packet stops
1318 when that protocol is reached, and Wireshark moves on to the next packet.
1319 Any higher-layer protocols that would otherwise have been processed will
1320 not be displayed. For example, disabling TCP will prevent the dissection
1321 and display of TCP, HTTP, SMTP, Telnet, and any other protocol exclusively
1324 The list of protocols can be saved, so that Wireshark will start up with
1325 the protocols in that list disabled.
1327 =item Analyze:Decode As
1329 If you have a packet selected, present a dialog allowing you to change
1330 which dissectors are used to decode this packet. The dialog has one
1331 panel each for the link layer, network layer and transport layer
1332 protocol/port numbers, and will allow each of these to be changed
1333 independently. For example, if the selected packet is a TCP packet to
1334 port 12345, using this dialog you can instruct Wireshark to decode all
1335 packets to or from that TCP port as HTTP packets.
1337 =item Analyze:User Specified Decodes
1339 Create a new window showing whether any protocol ID to dissector
1340 mappings have been changed by the user. This window also allows the
1341 user to reset all decodes to their default values.
1343 =item Analyze:Follow TCP Stream
1345 If you have a TCP packet selected, display the contents of the data
1346 stream for the TCP connection to which that packet belongs, as text, in
1347 a separate window, and leave the list of packets in a filtered state,
1348 with only those packets that are part of that TCP connection being
1349 displayed. You can revert to your old view by pressing ENTER in the
1350 display filter text box, thereby invoking your old display filter (or
1351 resetting it back to no display filter).
1353 The window in which the data stream is displayed lets you select:
1359 whether to display the entire conversation, or one or the other side of
1364 whether the data being displayed is to be treated as ASCII or EBCDIC
1365 text or as raw hex data;
1369 and lets you print what's currently being displayed, using the same
1370 print options that are used for the I<File:Print Packet> menu item, or
1371 save it as text to a file.
1373 =item Analyze:Follow UDP Stream
1375 =item Analyze:Follow SSL Stream
1377 (Similar to Analyze:Follow TCP Stream)
1379 =item Analyze:Expert Info
1381 =item Analyze:Expert Info Composite
1383 (Kind of) a log of anomalies found by Wireshark in a capture file.
1385 =item Analyze:Conversation Filter
1387 =item Statistics:Summary
1389 Show summary information about the capture, including elapsed time,
1390 packet counts, byte counts, and the like. If a display filter is in
1391 effect, summary information will be shown about the capture and about
1392 the packets currently being displayed.
1394 =item Statistics:Protocol Hierarchy
1396 Show the number of packets, and the number of bytes in those packets,
1397 for each protocol in the trace. It organizes the protocols in the same
1398 hierarchy in which they were found in the trace. Besides counting the
1399 packets in which the protocol exists, a count is also made for packets
1400 in which the protocol is the last protocol in the stack. These
1401 last-protocol counts show you how many packets (and the byte count
1402 associated with those packets) B<ended> in a particular protocol. In
1403 the table, they are listed under "End Packets" and "End Bytes".
1405 =item Statistics:Conversations
1407 Lists of conversations; selectable by protocol. See Statistics:Conversation List below.
1409 =item Statistics:End Points
1411 List of End Point Addresses by protocol with packets/bytes/.... counts.
1413 =item Statistics:Packet Lengths
1415 Grouped counts of packet lengths (0-19 bytes, 20-39 bytes, ...)
1417 =item Statistics:IO Graphs
1419 Open a window where up to 5 graphs in different colors can be displayed
1420 to indicate number of packets or number of bytes per second for all packets
1421 matching the specified filter.
1422 By default only one graph will be displayed showing number of packets per second.
1424 The top part of the window contains the graphs and scales for the X and
1425 Y axis. If the graph is too long to fit inside the window there is a
1426 horizontal scrollbar below the drawing area that can scroll the graphs
1427 to the left or the right. The horizontal axis displays the time into
1428 the capture and the vertical axis will display the measured quantity at
1431 Below the drawing area and the scrollbar are the controls. On the
1432 bottom left there will be five similar sets of controls to control each
1433 individual graph such as "Display:<button>" which button will toggle
1434 that individual graph on/off. If <button> is ticked, the graph will be
1435 displayed. "Color:<color>" which is just a button to show which color
1436 will be used to draw that graph (color is only available in Gtk2
1437 version) and finally "Filter:<filter-text>" which can be used to specify
1438 a display filter for that particular graph.
1440 If filter-text is empty then all packets will be used to calculate the
1441 quantity for that graph. If filter-text is specified only those packets
1442 that match that display filter will be considered in the calculation of
1445 To the right of the 5 graph controls there are four menus to control
1446 global aspects of the draw area and graphs. The "Unit:" menu is used to
1447 control what to measure; "packets/tick", "bytes/tick" or "advanced..."
1449 packets/tick will measure the number of packets matching the (if
1450 specified) display filter for the graph in each measurement interval.
1452 bytes/tick will measure the total number of bytes in all packets matching
1453 the (if specified) display filter for the graph in each measurement
1456 advanced... see below
1458 "Tick interval:" specifies what measurement intervals to use. The
1459 default is 1 second and means that the data will be counted over 1
1462 "Pixels per tick:" specifies how many pixels wide each measurement
1463 interval will be in the drawing area. The default is 5 pixels per tick.
1465 "Y-scale:" controls the max value for the y-axis. Default value is
1466 "auto" which means that B<Wireshark> will try to adjust the maxvalue
1469 "advanced..." If Unit:advanced... is selected the window will display
1470 two more controls for each of the five graphs. One control will be a
1471 menu where the type of calculation can be selected from
1472 SUM,COUNT,MAX,MIN,AVG and LOAD, and one control, textbox, where the name of a
1473 single display filter field can be specified.
1475 The following restrictions apply to type and field combinations:
1477 SUM: available for all types of integers and will calculate the SUM of
1478 all occurrences of this field in the measurement interval. Note that
1479 some field can occur multiple times in the same packet and then all
1480 instances will be summed up. Example: 'tcp.len' which will count the
1481 amount of payload data transferred across TCP in each interval.
1483 COUNT: available for all field types. This will COUNT the number of times
1484 certain field occurs in each interval. Note that some fields
1485 may occur multiple times in each packet and if that is the case
1486 then each instance will be counted independently and COUNT
1487 will be greater than the number of packets.
1489 MAX: available for all integer and relative time fields. This will calculate
1490 the max seen integer/time value seen for the field during the interval.
1491 Example: 'smb.time' which will plot the maximum SMB response time.
1493 MIN: available for all integer and relative time fields. This will calculate
1494 the min seen integer/time value seen for the field during the interval.
1495 Example: 'smb.time' which will plot the minimum SMB response time.
1497 AVG: available for all integer and relative time fields.This will
1498 calculate the average seen integer/time value seen for the field during
1499 the interval. Example: 'smb.time' which will plot the average SMB
1502 LOAD: available only for relative time fields (response times).
1504 Example of advanced:
1505 Display how NFS response time MAX/MIN/AVG changes over time:
1509 filter:nfs&&rpc.time
1514 filter:nfs&&rpc.time
1519 filter:nfs&&rpc.time
1522 Example of advanced:
1523 Display how the average packet size from host a.b.c.d changes over time.
1527 filter:ip.addr==a.b.c.d&&frame.pkt_len
1528 Calc:AVG frame.pkt_len
1531 The LOAD io-stat type is very different from anything you have ever seen
1532 before! While the response times themselves as plotted by MIN,MAX,AVG are
1533 indications on the Server load (which affects the Server response time),
1534 the LOAD measurement measures the Client LOAD.
1535 What this measures is how much workload the client generates,
1536 i.e. how fast will the client issue new commands when the previous ones
1538 i.e. the level of concurrency the client can maintain.
1539 The higher the number, the more and faster is the client issuing new
1540 commands. When the LOAD goes down, it may be due to client load making
1541 the client slower in issuing new commands (there may be other reasons as
1542 well, maybe the client just doesn't have any commands it wants to issue
1545 Load is measured in concurrency/number of overlapping i/o and the value
1546 1000 means there is a constant load of one i/o.
1548 In each tick interval the amount of overlap is measured.
1549 See the graph below containing three commands:
1550 Below the graph are the LOAD values for each interval that would be calculated.
1554 | | o=====* | | | | | |
1556 | o========* | o============* | | |
1558 --------------------------------------------------> Time
1559 500 1500 500 750 1000 500 0 0
1561 =item Statistics:Conversation List
1563 This option will open a new window that displays a list of all
1564 conversations between two endpoints. The list has one row for each
1565 unique conversation and displays total number of packets/bytes seen as
1566 well as number of packets/bytes in each direction.
1568 By default the list is sorted according to the number of packets but by
1569 clicking on the column header; it is possible to re-sort the list in
1570 ascending or descending order by any column.
1572 By first selecting a conversation by clicking on it and then using the
1573 right mouse button (on those platforms that have a right
1574 mouse button) wireshark will display a popup menu offering several different
1575 filter operations to apply to the capture.
1577 These statistics windows can also be invoked from the Wireshark command
1578 line using the B<-z conv> argument.
1580 =item Statistics:Service Response Time
1596 Open a window to display Service Response Time statistics for an
1597 arbitrary DCE-RPC program
1598 interface and display B<Procedure>, B<Number of Calls>, B<Minimum SRT>,
1599 B<Maximum SRT> and B<Average SRT> for all procedures for that
1600 program/version. These windows opened will update in semi-real time to
1601 reflect changes when doing live captures or when reading new capture
1602 files into B<Wireshark>.
1604 This dialog will also allow an optional filter string to be used.
1605 If an optional filter string is used only such DCE-RPC request/response pairs
1606 that match that filter will be used to calculate the statistics. If no filter
1607 string is specified all request/response pairs will be used.
1617 Open a window to display Service Response Time statistics for Fibre Channel
1618 and display B<FC Type>, B<Number of Calls>, B<Minimum SRT>,
1619 B<Maximum SRT> and B<Average SRT> for all FC types.
1620 These windows opened will update in semi-real time to
1621 reflect changes when doing live captures or when reading new capture
1622 files into B<Wireshark>.
1623 The Service Response Time is calculated as the time delta between the
1624 First packet of the exchange and the Last packet of the exchange.
1626 This dialog will also allow an optional filter string to be used.
1627 If an optional filter string is used only such FC first/last exchange pairs
1628 that match that filter will be used to calculate the statistics. If no filter
1629 string is specified all request/response pairs will be used.
1639 Collect requests/response SRT (Service Response Time) data for ITU-T H.225 RAS.
1640 Data collected is B<number of calls> for each known ITU-T H.225 RAS Message Type,
1641 B<Minimum SRT>, B<Maximum SRT>, B<Average SRT>, B<Minimum in Packet>, and B<Maximum in Packet>.
1642 You will also get the number of B<Open Requests> (Unresponded Requests),
1643 B<Discarded Responses> (Responses without matching request) and Duplicate Messages.
1644 These windows opened will update in semi-real time to reflect changes when
1645 doing live captures or when reading new capture files into B<Wireshark>.
1647 You can apply an optional filter string in a dialog box, before starting
1648 the calculation. The statistics will only be calculated
1649 on those calls matching that filter.
1663 Collect requests/response SRT (Service Response Time) data for MGCP.
1664 Data collected is B<number of calls> for each known MGCP Type,
1665 B<Minimum SRT>, B<Maximum SRT>, B<Average SRT>, B<Minimum in Packet>, and B<Maximum in Packet>.
1666 These windows opened will update in semi-real time to reflect changes when
1667 doing live captures or when reading new capture files into B<Wireshark>.
1669 You can apply an optional filter string in a dialog box, before starting
1670 the calculation. The statistics will only be calculated
1671 on those calls matching that filter.
1681 Open a window to display statistics for an arbitrary ONC-RPC program interface
1682 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.
1683 These windows opened will update in semi-real time to reflect changes when
1684 doing live captures or when reading new capture files into B<Wireshark>.
1686 This dialog will also allow an optional filter string to be used.
1687 If an optional filter string is used only such ONC-RPC request/response pairs
1688 that match that filter will be used to calculate the statistics. If no filter
1689 string is specified all request/response pairs will be used.
1691 By first selecting a conversation by clicking on it and then using the
1692 right mouse button (on those platforms that have a right
1693 mouse button) wireshark will display a popup menu offering several different
1694 filter operations to apply to the capture.
1708 Collect call/reply SRT (Service Response Time) data for SMB. Data collected
1709 is the number of calls for each SMB command, MinSRT, MaxSRT and AvgSRT.
1711 The data will be presented as separate tables for all normal SMB commands,
1712 all Transaction2 commands and all NT Transaction commands.
1713 Only those commands that are seen in the capture will have its stats
1715 Only the first command in a xAndX command chain will be used in the
1716 calculation. So for common SessionSetupAndX + TreeConnectAndX chains,
1717 only the SessionSetupAndX call will be used in the statistics.
1718 This is a flaw that might be fixed in the future.
1720 You can apply an optional filter string in a dialog box, before starting
1721 the calculation. The stats will only be calculated
1722 on those calls matching that filter.
1724 By first selecting a conversation by clicking on it and then using the
1725 right mouse button (on those platforms that have a right
1726 mouse button) wireshark will display a popup menu offering several different
1727 filter operations to apply to the capture.
1735 =item Statistics:BOOTP-DHCP
1739 =item Statistics:Compare
1741 Compare two Capture Files
1743 =item Statistics:Flow Graph
1745 Flow Graph: General/TCP
1747 =item Statistics:HTTP
1749 HTTP Load Distribution, Packet Counter & Requests
1751 =item Statistics:IP Addresses
1753 Count/Rate/Percent by IP Address
1755 =item Statistics:IP Destinations
1757 Count/Rate/Percent by IP Address/protocol/port
1759 =item Statistics:IP Protocol Types
1761 Count/Rate/Percent by IP Protocol Types
1763 =item Statistics:ONC-RPC Programs
1765 This dialog will open a window showing aggregated SRT statistics for all
1766 ONC-RPC Programs/versions that exist in the capture file.
1768 =item Statistics:TCP Stream Graph
1770 Graphs: Round Trip; Throughput; Time-Sequence (Stevens); Time-Sequence (tcptrace)
1772 =item Statistics:UDP Multicast streams
1774 Multicast Streams Counts/Rates/... by Source/Destination Address/Port pairs
1776 =item Statistics:WLAN Traffic
1778 WLAN Traffic Statistics
1780 =item Telephony:ITU-T H.225
1782 Count ITU-T H.225 messages and their reasons. In the first column you get a
1783 list of H.225 messages and H.225 message reasons, which occur in the current
1784 capture file. The number of occurrences of each message or reason will be displayed
1785 in the second column.
1786 This window opened will update in semi-real time to reflect changes when
1787 doing live captures or when reading new capture files into B<Wireshark>.
1789 You can apply an optional filter string in a dialog box, before starting
1790 the counter. The statistics will only be calculated
1791 on those calls matching that filter.
1795 Activate a counter for SIP messages. You will get the number of occurrences of each
1796 SIP Method and of each SIP Status-Code. Additionally you also get the number of
1797 resent SIP Messages (only for SIP over UDP).
1799 This window opened will update in semi-real time to reflect changes when
1800 doing live captures or when reading new capture files into B<Wireshark>.
1802 You can apply an optional filter string in a dialog box, before starting
1803 the counter. The statistics will only be calculated
1804 on those calls matching that filter.
1806 =item Tools:Firewall ACL Rules
1814 =item Help:Supported Protocols
1816 List of supported protocols and display filter protocol fields.
1818 =item Help:Manual Pages
1820 Display locally installed HTML versions of these manual pages in a web browser.
1822 =item Help:Wireshark Online
1824 Various links to online resources to be open in a web browser, like
1825 L<http://www.wireshark.org>.
1827 =item Help:About Wireshark
1829 See various information about Wireshark (see L</About> dialog below), like the
1830 version, the folders used, the available plugins, ...
1840 The main window contains the usual things like the menu, some toolbars, the
1841 main area and a statusbar. The main area is split into three panes, you can
1842 resize each pane using a "thumb" at the right end of each divider line.
1844 The main window is much more flexible than before. The layout of the main
1845 window can be customized by the I<Layout> page in the dialog box popped
1846 up by I<Edit:Preferences>, the following will describe the layout with the
1853 Some menu items are available for quick access here. There is no way to
1854 customize the items in the toolbar, however the toolbar can be hidden by
1855 I<View:Main Toolbar>.
1857 =item Filter Toolbar
1859 A display filter can be entered into the filter toolbar.
1860 A filter for HTTP, HTTPS, and DNS traffic might look like this:
1862 tcp.port == 80 || tcp.port == 443 || tcp.port == 53
1864 Selecting the I<Filter:> button lets you choose from a list of named
1865 filters that you can optionally save. Pressing the Return or Enter
1866 keys, or selecting the I<Apply> button, will cause the filter to be
1867 applied to the current list of packets. Selecting the I<Reset> button
1868 clears the display filter so that all packets are displayed (again).
1870 There is no way to customize the items in the toolbar, however the toolbar
1871 can be hidden by I<View:Filter Toolbar>.
1873 =item Packet List Pane
1875 The top pane contains the list of network packets that you can scroll
1876 through and select. By default, the packet number, packet timestamp,
1877 source and destination addresses, protocol, and description are
1878 displayed for each packet; the I<Columns> page in the dialog box popped
1879 up by I<Edit:Preferences> lets you change this (although, unfortunately,
1880 you currently have to save the preferences, and exit and restart
1881 Wireshark, for those changes to take effect).
1883 If you click on the heading for a column, the display will be sorted by
1884 that column; clicking on the heading again will reverse the sort order
1887 An effort is made to display information as high up the protocol stack
1888 as possible, e.g. IP addresses are displayed for IP packets, but the
1889 MAC layer address is displayed for unknown packet types.
1891 The right mouse button can be used to pop up a menu of operations.
1893 The middle mouse button can be used to mark a packet.
1895 =item Packet Details Pane
1897 The middle pane contains a display of the details of the
1898 currently-selected packet. The display shows each field and its value
1899 in each protocol header in the stack. The right mouse button can be
1900 used to pop up a menu of operations.
1902 =item Packet Bytes Pane
1904 The lowest pane contains a hex and ASCII dump of the actual packet data.
1905 Selecting a field in the packet details highlights the corresponding
1906 bytes in this section.
1908 The right mouse button can be used to pop up a menu of operations.
1912 The statusbar is divided into three parts, on the left some context dependent
1913 things are shown, like information about the loaded file, in the center the
1914 number of packets are displayed, and on the right the current configuration
1917 The statusbar can be hidden by I<View:Statusbar>.
1923 The I<Preferences> dialog lets you control various personal preferences
1924 for the behavior of B<Wireshark>.
1928 =item User Interface Preferences
1930 The I<User Interface> page is used to modify small aspects of the GUI to
1931 your own personal taste:
1935 =item Selection Bars
1937 The selection bar in the packet list and packet details can have either
1938 a "browse" or "select" behavior. If the selection bar has a "browse"
1939 behavior, the arrow keys will move an outline of the selection bar,
1940 allowing you to browse the rest of the list or details without changing
1941 the selection until you press the space bar. If the selection bar has a
1942 "select" behavior, the arrow keys will move the selection bar and change
1943 the selection to the new item in the packet list or packet details.
1945 =item Save Window Position
1947 If this item is selected, the position of the main Wireshark window will
1948 be saved when Wireshark exits, and used when Wireshark is started again.
1950 =item Save Window Size
1952 If this item is selected, the size of the main Wireshark window will
1953 be saved when Wireshark exits, and used when Wireshark is started again.
1955 =item Save Window Maximized state
1957 If this item is selected the maximize state of the main Wireshark window
1958 will be saved when Wireshark exists, and used when Wireshark is started again.
1960 =item File Open Dialog Behavior
1962 This item allows the user to select how Wireshark handles the listing
1963 of the "File Open" Dialog when opening trace files. "Remember Last
1964 Directory" causes Wireshark to automatically position the dialog in the
1965 directory of the most recently opened file, even between launches of Wireshark.
1966 "Always Open in Directory" allows the user to define a persistent directory
1967 that the dialog will always default to.
1971 Allows the user to specify a persistent File Open directory. Trailing
1972 slashes or backslashes will automatically be added.
1974 =item File Open Preview timeout
1976 This items allows the user to define how much time is spend reading the
1977 capture file to present preview data in the File Open dialog.
1979 =item Open Recent maximum list entries
1981 The File menu supports a recent file list. This items allows the user to
1982 specify how many files are kept track of in this list.
1984 =item Ask for unsaved capture files
1986 When closing a capture file or Wireshark itself if the file isn't saved yet
1987 the user is presented the option to save the file when this item is set.
1989 =item Wrap during find
1991 This items determines the behavior when reaching the beginning or the end
1992 of a capture file. When set the search wraps around and continues, otherwise
1995 =item Settings dialogs show a save button
1997 This item determines if the various dialogs sport an explicit Save button
1998 or that save is implicit in OK / Apply.
2000 =item Web browser command
2002 This entry specifies the command line to launch a web browser. It is used
2003 to access online content, like the Wiki and user guide. Use '%s' to place
2004 the request URL in the command line.
2006 =item Display LEDs in the Expert Infos dialog tab labels
2008 This item determines if LED-like colored images are displayed in the
2009 Expert Infos dialog tab labels.
2013 =item Layout Preferences
2015 The I<Layout> page lets you specify the general layout of the main window.
2016 You can choose from six different layouts and fill the three panes with the
2023 The vertical scrollbars in the three panes can be set to be either on
2024 the left or the right.
2026 =item Alternating row colors
2030 The highlight method in the hex dump display for the selected protocol
2031 item can be set to use either inverse video, or bold characters.
2035 =item Filter toolbar placement
2037 =item Custom window title
2041 =item Column Preferences
2043 The I<Columns> page lets you specify the number, title, and format
2044 of each column in the packet list.
2046 The I<Column title> entry is used to specify the title of the column
2047 displayed at the top of the packet list. The type of data that the column
2048 displays can be specified using the I<Column format> option menu.
2049 The row of buttons on the left perform the following actions:
2055 Adds a new column to the list.
2059 Deletes the currently selected list item.
2063 Moves the selected list item up or down one position.
2067 =item Font Preferences
2069 The I<Font> page lets you select the font to be used for most text.
2071 =item Color Preferences
2073 The I<Colors> page can be used to change the color of the text
2074 displayed in the TCP stream window and for marked packets. To change a color,
2075 simply select an attribute from the "Set:" menu and use the color selector to
2076 get the desired color. The new text colors are displayed as a sample text.
2078 =item Capture Preferences
2080 The I<Capture> page lets you specify various parameters for capturing
2081 live packet data; these are used the first time a capture is started.
2083 The I<Interface:> combo box lets you specify the interface from which to
2084 capture packet data, or the name of a FIFO from which to get the packet
2087 The I<Data link type:> option menu lets you, for some interfaces, select
2088 the data link header you want to see on the packets you capture. For
2089 example, in some OSes and with some versions of libpcap, you can choose,
2090 on an 802.11 interface, whether the packets should appear as Ethernet
2091 packets (with a fake Ethernet header) or as 802.11 packets.
2093 The I<Limit each packet to ... bytes> check box lets you set the
2094 snapshot length to use when capturing live data; turn on the check box,
2095 and then set the number of bytes to use as the snapshot length.
2097 The I<Filter:> text entry lets you set a capture filter expression to be
2098 used when capturing.
2100 If any of the environment variables SSH_CONNECTION, SSH_CLIENT,
2101 REMOTEHOST, DISPLAY, or SESSIONNAME are set, Wireshark will create a
2102 default capture filter that excludes traffic from the hosts and ports
2103 defined in those variables.
2105 The I<Capture packets in promiscuous mode> check box lets you specify
2106 whether to put the interface in promiscuous mode when capturing.
2108 The I<Update list of packets in real time> check box lets you specify
2109 that the display should be updated as packets are seen.
2111 The I<Automatic scrolling in live capture> check box lets you specify
2112 whether, in an "Update list of packets in real time" capture, the packet
2113 list pane should automatically scroll to show the most recently captured
2116 =item Printing Preferences
2118 The radio buttons at the top of the I<Printing> page allow you choose
2119 between printing packets with the I<File:Print Packet> menu item as text
2120 or PostScript, and sending the output directly to a command or saving it
2121 to a file. The I<Command:> text entry box, on UNIX-compatible systems,
2122 is the command to send files to (usually B<lpr>), and the I<File:> entry
2123 box lets you enter the name of the file you wish to save to.
2124 Additionally, you can select the I<File:> button to browse the file
2125 system for a particular save file.
2127 =item Name Resolution Preferences
2129 The I<Enable MAC name resolution>, I<Enable network name resolution> and
2130 I<Enable transport name resolution> check boxes let you specify whether
2131 MAC addresses, network addresses, and transport-layer port numbers
2132 should be translated to names.
2134 The I<Enable concurrent DNS name resolution> allows Wireshark to send out
2135 multiple name resolution requests and not wait for the result before
2136 continuing dissection. This speeds up dissection with network name
2137 resolution but initially may miss resolutions. The number of concurrent
2138 requests can be set here as well.
2144 =item RTP Player Preferences
2146 This page allows you to select the number of channels visible in the
2147 RTP player window. It determines the height of the window, more channels
2148 are possible and visible by means of a scroll bar.
2150 =item Protocol Preferences
2152 There are also pages for various protocols that Wireshark dissects,
2153 controlling the way Wireshark handles those protocols.
2157 =item Edit Capture Filter List
2159 =item Edit Display Filter List
2161 =item Capture Filter
2163 =item Display Filter
2169 The I<Edit Capture Filter List> dialog lets you create, modify, and
2170 delete capture filters, and the I<Edit Display Filter List> dialog lets
2171 you create, modify, and delete display filters.
2173 The I<Capture Filter> dialog lets you do all of the editing operations
2174 listed, and also lets you choose or construct a filter to be used when
2177 The I<Display Filter> dialog lets you do all of the editing operations
2178 listed, and also lets you choose or construct a filter to be used to
2179 filter the current capture being viewed.
2181 The I<Read Filter> dialog lets you do all of the editing operations
2182 listed, and also lets you choose or construct a filter to be used to
2183 as a read filter for a capture file you open.
2185 The I<Search Filter> dialog lets you do all of the editing operations
2186 listed, and also lets you choose or construct a filter expression to be
2187 used in a find operation.
2189 In all of those dialogs, the I<Filter name> entry specifies a
2190 descriptive name for a filter, e.g. B<Web and DNS traffic>. The
2191 I<Filter string> entry is the text that actually describes the filtering
2192 action to take, as described above.The dialog buttons perform the
2199 If there is text in the two entry boxes, creates a new associated list
2204 Modifies the currently selected list item to match what's in the entry
2209 Deletes the currently selected list item.
2211 =item Add Expression...
2213 For display filter expressions, pops up a dialog box to allow you to
2214 construct a filter expression to test a particular field; it offers
2215 lists of field names, and, when appropriate, lists from which to select
2216 tests to perform on the field and values with which to compare it. In
2217 that dialog box, the OK button will cause the filter expression you
2218 constructed to be entered into the I<Filter string> entry at the current
2223 In the I<Capture Filter> dialog, closes the dialog box and makes the
2224 filter in the I<Filter string> entry the filter in the I<Capture
2225 Preferences> dialog. In the I<Display Filter> dialog, closes the dialog
2226 box and makes the filter in the I<Filter string> entry the current
2227 display filter, and applies it to the current capture. In the I<Read
2228 Filter> dialog, closes the dialog box and makes the filter in the
2229 I<Filter string> entry the filter in the I<Open Capture File> dialog.
2230 In the I<Search Filter> dialog, closes the dialog box and makes the
2231 filter in the I<Filter string> entry the filter in the I<Find Packet>
2236 Makes the filter in the I<Filter string> entry the current display
2237 filter, and applies it to the current capture.
2241 If the list of filters being edited is the list of
2242 capture filters, saves the current filter list to the personal capture
2243 filters file, and if the list of filters being edited is the list of
2244 display filters, saves the current filter list to the personal display
2249 Closes the dialog without doing anything with the filter in the I<Filter
2254 =item The Color Filters Dialog
2256 This dialog displays a list of color filters and allows it to be
2261 =item THE FILTER LIST
2263 Single rows may be selected by clicking. Multiple rows may be selected
2264 by using the ctrl and shift keys in combination with the mouse button.
2268 Adds a new filter at the bottom of the list and opens the Edit Color
2269 Filter dialog box. You will have to alter the filter expression at
2270 least before the filter will be accepted. The format of color filter
2271 expressions is identical to that of display filters. The new filter is
2272 selected, so it may immediately be moved up and down, deleted or edited.
2273 To avoid confusion all filters are unselected before the new filter is
2278 Opens the Edit Color Filter dialog box for the selected filter. (If this
2279 button is disabled you may have more than one filter selected, making it
2280 ambiguous which is to be edited.)
2284 Enables the selected color filter(s).
2288 Disables the selected color filter(s).
2292 Deletes the selected color filter(s).
2296 Allows you to choose a file in which to save the current list of color
2297 filters. You may also choose to save only the selected filters. A
2298 button is provided to save the filters in the global color filters file
2299 (you must have sufficient permissions to write this file, of course).
2303 Allows you to choose a file containing color filters which are then
2304 added to the bottom of the current list. All the added filters are
2305 selected, so they may be moved to the correct position in the list as a
2306 group. To avoid confusion, all filters are unselected before the new
2307 filters are imported. A button is provided to load the filters from the
2308 global color filters file.
2312 Deletes your personal color filters file, reloads the global
2313 color filters file, if any, and closes the dialog.
2317 Moves the selected filter(s) up the list, making it more likely that
2318 they will be used to color packets.
2322 Moves the selected filter(s) down the list, making it less likely that
2323 they will be used to color packets.
2327 Closes the dialog and uses the color filters as they stand.
2331 Colors the packets according to the current list of color filters, but
2332 does not close the dialog.
2336 Saves the current list of color filters in your personal color filters
2337 file. Unless you do this they will not be used the next time you start
2342 Closes the dialog without changing the coloration of the packets. Note
2343 that changes you have made to the current list of color filters are not
2348 =item Capture Options Dialog
2350 The I<Capture Options Dialog> lets you specify various parameters for
2351 capturing live packet data.
2353 The I<Interface:> field lets you specify the interface from which to
2354 capture packet data or a command from which to get the packet data via a
2357 The I<Link layer header type:> field lets you specify the interfaces link
2358 layer header type. This field is usually disabled, as most interface have
2359 only one header type.
2361 The I<Capture packets in promiscuous mode> check box lets you specify
2362 whether the interface should be put into promiscuous mode when
2365 The I<Limit each packet to ... bytes> check box and field lets you
2366 specify a maximum number of bytes per packet to capture and save; if the
2367 check box is not checked, the limit will be 65535 bytes.
2369 The I<Capture Filter:> entry lets you specify the capture filter using a
2370 tcpdump-style filter string as described above.
2372 The I<File:> entry lets you specify the file into which captured packets
2373 should be saved, as in the I<Printer Options> dialog above. If not
2374 specified, the captured packets will be saved in a temporary file; you
2375 can save those packets to a file with the I<File:Save As> menu item.
2377 The I<Use multiple files> check box lets you specify that the capture
2378 should be done in "multiple files" mode. This option is disabled, if the
2379 I<Update list of packets in real time> option is checked.
2381 The I<Next file every ... megabyte(s)> check box and fields lets
2382 you specify that a switch to a next file should be done
2383 if the specified filesize is reached. You can also select the appropriate
2384 unit, but beware that the filesize has a maximum of 2 GiB.
2385 The check box is forced to be checked, as "multiple files" mode requires a
2386 file size to be specified.
2388 The I<Next file every ... minute(s)> check box and fields lets
2389 you specify that the switch to a next file should be done after the specified
2390 time has elapsed, even if the specified capture size is not reached.
2392 The I<Ring buffer with ... files> field lets you specify the number
2393 of files of a ring buffer. This feature will capture into the first file
2394 again, after the specified number of files have been used.
2396 The I<Stop capture after ... files> field lets you specify the number
2397 of capture files used, until the capture is stopped.
2399 The I<Stop capture after ... packet(s)> check box and field let
2400 you specify that Wireshark should stop capturing after having captured
2401 some number of packets; if the check box is not checked, Wireshark will
2402 not stop capturing at some fixed number of captured packets.
2404 The I<Stop capture after ... megabyte(s)> check box and field lets
2405 you specify that Wireshark should stop capturing after the file to which
2406 captured packets are being saved grows as large as or larger than some
2407 specified number of megabytes. If the check box is not checked, Wireshark
2408 will not stop capturing at some capture file size (although the operating
2409 system on which Wireshark is running, or the available disk space, may still
2410 limit the maximum size of a capture file). This option is disabled, if
2411 "multiple files" mode is used,
2413 The I<Stop capture after ... second(s)> check box and field let you
2414 specify that Wireshark should stop capturing after it has been capturing
2415 for some number of seconds; if the check box is not checked, Wireshark
2416 will not stop capturing after some fixed time has elapsed.
2418 The I<Update list of packets in real time> check box lets you specify
2419 whether the display should be updated as packets are captured and, if
2420 you specify that, the I<Automatic scrolling in live capture> check box
2421 lets you specify the packet list pane should automatically scroll to
2422 show the most recently captured packets as new packets arrive.
2424 The I<Enable MAC name resolution>, I<Enable network name resolution> and
2425 I<Enable transport name resolution> check boxes let you specify whether
2426 MAC addresses, network addresses, and transport-layer port numbers
2427 should be translated to names.
2431 The I<About> dialog lets you view various information about Wireshark.
2433 =item About:Wireshark
2435 The I<Wireshark> page lets you view general information about Wireshark,
2436 like the installed version, licensing information and such.
2440 The I<Authors> page shows the author and all contributors.
2444 The I<Folders> page lets you view the directory names where Wireshark is
2445 searching it's various configuration and other files.
2449 The I<Plugins> page lets you view the dissector plugin modules
2450 available on your system.
2452 The I<Plugins List> shows the name and version of each dissector plugin
2453 module found on your system.
2455 On Unix-compatible systems, the plugins are looked for in the following
2456 directories: the F<lib/wireshark/plugins/$VERSION> directory under the
2457 main installation directory (for example,
2458 F</usr/local/lib/wireshark/plugins/$VERSION>), and then
2459 F<$HOME/.wireshark/plugins>.
2461 On Windows systems, the plugins are looked for in the following
2462 directories: F<plugins\$VERSION> directory under the main installation
2463 directory (for example, F<C:\Program Files\Wireshark\plugins\$VERSION>),
2464 and then F<%APPDATA%\Wireshark\plugins\$VERSION> (or, if %APPDATA% isn't
2465 defined, F<%USERPROFILE%\Application Data\Wireshark\plugins\$VERSION>).
2467 $VERSION is the version number of the plugin interface, which
2468 is typically the version number of Wireshark. Note that a dissector
2469 plugin module may support more than one protocol; there is not
2470 necessarily a one-to-one correspondence between dissector plugin modules
2471 and protocols. Protocols supported by a dissector plugin module are
2472 enabled and disabled using the I<Edit:Protocols> dialog box, just as
2473 protocols built into Wireshark are.
2477 =head1 CAPTURE FILTER SYNTAX
2479 See the manual page of pcap-filter(7) or, if that doesn't exist, tcpdump(8),
2480 or, if that doesn't exist, L<http://wiki.wireshark.org/CaptureFilters>.
2482 =head1 DISPLAY FILTER SYNTAX
2484 For a complete table of protocol and protocol fields that are filterable
2485 in B<Wireshark> see the wireshark-filter(4) manual page.
2489 These files contains various B<Wireshark> configuration settings.
2495 The F<preferences> files contain global (system-wide) and personal
2496 preference settings. If the system-wide preference file exists, it is
2497 read first, overriding the default settings. If the personal preferences
2498 file exists, it is read next, overriding any previous values. Note: If
2499 the command line flag B<-o> is used (possibly more than once), it will
2500 in turn override values from the preferences files.
2502 The preferences settings are in the form I<prefname>B<:>I<value>,
2504 where I<prefname> is the name of the preference
2505 and I<value> is the value to
2506 which it should be set; white space is allowed between B<:> and
2507 I<value>. A preference setting can be continued on subsequent lines by
2508 indenting the continuation lines with white space. A B<#> character
2509 starts a comment that runs to the end of the line:
2511 # Vertical scrollbars should be on right side?
2512 # TRUE or FALSE (case-insensitive).
2513 gui.scrollbar_on_right: TRUE
2515 The global preferences file is looked for in the F<wireshark> directory
2516 under the F<share> subdirectory of the main installation directory (for
2517 example, F</usr/local/share/wireshark/preferences>) on UNIX-compatible
2518 systems, and in the main installation directory (for example,
2519 F<C:\Program Files\Wireshark\preferences>) on Windows systems.
2521 The personal preferences file is looked for in F<$HOME/.wireshark/preferences> on
2522 UNIX-compatible systems and F<%APPDATA%\Wireshark\preferences> (or, if
2523 %APPDATA% isn't defined, F<%USERPROFILE%\Application
2524 Data\Wireshark\preferences>) on Windows systems.
2526 Note: Whenever the preferences are saved by using the I<Save> button
2527 in the I<Edit:Preferences> dialog box, your personal preferences file
2528 will be overwritten with the new settings, destroying any comments and
2529 unknown/obsolete settings that were in the file.
2533 The F<recent> file contains personal settings (mostly GUI related) such
2534 as the current B<Wireshark> window size. The file is saved at program exit and
2535 read in at program start automatically. Note: The command line flag B<-o>
2536 may be used to override settings from this file.
2538 The settings in this file have the same format as in the F<preferences>
2539 files, and the same directory as for the personal preferences file is
2542 Note: Whenever Wireshark is closed, your recent file
2543 will be overwritten with the new settings, destroying any comments and
2544 unknown/obsolete settings that were in the file.
2546 =item Disabled (Enabled) Protocols
2548 The F<disabled_protos> files contain system-wide and personal lists of
2549 protocols that have been disabled, so that their dissectors are never
2550 called. The files contain protocol names, one per line, where the
2551 protocol name is the same name that would be used in a display filter
2557 If a protocol is listed in the global F<disabled_protos> file, it is not
2558 displayed in the I<Analyze:Enabled Protocols> dialog box, and so cannot
2559 be enabled by the user.
2561 The global F<disabled_protos> file uses the same directory as the global
2564 The personal F<disabled_protos> file uses the same directory as the
2565 personal preferences file.
2567 Note: Whenever the disabled protocols list is saved by using the I<Save>
2568 button in the I<Analyze:Enabled Protocols> dialog box, your personal
2569 disabled protocols file will be overwritten with the new settings,
2570 destroying any comments that were in the file.
2572 =item Name Resolution (hosts)
2574 If the personal F<hosts> file exists, it is
2575 used to resolve IPv4 and IPv6 addresses before any other
2576 attempts are made to resolve them. The file has the standard F<hosts>
2577 file syntax; each line contains one IP address and name, separated by
2578 whitespace. The same directory as for the personal preferences file is used.
2580 Capture filter name resolution is handled by libpcap on UNIX-compatible
2581 systems and WinPcap on Windows. As such the Wireshark personal F<hosts> file
2582 will not be consulted for capture filter name resolution.
2584 =item Name Resolution (ethers)
2586 The F<ethers> files are consulted to correlate 6-byte hardware addresses to
2587 names. First the personal F<ethers> file is tried and if an address is not
2588 found there the global F<ethers> file is tried next.
2590 Each line contains one hardware address and name, separated by
2591 whitespace. The digits of the hardware address are separated by colons
2592 (:), dashes (-) or periods (.). The same separator character must be
2593 used consistently in an address. The following three lines are valid
2594 lines of an F<ethers> file:
2596 ff:ff:ff:ff:ff:ff Broadcast
2597 c0-00-ff-ff-ff-ff TR_broadcast
2598 00.00.00.00.00.00 Zero_broadcast
2600 The global F<ethers> file is looked for in the F</etc> directory on
2601 UNIX-compatible systems, and in the main installation directory (for
2602 example, F<C:\Program Files\Wireshark>) on Windows systems.
2604 The personal F<ethers> file is looked for in the same directory as the personal
2607 Capture filter name resolution is handled by libpcap on UNIX-compatible
2608 systems and WinPcap on Windows. As such the Wireshark personal F<ethers> file
2609 will not be consulted for capture filter name resolution.
2611 =item Name Resolution (manuf)
2613 The F<manuf> file is used to match the 3-byte vendor portion of a 6-byte
2614 hardware address with the manufacturer's name; it can also contain well-known
2615 MAC addresses and address ranges specified with a netmask. The format of the
2616 file is the same as the F<ethers> files, except that entries such as:
2620 can be provided, with the 3-byte OUI and the name for a vendor, and
2623 00-00-0C-07-AC/40 All-HSRP-routers
2625 can be specified, with a MAC address and a mask indicating how many bits
2626 of the address must match. The above entry, for example, has 40
2627 significant bits, or 5 bytes, and would match addresses from
2628 00-00-0C-07-AC-00 through 00-00-0C-07-AC-FF. The mask need not be a
2631 The F<manuf> file is looked for in the same directory as the global
2634 =item Name Resolution (ipxnets)
2636 The F<ipxnets> files are used to correlate 4-byte IPX network numbers to
2637 names. First the global F<ipxnets> file is tried and if that address is not
2638 found there the personal one is tried next.
2640 The format is the same as the F<ethers>
2641 file, except that each address is four bytes instead of six.
2642 Additionally, the address can be represented as a single hexadecimal
2643 number, as is more common in the IPX world, rather than four hex octets.
2644 For example, these four lines are valid lines of an F<ipxnets> file:
2648 00:00:BE:EF IT_Server1
2651 The global F<ipxnets> file is looked for in the F</etc> directory on
2652 UNIX-compatible systems, and in the main installation directory (for
2653 example, F<C:\Program Files\Wireshark>) on Windows systems.
2655 The personal F<ipxnets> file is looked for in the same directory as the
2656 personal preferences file.
2658 =item Capture Filters
2660 The F<cfilters> files contain system-wide and personal capture filters.
2661 Each line contains one filter, starting with the string displayed in the
2662 dialog box in quotation marks, followed by the filter string itself:
2667 The global F<cfilters> file uses the same directory as the
2668 global preferences file.
2670 The personal F<cfilters> file uses the same directory as the personal
2671 preferences file. It is written through the Capture:Capture Filters
2674 If the global F<cfilters> file exists, it is used only if the personal
2675 F<cfilters> file does not exist; global and personal capture filters are
2678 =item Display Filters
2680 The F<dfilters> files contain system-wide and personal display filters.
2681 Each line contains one filter, starting with the string displayed in the
2682 dialog box in quotation marks, followed by the filter string itself:
2687 The global F<dfilters> file uses the same directory as the
2688 global preferences file.
2690 The personal F<dfilters> file uses the same directory as the
2691 personal preferences file. It is written through the Analyze:Display
2694 If the global F<dfilters> file exists, it is used only if the personal
2695 F<dfilters> file does not exist; global and personal display filters are
2698 =item Color Filters (Coloring Rules)
2700 The F<colorfilters> files contain system-wide and personal color filters.
2701 Each line contains one filter, starting with the string displayed in the
2702 dialog box, followed by the corresponding display filter. Then the
2703 background and foreground colors are appended:
2706 @tcp@tcp@[59345,58980,65534][0,0,0]
2707 @udp@udp@[28834,57427,65533][0,0,0]
2709 The global F<colorfilters> file uses the same directory as the
2710 global preferences file.
2712 The personal F<colorfilters> file uses the same directory as the
2713 personal preferences file. It is written through the View:Coloring Rules
2716 If the global F<colorfilters> file exists, it is used only if the personal
2717 F<colorfilters> file does not exist; global and personal color filters are
2722 The F<gtkrc> files contain system-wide and personal GTK theme settings.
2724 The global F<gtkrc> file uses the same directory as the
2725 global preferences file.
2727 The personal F<gtkrc> file uses the same directory as the personal
2732 See above in the description of the About:Plugins page.
2736 =head1 ENVIRONMENT VARIABLES
2740 =item WIRESHARK_APPDATA
2742 On Windows, Wireshark normally stores all application data in %APPDATA% or
2743 %USERPROFILE%. You can override the default location by exporting this
2744 environment variable to specify an alternate location.
2746 =item WIRESHARK_DEBUG_EP_NO_CHUNKS
2748 Normally per-packet memory is allocated in large "chunks." This behavior
2749 doesn't work well with debugging tools such as Valgrind or ElectricFence.
2750 Export this environment variable to force individual allocations.
2751 Note: disabling chunks also disables canaries (see below).
2753 =item WIRESHARK_DEBUG_SE_NO_CHUNKS
2755 Normally per-file memory is allocated in large "chunks." This behavior
2756 doesn't work well with debugging tools such as Valgrind or ElectricFence.
2757 Export this environment variable to force individual allocations.
2758 Note: disabling chunks also disables canaries (see below).
2760 =item WIRESHARK_DEBUG_EP_NO_CANARY
2762 Normally per-packet memory allocations are separated by "canaries" which
2763 allow detection of memory overruns. This comes at the expense of some extra
2764 memory usage. Exporting this environment variable disables these canaries.
2766 =item WIRESHARK_DEBUG_SE_USE_CANARY
2768 Exporting this environment variable causes per-file memory allocations to be
2769 protected with "canaries" which allow for detection of memory overruns.
2770 This comes at the expense of significant extra memory usage.
2772 =item WIRESHARK_DEBUG_SCRUB_MEMORY
2774 If this environment variable is set, the contents of per-packet and
2775 per-file memory is initialized to 0xBADDCAFE when the memory is allocated
2776 and is reset to 0xDEADBEEF when the memory is freed. This functionality is
2777 useful mainly to developers looking for bugs in the way memory is handled.
2779 =item WIRESHARK_DEBUG_WMEM_OVERRIDE
2781 Setting this environment variable forces the wmem framework to use the
2782 specified allocator backend for *all* allocations, regardless of which
2783 backend is normally specified by the code. This is mainly useful to developers
2784 when testing or debugging. See I<README.wmem> in the source distribution for
2787 =item WIRESHARK_RUN_FROM_BUILD_DIRECTORY
2789 This environment variable causes the plugins and other data files to be loaded
2790 from the build directory (where the program was compiled) rather than from the
2791 standard locations. It has no effect when the program in question is running
2792 with root (or setuid) permissions on *NIX.
2794 =item WIRESHARK_DATA_DIR
2796 This environment variable causes the various data files to be loaded from
2797 a directory other than the standard locations. It has no effect when the
2798 program in question is running with root (or setuid) permissions on *NIX.
2800 =item ERF_RECORDS_TO_CHECK
2802 This environment variable controls the number of ERF records checked when
2803 deciding if a file really is in the ERF format. Setting this environment
2804 variable a number higher than the default (20) would make false positives
2807 =item IPFIX_RECORDS_TO_CHECK
2809 This environment variable controls the number of IPFIX records checked when
2810 deciding if a file really is in the IPFIX format. Setting this environment
2811 variable a number higher than the default (20) would make false positives
2814 =item WIRESHARK_ABORT_ON_DISSECTOR_BUG
2816 If this environment variable is set, B<Wireshark> will call abort(3)
2817 when a dissector bug is encountered. abort(3) will cause the program to
2818 exit abnormally; if you are running B<Wireshark> in a debugger, it
2819 should halt in the debugger and allow inspection of the process, and, if
2820 you are not running it in a debugger, it will, on some OSes, assuming
2821 your environment is configured correctly, generate a core dump file.
2822 This can be useful to developers attempting to troubleshoot a problem
2823 with a protocol dissector.
2825 =item WIRESHARK_ABORT_ON_TOO_MANY_ITEMS
2827 If this environment variable is set, B<Wireshark> will call abort(3)
2828 if a dissector tries to add too many items to a tree (generally this
2829 is an indication of the dissector not breaking out of a loop soon enough).
2830 abort(3) will cause the program to exit abnormally; if you are running
2831 B<Wireshark> in a debugger, it should halt in the debugger and allow
2832 inspection of the process, and, if you are not running it in a debugger,
2833 it will, on some OSes, assuming your environment is configured correctly,
2834 generate a core dump file. This can be useful to developers attempting to
2835 troubleshoot a problem with a protocol dissector.
2837 =item WIRESHARK_EP_VERIFY_POINTERS
2839 This environment variable, if set, causes certain uses of pointers to be
2840 audited to ensure they do not point to memory that is deallocated after each
2841 packet has been fully dissected. This can be useful to developers writing or
2844 =item WIRESHARK_SE_VERIFY_POINTERS
2846 This environment variable, if set, causes certain uses of pointers to be
2847 audited to ensure they do not point to memory that is deallocated after when
2848 a capture file is closed. This can be useful to developers writing or
2851 =item WIRESHARK_QUIT_AFTER_CAPTURE
2853 Cause B<Wireshark> to exit after the end of the capture session. This
2854 doesn't automatically start a capture; you must still use B<-k> to do
2855 that. You must also specify an autostop condition, e.g. B<-c> or B<-a
2856 duration:...>. This means that you will not be able to see the results
2857 of the capture after it stops; it's primarily useful for testing.
2859 =item WIRESHARK_ABORT_ON_OUT_OF_MEMORY
2861 This environment variable, if present, causes abort(3) to be called if certain
2862 out-of-memory conditions (which normally result in an exception and an
2863 explanatory error message) are experienced. This can be useful to developers
2864 debugging out-of-memory conditions.
2870 wireshark-filter(4), tshark(1), editcap(1), pcap(3), dumpcap(1), mergecap(1),
2871 text2pcap(1), pcap-filter(7) or tcpdump(8)
2875 The latest version of B<Wireshark> can be found at
2876 L<http://www.wireshark.org>.
2878 HTML versions of the Wireshark project man pages are available at:
2879 L<http://www.wireshark.org/docs/man-pages>.