4 wireshark - Interactively dump and analyze network traffic
9 S<[ B<-a> E<lt>capture autostop conditionE<gt> ] ...>
10 S<[ B<-b> E<lt>capture ring buffer optionE<gt> ] ...>
11 S<[ B<-B> E<lt>capture buffer size (Win32 only)E<gt> ] >
12 S<[ B<-c> E<lt>capture packet countE<gt> ]>
13 S<[ B<-C> E<lt>configuration profileE<gt> ]>
15 S<[ B<--display=>E<lt>X display to useE<gt> ] >
16 S<[ B<-f> E<lt>capture filterE<gt> ]>
17 S<[ B<-g> E<lt>packet numberE<gt> ]>
20 S<[ B<-i> E<lt>capture interfaceE<gt>|- ]>
21 S<[ B<-J> E<lt>jump filterE<gt> ]>
24 S<[ B<-K> E<lt>keytabE<gt> ]>
27 S<[ B<-m> E<lt>fontE<gt> ]>
29 S<[ B<-N> E<lt>name resolving flagsE<gt> ] >
30 S<[ B<-o> E<lt>preference/recent settingE<gt> ] ...>
32 S<[ B<-P> E<lt>path settingE<gt>]>
34 S<[ B<-r> E<lt>infileE<gt> ]>
35 S<[ B<-R> E<lt>read (display) filterE<gt> ]>
37 S<[ B<-s> E<lt>capture snaplenE<gt> ]>
38 S<[ B<-t> ad|a|r|d|dd|e ]>
40 S<[ B<-w> E<lt>outfileE<gt> ]>
41 S<[ B<-y> E<lt>capture link typeE<gt> ]>
42 S<[ B<-X> E<lt>eXtension optionE<gt> ]>
43 S<[ B<-z> E<lt>statisticsE<gt> ]>
44 S<[ E<lt>infileE<gt> ]>
48 B<Wireshark> is a GUI network protocol analyzer. It lets you
49 interactively browse packet data from a live network or from a
50 previously saved capture file. B<Wireshark>'s native capture file format
51 is B<libpcap> format, which is also the format used by B<tcpdump> and
54 B<Wireshark> can read / import the following file formats:
59 libpcap, tcpdump and various other tools using tcpdump's capture format
62 B<snoop> and B<atmsnoop>
65 Shomiti/Finisar B<Surveyor> captures
68 Novell B<LANalyzer> captures
71 Microsoft B<Network Monitor> captures
74 AIX's B<iptrace> captures
77 Cinco Networks B<NetXRay> captures
80 Network Associates Windows-based B<Sniffer> captures
83 Network General/Network Associates DOS-based B<Sniffer> (compressed or uncompressed) captures
86 AG Group/WildPackets B<EtherPeek>/B<TokenPeek>/B<AiroPeek>/B<EtherHelp>/B<PacketGrabber> captures
89 B<RADCOM>'s WAN/LAN analyzer captures
92 Network Instruments B<Observer> version 9 captures
95 B<Lucent/Ascend> router debug output
98 files from HP-UX's B<nettl>
101 B<Toshiba's> ISDN routers dump output
104 the output from B<i4btrace> from the ISDN4BSD project
107 traces from the B<EyeSDN> USB S0.
110 the output in B<IPLog> format from the Cisco Secure Intrusion Detection System
113 B<pppd logs> (pppdump format)
116 the output from VMS's B<TCPIPtrace>/B<TCPtrace>/B<UCX$TRACE> utilities
119 the text output from the B<DBS Etherwatch> VMS utility
122 Visual Networks' B<Visual UpTime> traffic capture
125 the output from B<CoSine> L2 debug
128 the output from Accellent's B<5Views> LAN agents
131 Endace Measurement Systems' ERF format captures
134 Linux Bluez Bluetooth stack B<hcidump -w> traces
137 Catapult DCT2000 .out files
140 TamoSoft CommView files
143 Apple PacketLogger files
147 There is no need to tell B<Wireshark> what type of
148 file you are reading; it will determine the file type by itself.
149 B<Wireshark> is also capable of reading any of these file formats if they
150 are compressed using gzip. B<Wireshark> recognizes this directly from
151 the file; the '.gz' extension is not required for this purpose.
153 Like other protocol analyzers, B<Wireshark>'s main window shows 3 views
154 of a packet. It shows a summary line, briefly describing what the
155 packet is. A packet details display is shown, allowing you to drill
156 down to exact protocol or field that you interested in. Finally, a hex
157 dump shows you exactly what the packet looks like when it goes over the
160 In addition, B<Wireshark> has some features that make it unique. It can
161 assemble all the packets in a TCP conversation and show you the ASCII
162 (or EBCDIC, or hex) data in that conversation. Display filters in
163 B<Wireshark> are very powerful; more fields are filterable in B<Wireshark>
164 than in other protocol analyzers, and the syntax you can use to create
165 your filters is richer. As B<Wireshark> progresses, expect more and more
166 protocol fields to be allowed in display filters.
168 Packet capturing is performed with the pcap library. The capture filter
169 syntax follows the rules of the pcap library. This syntax is different
170 from the display filter syntax.
172 Compressed file support uses (and therefore requires) the zlib library.
173 If the zlib library is not present, B<Wireshark> will compile, but will
174 be unable to read compressed files.
176 The pathname of a capture file to be read can be specified with the
177 B<-r> option or can be specified as a command-line argument.
181 Most users will want to start B<Wireshark> without options and configure
182 it from the menus instead. Those users may just skip this section.
186 =item -a E<lt>capture autostop conditionE<gt>
188 Specify a criterion that specifies when B<Wireshark> is to stop writing
189 to a capture file. The criterion is of the form I<test>B<:>I<value>,
190 where I<test> is one of:
192 B<duration>:I<value> Stop writing to a capture file after I<value> seconds have
195 B<filesize>:I<value> Stop writing to a capture file after it reaches a size of
196 I<value> kilobytes (where a kilobyte is 1024 bytes). If this option is used
197 together with the -b option, Wireshark will stop writing to the current
198 capture file and switch to the next one if filesize is reached.
200 B<files>:I<value> Stop writing to capture files after I<value> number of files
203 =item -b E<lt>capture ring buffer optionE<gt>
205 Cause B<Wireshark> to run in "multiple files" mode. In "multiple files" mode,
206 B<Wireshark> will write to several capture files. When the first capture file
207 fills up, B<Wireshark> will switch writing to the next file and so on.
209 The created filenames are based on the filename given with the B<-w> flag,
210 the number of the file and on the creation date and time,
211 e.g. outfile_00001_20050604120117.pcap, outfile_00002_20050604120523.pcap, ...
213 With the I<files> option it's also possible to form a "ring buffer".
214 This will fill up new files until the number of files specified,
215 at which point B<Wireshark> will discard the data in the first file and start
216 writing to that file and so on. If the I<files> option is not set,
217 new files filled up until one of the capture stop conditions match (or
218 until the disk is full).
220 The criterion is of the form I<key>B<:>I<value>,
221 where I<key> is one of:
223 B<duration>:I<value> switch to the next file after I<value> seconds have
224 elapsed, even if the current file is not completely filled up.
226 B<filesize>:I<value> switch to the next file after it reaches a size of
227 I<value> kilobytes (where a kilobyte is 1024 bytes).
229 B<files>:I<value> begin again with the first file after I<value> number of
230 files were written (form a ring buffer). This value must be less than 100000.
231 Caution should be used when using large numbers of files: some filesystems do
232 not handle many files in a single directory well. The B<files> criterion
233 requires either B<duration> or B<filesize> to be specified to control when to
234 go to the next file. It should be noted that each B<-b> parameter takes exactly
235 one criterion; to specify two criterion, each must be preceded by the B<-b>
238 Example: B<-b filesize:1024 -b files:5> results in a ring buffer of five files
239 of size one megabyte.
241 =item -B E<lt>capture buffer sizeE<gt>
243 Set capture buffer size (in MB, default is 1MB). This is used by the
244 the capture driver to buffer packet data until that data can be written
245 to disk. If you encounter packet drops while capturing, try to increase
246 this size. Note that, while B<Tshark> attempts to set the buffer size
247 to 1MB by default, and can be told to set it to a larger value, the
248 system or interface on which you're capturing might silently limit the
249 capture buffer size to a lower value or raise it to a higher value.
251 This is available on UNIX systems with libpcap 1.0.0 or later and on
252 Windows. It is not available on UNIX systems with earlier versions of
255 =item -c E<lt>capture packet countE<gt>
257 Set the maximum number of packets to read when capturing live
260 =item -C E<lt>configuration profileE<gt>
262 Start with the given configuration profile.
266 Print a list of the interfaces on which B<Wireshark> can capture, and
267 exit. For each network interface, a number and an
268 interface name, possibly followed by a text description of the
269 interface, is printed. The interface name or the number can be supplied
270 to the B<-i> flag to specify an interface on which to capture.
272 This can be useful on systems that don't have a command to list them
273 (e.g., Windows systems, or UNIX systems lacking B<ifconfig -a>);
274 the number can be useful on Windows 2000 and later systems, where the
275 interface name is a somewhat complex string.
277 Note that "can capture" means that B<Wireshark> was able to open
278 that device to do a live capture; if, on your system, a program doing a
279 network capture must be run from an account with special privileges (for
280 example, as root), then, if B<Wireshark> is run with the B<-D> flag and
281 is not run from such an account, it will not list any interfaces.
283 =item --display=E<lt>X display to useE<gt>
285 Specifies the X display to use. A hostname and screen (otherhost:0.0)
286 or just a screen (:0.0) can be specified. This option is not available
289 =item -f E<lt>capture filterE<gt>
291 Set the capture filter expression.
293 =item -g E<lt>packet numberE<gt>
295 After reading in a capture file using the B<-r> flag, go to the given I<packet number>.
299 Print the version and options and exit.
303 Hide the capture info dialog during live packet capture.
305 =item -i E<lt>capture interfaceE<gt>|-
307 Set the name of the network interface or pipe to use for live packet
310 Network interface names should match one of the names listed in
311 "B<wireshark -D>" (described above); a number, as reported by
312 "B<wireshark -D>", can also be used. If you're using UNIX, "B<netstat
313 -i>" or "B<ifconfig -a>" might also work to list interface names,
314 although not all versions of UNIX support the B<-a> flag to B<ifconfig>.
316 If no interface is specified, B<Wireshark> searches the list of
317 interfaces, choosing the first non-loopback interface if there are any
318 non-loopback interfaces, and choosing the first loopback interface if
319 there are no non-loopback interfaces. If there are no interfaces at all,
320 B<Wireshark> reports an error and doesn't start the capture.
322 Pipe names should be either the name of a FIFO (named pipe) or ``-'' to
323 read data from the standard input. On Windows systems, pipe names must be
324 of the form ``\\pipe\.\B<pipename>''. Data read from pipes must be in
325 standard libpcap format.
327 =item -J E<lt>jump filterE<gt>
329 After reading in a capture file using the B<-r> flag, jump to the packet
330 matching the filter (display filter syntax). If no exact match is found
331 the first packet after that is selected.
335 Use after B<-J> to change the behavior when no exact match is found for
336 the filter. With this option select the first packet before.
340 Start the capture session immediately. If the B<-i> flag was
341 specified, the capture uses the specified interface. Otherwise,
342 B<Wireshark> searches the list of interfaces, choosing the first
343 non-loopback interface if there are any non-loopback interfaces, and
344 choosing the first loopback interface if there are no non-loopback
345 interfaces; if there are no interfaces, B<Wireshark> reports an error and
346 doesn't start the capture.
348 =item -K E<lt>keytabE<gt>
350 Load kerberos crypto keys from the specified keytab file.
351 This option can be used multiple times to load keys from several files.
353 Example: B<-K krb5.keytab>
357 Turn on automatic scrolling if the packet display is being updated
358 automatically as packets arrive during a capture (as specified by the
363 List the data link types supported by the interface and exit.
365 =item -m E<lt>fontE<gt>
367 Set the name of the font used by B<Wireshark> for most text. B<Wireshark>
368 will construct the name of the bold font used for the data in the byte
369 view pane that corresponds to the field selected in the packet details
370 pane from the name of the main text font.
374 Disable network object name resolution (such as hostname, TCP and UDP port
375 names), the B<-N> flag might override this one.
377 =item -N E<lt>name resolving flagsE<gt>
379 Turn on name resolving only for particular types of addresses and port
380 numbers, with name resolving for other types of addresses and port
381 numbers turned off. This flag overrides B<-n> if both B<-N> and B<-n> are
382 present. If both B<-N> and B<-n> flags are not present, all name resolutions are
385 The argument is a string that may contain the letters:
387 B<m> to enable MAC address resolution
389 B<n> to enable network address resolution
391 B<t> to enable transport-layer port number resolution
393 B<C> to enable concurrent (asynchronous) DNS lookups
395 =item -o E<lt>preference/recent settingE<gt>
397 Set a preference or recent value, overriding the default value and any value
398 read from a preference/recent file. The argument to the flag is a string of
399 the form I<prefname>B<:>I<value>, where I<prefname> is the name of the
400 preference/recent value (which is the same name that would appear in the
401 preference/recent file), and I<value> is the value to which it should be set.
402 Since B<Ethereal> 0.10.12, the recent settings replaces the formerly used
403 -B, -P and -T flags to manipulate the GUI dimensions.
405 If I<prefname> is "uat", you can override settings in various user access
406 tables using the form uatB<:>I<uat filename>:I<uat record>. I<uat filename>
407 must be the name of a UAT file, e.g. I<user_dlts>. I<uat_record> must be in
408 the form of a valid record for that file, including quotes. For instance, to
409 specify a user DLT from the command line, you would use
413 -o "uat:user_dlts:\"User 0 (DLT=147)\",\"cops\",\"0\",\"\",\"0\",\"\""
419 I<Don't> put the interface into promiscuous mode. Note that the
420 interface might be in promiscuous mode for some other reason; hence,
421 B<-p> cannot be used to ensure that the only traffic that is captured is
422 traffic sent to or from the machine on which B<Wireshark> is running,
423 broadcast traffic, and multicast traffic to addresses received by that
426 =item -P E<lt>path settingE<gt>
428 Special path settings usually detected automatically. This is used for
429 special cases, e.g. starting Wireshark from a known location on an USB stick.
431 The criterion is of the form I<key>B<:>I<path>, where I<key> is one of:
433 B<persconf>:I<path> path of personal configuration files, like the
436 B<persdata>:I<path> path of personal data files, it's the folder initially
437 opened. After the very first initialization, the recent file will keep the
442 Cause B<Wireshark> to exit after the end of capture session (useful in
443 batch mode with B<-c> option for instance); this option requires the
444 B<-i> and B<-w> parameters.
446 =item -r E<lt>infileE<gt>
448 Read packet data from I<infile>, can be any supported capture file format
449 (including gzipped files). It's not possible to use named pipes or stdin
452 =item -R E<lt>read (display) filterE<gt>
454 When reading a capture file specified with the B<-r> flag, causes the
455 specified filter (which uses the syntax of display filters, rather than
456 that of capture filters) to be applied to all packets read from the
457 capture file; packets not matching the filter are discarded.
461 Automatically update the packet display as packets are coming in.
463 =item -s E<lt>capture snaplenE<gt>
465 Set the default snapshot length to use when capturing live data.
466 No more than I<snaplen> bytes of each network packet will be read into
467 memory, or saved to disk. A value of 0 specifies a snapshot length of
468 65535, so that the full packet is captured; this is the default.
470 =item -t ad|a|r|d|dd|e
472 Set the format of the packet timestamp displayed in the packet list
473 window. The format can be one of:
475 B<ad> absolute with date: The absolute date and time is the actual time and
476 date the packet was captured
478 B<a> absolute: The absolute time is the actual time the packet was captured,
479 with no date displayed
481 B<r> relative: The relative time is the time elapsed between the first packet
482 and the current packet
484 B<d> delta: The delta time is the time since the previous packet was
487 B<dd> delta_displayed: The delta_displayed time is the time since the
488 previous displayed packet was captured
490 B<e> epoch: The time in seconds since epoch (Jan 1, 1970 00:00:00)
492 The default format is relative.
496 Print the version and exit.
498 =item -w E<lt>outfileE<gt>
500 Set the default capture file name.
502 =item -y E<lt>capture link typeE<gt>
504 If a capture is started from the command line with B<-k>, set the data
505 link type to use while capturing packets. The values reported by B<-L>
506 are the values that can be used.
508 =item -X E<lt>eXtension optionsE<gt>
510 Specify an option to be passed to an B<Wireshark> module. The eXtension option
511 is in the form I<extension_key>B<:>I<value>, where I<extension_key> can be:
513 B<lua_script>:I<lua_script_filename> tells B<Wireshark> to load the given script in addition to the
516 B<stdin_descr>:I<description> tells B<Wireshark> to use the given description when
517 capturing from standard input (B<-i ->).
519 =item -z E<lt>statisticsE<gt>
521 Get B<Wireshark> to collect various types of statistics and display the result
522 in a window that updates in semi-real time.
524 Currently implemented statistics are:
528 =item B<-z> dcerpc,srt,I<uuid>,I<major>.I<minor>[,I<filter>]
530 Collect call/reply SRT (Service Response Time) data for DCERPC interface I<uuid>,
531 version I<major>.I<minor>.
532 Data collected is the number of calls for each procedure, MinSRT, MaxSRT
535 Example: S<B<-z dcerpc,srt,12345778-1234-abcd-ef00-0123456789ac,1.0>> will collect data for the CIFS SAMR Interface.
537 This option can be used multiple times on the command line.
539 If the optional I<filter> is provided, the stats will only be calculated
540 on those calls that match that filter.
542 Example: S<B<-z dcerpc,srt,12345778-1234-abcd-ef00-0123456789ac,1.0,ip.addr==1.2.3.4>> will collect SAMR
543 SRT statistics for a specific host.
547 Collect packet/bytes statistics for the capture in intervals of 1 second.
548 This option will open a window with up to 5 color-coded graphs where
549 number-of-packets-per-second or number-of-bytes-per-second statistics
550 can be calculated and displayed.
552 This option can be used multiple times on the command line.
554 This graph window can also be opened from the Analyze:Statistics:Traffic:IO-Stat
557 =item B<-z> rpc,srt,I<program>,I<version>[,<filter>]
559 Collect call/reply SRT (Service Response Time) data for I<program>/I<version>. Data collected
560 is the number of calls for each procedure, MinSRT, MaxSRT and AvgSRT.
562 Example: B<-z rpc,srt,100003,3> will collect data for NFS v3.
564 This option can be used multiple times on the command line.
566 If the optional I<filter> is provided, the stats will only be calculated
567 on those calls that match that filter.
569 Example: S<B<-z rpc,srt,100003,3,nfs.fh.hash==0x12345678>> will collect NFS v3
570 SRT statistics for a specific file.
572 =item B<-z> rpc,programs
574 Collect call/reply RTT data for all known ONC-RPC programs/versions.
575 Data collected is the number of calls for each protocol/version, MinRTT,
578 =item B<-z> scsi,srt,I<cmdset>[,<filter>]
580 Collect call/reply SRT (Service Response Time) data for SCSI commandset <cmdset>.
582 Commandsets are 0:SBC 1:SSC 5:MMC
585 is the number of calls for each procedure, MinSRT, MaxSRT and AvgSRT.
587 Example: B<-z scsi,srt,0> will collect data for SCSI BLOCK COMMANDS (SBC).
589 This option can be used multiple times on the command line.
591 If the optional I<filter> is provided, the stats will only be calculated
592 on those calls that match that filter.
594 Example: B<-z scsi,srt,0,ip.addr==1.2.3.4> will collect SCSI SBC
595 SRT statistics for a specific iscsi/ifcp/fcip host.
597 =item B<-z> smb,srt[,I<filter>]
599 Collect call/reply SRT (Service Response Time) data for SMB. Data collected
600 is the number of calls for each SMB command, MinSRT, MaxSRT and AvgSRT.
602 Example: B<-z smb,srt>
604 The data will be presented as separate tables for all normal SMB commands,
605 all Transaction2 commands and all NT Transaction commands.
606 Only those commands that are seen in the capture will have their stats
608 Only the first command in a xAndX command chain will be used in the
609 calculation. So for common SessionSetupAndX + TreeConnectAndX chains,
610 only the SessionSetupAndX call will be used in the statistics.
611 This is a flaw that might be fixed in the future.
613 This option can be used multiple times on the command line.
615 If the optional I<filter> is provided, the stats will only be calculated
616 on those calls that match that filter.
618 Example: B<-z "smb,srt,ip.addr==1.2.3.4"> will collect stats only for
619 SMB packets exchanged by the host at IP address 1.2.3.4 .
621 =item B<-z> fc,srt[,I<filter>]
623 Collect call/reply SRT (Service Response Time) data for FC. Data collected
624 is the number of calls for each Fibre Channel command, MinSRT, MaxSRT and AvgSRT.
626 Example: B<-z fc,srt>
627 will calculate the Service Response Time as the time delta between the
628 First packet of the exchange and the Last packet of the exchange.
630 The data will be presented as separate tables for all normal FC commands,
631 Only those commands that are seen in the capture will have its stats
634 This option can be used multiple times on the command line.
636 If the optional I<filter> is provided, the stats will only be calculated
637 on those calls that match that filter.
639 Example: B<-z "fc,srt,fc.id==01.02.03"> will collect stats only for
640 FC packets exchanged by the host at FC address 01.02.03 .
642 =item B<-z> ldap,srt[,I<filter>]
644 Collect call/reply SRT (Service Response Time) data for LDAP. Data collected
645 is the number of calls for each implemented LDAP command, MinSRT, MaxSRT and AvgSRT.
647 Example: B<-z ldap,srt>
648 will calculate the Service Response Time as the time delta between the
649 Request and the Response.
651 The data will be presented as separate tables for all implemented LDAP commands,
652 Only those commands that are seen in the capture will have its stats
655 This option can be used multiple times on the command line.
657 If the optional I<filter> is provided, the stats will only be calculated
658 on those calls that match that filter.
660 Example: use B<-z "ldap,srt,ip.addr==10.1.1.1"> will collect stats only for
661 LDAP packets exchanged by the host at IP address 10.1.1.1 .
663 The only LDAP commands that are currently implemented and for which the stats will be available are:
673 =item B<-z> mgcp,srt[I<,filter>]
675 Collect request/response SRT (Service Response Time) data for MGCP.
676 (This is similar to B<-z smb,srt>). Data collected is the number of calls
677 for each known MGCP Type, Minimum SRT, Maximum SRT and Average SRT.
679 Example: B<-z mgcp,srt>
681 This option can be used multiple times on the command line.
683 If the optional I<filter> is provided, the stats will only be calculated
684 on those calls that match that filter.
686 Example: B<-z "mgcp,srt,ip.addr==1.2.3.4"> will collect stats only for
687 MGCP packets exchanged by the host at IP address 1.2.3.4 .
689 =item B<-z> megaco,srt[I<,filter>]
691 Collect request/response SRT (Service Response Time) data for MEGACO.
692 (This is similar to B<-z smb,srt>). Data collected is the number of calls
693 for each known MEGACO Command, Minimum SRT, Maximum SRT and Average SRT.
695 Example: B<-z megaco,srt>
697 This option can be used multiple times on the command line.
699 If the optional I<filter> is provided, the stats will only be calculated
700 on those calls that match that filter.
702 Example: B<-z "megaco,srt,ip.addr==1.2.3.4"> will collect stats only for
703 MEGACO packets exchanged by the host at IP address 1.2.3.4 .
705 =item B<-z> conv,I<type>[,I<filter>]
707 Create a table that lists all conversations that could be seen in the
708 capture. I<type> specifies the conversation endpoint types for which we
709 want to generate the statistics; currently the supported ones are:
711 "eth" Ethernet addresses
712 "fc" Fibre Channel addresses
713 "fddi" FDDI addresses
715 "ipv6" IPv6 addresses
717 "tcp" TCP/IP socket pairs Both IPv4 and IPv6 are supported
718 "tr" Token Ring addresses
719 "udp" UDP/IP socket pairs Both IPv4 and IPv6 are supported
721 If the optional I<filter> is specified, only those packets that match the
722 filter will be used in the calculations.
724 The table is presented with one line for each conversation and displays
725 the number of packets/bytes in each direction as well as the total
726 number of packets/bytes. By default, the table is sorted according to
727 the total number of packets.
729 These tables can also be generated at runtime by selecting the appropriate
730 conversation type from the menu "Tools/Statistics/Conversation List/".
732 =item B<-z> h225,counter[I<,filter>]
734 Count ITU-T H.225 messages and their reasons. In the first column you get a
735 list of H.225 messages and H.225 message reasons which occur in the current
736 capture file. The number of occurrences of each message or reason is displayed
737 in the second column.
739 Example: B<-z h225,counter>
741 This option can be used multiple times on the command line.
743 If the optional I<filter> is provided, the stats will only be calculated
744 on those calls that match that filter.
746 Example: B<-z "h225,counter,ip.addr==1.2.3.4"> will collect stats only for
747 H.225 packets exchanged by the host at IP address 1.2.3.4 .
749 =item B<-z> h225,srt[I<,filter>]
751 Collect request/response SRT (Service Response Time) data for ITU-T H.225 RAS.
752 Data collected is the number of calls of each ITU-T H.225 RAS Message Type,
753 Minimum SRT, Maximum SRT, Average SRT, Minimum in Packet, and Maximum in Packet.
754 You will also get the number of Open Requests (Unresponded Requests),
755 Discarded Responses (Responses without matching request) and Duplicate Messages.
757 Example: B<-z h225,srt>
759 This option can be used multiple times on the command line.
761 If the optional I<filter> is provided, the stats will only be calculated
762 on those calls that match that filter.
764 Example: B<-z "h225,srt,ip.addr==1.2.3.4"> will collect stats only for
765 ITU-T H.225 RAS packets exchanged by the host at IP address 1.2.3.4 .
767 =item B<-z> sip,stat[I<,filter>]
769 This option will activate a counter for SIP messages. You will get the number
770 of occurrences of each SIP Method and of each SIP Status-Code. Additionally you
771 also get the number of resent SIP Messages (only for SIP over UDP).
773 Example: B<-z sip,stat>
775 This option can be used multiple times on the command line.
777 If the optional I<filter> is provided, the stats will only be calculated
778 on those calls that match that filter.
780 Example: B<-z "sip,stat,ip.addr==1.2.3.4"> will collect stats only for
781 SIP packets exchanged by the host at IP address 1.2.3.4 .
783 =item B<-z> voip,calls
785 This option will show a window that shows VoIP calls found in the capture file.
786 This is the same window shown as when you go to the Statistics Menu and choose
789 Example: B<-z voip,calls>
803 =item File:Open Recent
807 Merge another capture file to the currently loaded one. The I<File:Merge>
808 dialog box allows the merge "Prepended", "Chronologically" or "Appended",
809 relative to the already loaded one.
813 Open or close a capture file. The I<File:Open> dialog box
814 allows a filter to be specified; when the capture file is read, the
815 filter is applied to all packets read from the file, and packets not
816 matching the filter are discarded. The I<File:Open Recent> is a submenu
817 and will show a list of previously opened files.
823 Save the current capture, or the packets currently displayed from that
824 capture, to a file. Check boxes let you select whether to save all
825 packets, or just those that have passed the current display filter and/or
826 those that are currently marked, and an option menu lets you select (from
827 a list of file formats in which at particular capture, or the packets
828 currently displayed from that capture, can be saved), a file format in
831 =item File:File Set:List Files
833 Show a dialog box that lists all files of the file set matching the currently
834 loaded file. A file set is a compound of files resulting from a capture using
835 the "multiple files" / "ringbuffer" mode, recognizable by the filename pattern,
836 e.g.: Filename_00001_20050604101530.pcap.
838 =item File:File Set:Next File
840 =item File:File Set:Previous File
842 If the currently loaded file is part of a file set (see above), open the
843 next / previous file in that set.
847 Export captured data into an external format. Note: the data cannot be
848 imported back into Wireshark, so be sure to keep the capture file.
852 Print packet data from the current capture. You can select the range of
853 packets to be printed (which packets are printed), and the output format of
854 each packet (how each packet is printed). The output format will be similar
855 to the displayed values, so a summary line, the packet details view, and/or
856 the hex dump of the packet can be printed.
858 Printing options can be set with the I<Edit:Preferences> menu item, or in the
859 dialog box popped up by this menu item.
863 Exit the application.
865 =item Edit:Copy:Description
867 Copies the description of the selected field in the protocol tree to
870 =item Edit:Copy:Fieldname
872 Copies the fieldname of the selected field in the protocol tree to
875 =item Edit:Copy:Value
877 Copies the value of the selected field in the protocol tree to
880 =item Edit:Copy:As Filter
882 Create a display filter based on the data currently highlighted in the
883 packet details and copy that filter to the clipboard.
885 If that data is a field that can be tested in a display filter
886 expression, the display filter will test that field; otherwise, the
887 display filter will be based on the absolute offset within the packet.
888 Therefore it could be unreliable if the packet contains protocols with
889 variable-length headers, such as a source-routed token-ring packet.
891 =item Edit:Find Packet
893 Search forward or backward, starting with the currently selected packet
894 (or the most recently selected packet, if no packet is selected). Search
895 criteria can be a display filter expression, a string of hexadecimal
896 digits, or a text string.
898 When searching for a text string, you can search the packet data, or you
899 can search the text in the Info column in the packet list pane or in the
902 Hexadecimal digits can be separated by colons, periods, or dashes.
903 Text string searches can be ASCII or Unicode (or both), and may be
908 =item Edit:Find Previous
910 Search forward / backward for a packet matching the filter from the previous
911 search, starting with the currently selected packet (or the most recently
912 selected packet, if no packet is selected).
914 =item Edit:Mark Packet (toggle)
916 Mark (or unmark if currently marked) the selected packet. The field
917 "frame.marked" is set for packets that are marked, so that, for example,
918 a display filters can be used to display only marked packets, and so that
919 the L<Edit:Find Packet|/item_edit_3afind_packet> dialog can be used to find the next or previous
922 =item Edit:Find Next Mark
924 =item Edit:Find Previous Mark
926 Find next/previous marked packet.
928 =item Edit:Mark All Packets
930 =item Edit:Unmark All Packets
932 Mark / Unmark all packets that are currently displayed.
934 =item Edit:Time Reference:Set Time Reference (toggle)
936 Set (or unset if currently set) the selected packet as a Time Reference packet.
937 When a packet is set as a Time Reference packet, the timestamps in the packet
938 list pane will be replaced with the string "*REF*".
939 The relative time timestamp in later packets will then be calculated relative
940 to the timestamp of this Time Reference packet and not the first packet in
943 Packets that have been selected as Time Reference packets will always be
944 displayed in the packet list pane. Display filters will not affect or
947 If there is a column displayed for "Cumulative Bytes" this counter will
948 be reset at every Time Reference packet.
950 =item Edit:Time Reference:Find Next
952 =item Edit:Time Reference:Find Previous
954 Search forward / backward for a time referenced packet.
956 =item Edit:Configuration Profiles
958 Manage configuration profiles to be able to use more than one set of
959 preferences and configurations.
961 =item Edit:Preferences
963 Set the GUI, capture, printing and protocol options
964 (see L<Preferences|/item_preferences> dialog below).
966 =item View:Main Toolbar
968 =item View:Filter Toolbar
972 Show or hide the main window controls.
974 =item View:Packet List
976 =item View:Packet Details
978 =item View:Packet Bytes
980 Show or hide the main window panes.
982 =item View:Time Display Format
984 Set the format of the packet timestamp displayed in the packet list window.
986 =item View:Name Resolution:Resolve Name
988 Try to resolve a name for the currently selected item.
990 =item View:Name Resolution:Enable for ... Layer
992 Enable or disable translation of addresses to names in the display.
994 =item View:Colorize Packet List
996 Enable or disable the coloring rules. Disabling will improve performance.
998 =item View:Auto Scroll in Live Capture
1000 Enable or disable the automatic scrolling of the
1001 packet list while a live capture is in progress.
1007 Zoom into / out of the main window data (by changing the font size).
1009 =item View:Normal Size
1011 Reset the zoom factor of zoom in / zoom out back to normal font size.
1013 =item View:Resize All Columns
1015 Resize all columns to best fit the current packet display.
1017 =item View:Expand Subtrees
1019 Expands the currently selected item and it's subtrees in the packet details.
1021 =item View:Expand All
1023 =item View:Collapse All
1025 Expand / Collapse all branches of the packet details.
1027 =item View:Colorize Conversation
1029 Select color for a conversation.
1031 =item View:Reset Coloring 1-10
1033 Reset Color for a conversation.
1035 =item View:Coloring Rules
1037 Change the foreground and background colors of the packet information in
1038 the list of packets, based upon display filters. The list of display
1039 filters is applied to each packet sequentially. After the first display
1040 filter matches a packet, any additional display filters in the list are
1041 ignored. Therefore, if you are filtering on the existence of protocols,
1042 you should list the higher-level protocols first, and the lower-level
1047 =item How Colorization Works
1049 Packets are colored according to a list of color filters. Each filter
1050 consists of a name, a filter expression and a coloration. A packet is
1051 colored according to the first filter that it matches. Color filter
1052 expressions use exactly the same syntax as display filter expressions.
1054 When Wireshark starts, the color filters are loaded from:
1058 1. The user's personal color filters file or, if that does not exist,
1060 2. The global color filters file.
1064 If neither of these exist then the packets will not be colored.
1068 =item View:Show Packet In New Window
1070 Create a new window containing a packet details view and a hex dump
1071 window of the currently selected packet; this window will continue to
1072 display that packet's details and data even if another packet is
1077 Reload a capture file. Same as I<File:Close> and I<File:Open> the same
1082 Go back in previously visited packets history.
1086 Go forward in previously visited packets history.
1088 =item Go:Go To Packet
1090 Go to a particular numbered packet.
1092 =item Go:Go To Corresponding Packet
1094 If a field in the packet details pane containing a packet number is
1095 selected, go to the packet number specified by that field. (This works
1096 only if the dissector that put that entry into the packet details put it
1097 into the details as a filterable field rather than just as text.) This
1098 can be used, for example, to go to the packet for the request
1099 corresponding to a reply, or the reply corresponding to a request, if
1100 that packet number has been put into the packet details.
1102 =item Go:Previous Packet
1104 =item Go:Next Packet
1106 =item Go:First Packet
1108 =item Go:Last Packet
1110 Go to the previous / next / first / last packet in the capture.
1112 =item Capture:Interfaces
1114 Shows a dialog box with all currently known interfaces and displaying the
1115 current network traffic amount. Capture sessions can be started from here.
1116 Beware: keeping this box open results in high system load!
1118 =item Capture:Options
1120 Initiate a live packet capture (see L<Capture Options|/item_capture_options>
1121 dialog below). If no filename is specified, a temporary file will be created
1122 to hold the capture. The location of the file can be chosen by setting your
1123 TMPDIR environment variable before starting B<Wireshark>. Otherwise, the
1124 default TMPDIR location is system-dependent, but is likely either F</var/tmp>
1129 Start a live packet capture with the previously selected options. This won't
1130 open the options dialog box, and can be convenient for repeatedly capturing
1131 with the same options.
1135 Stop a running live capture.
1137 =item Capture:Restart
1139 While a live capture is running, stop it and restart with the same options
1140 again. This can be convenient to remove irrelevant packets, if no valuable
1141 packets were captured so far.
1143 =item Capture:Capture Filters
1145 Edit the saved list of capture filters, allowing filters to be added,
1146 changed, or deleted.
1148 =item Analyze:Display Filters
1150 Edit the saved list of display filters, allowing filters to be added,
1151 changed, or deleted.
1153 =item Analyze:Display Filter Macros
1155 Create shortcuts for complex macros
1157 =item Analyze:Apply as Filter
1159 Create a display filter based on the data currently highlighted in the
1160 packet details and apply the filter.
1162 If that data is a field that can be tested in a display filter
1163 expression, the display filter will test that field; otherwise, the
1164 display filter will be based on the absolute offset within the packet.
1165 Therefore it could be unreliable if the packet contains protocols with
1166 variable-length headers, such as a source-routed token-ring packet.
1168 The B<Selected> option creates a display filter that tests for a match
1169 of the data; the B<Not Selected> option creates a display filter that
1170 tests for a non-match of the data. The B<And Selected>, B<Or Selected>,
1171 B<And Not Selected>, and B<Or Not Selected> options add to the end of
1172 the display filter in the strip at the top (or bottom) an AND or OR
1173 operator followed by the new display filter expression.
1175 =item Analyze:Prepare a Filter
1177 Create a display filter based on the data currently highlighted in the
1178 packet details. The filter strip at the top (or bottom) is updated but
1179 it is not yet applied.
1181 =item Analyze:Enabled Protocols
1183 Allow protocol dissection to be enabled or disabled for a specific
1184 protocol. Individual protocols can be enabled or disabled by clicking
1185 on them in the list or by highlighting them and pressing the space bar.
1186 The entire list can be enabled, disabled, or inverted using the buttons
1189 When a protocol is disabled, dissection in a particular packet stops
1190 when that protocol is reached, and Wireshark moves on to the next packet.
1191 Any higher-layer protocols that would otherwise have been processed will
1192 not be displayed. For example, disabling TCP will prevent the dissection
1193 and display of TCP, HTTP, SMTP, Telnet, and any other protocol exclusively
1196 The list of protocols can be saved, so that Wireshark will start up with
1197 the protocols in that list disabled.
1199 =item Analyze:Decode As
1201 If you have a packet selected, present a dialog allowing you to change
1202 which dissectors are used to decode this packet. The dialog has one
1203 panel each for the link layer, network layer and transport layer
1204 protocol/port numbers, and will allow each of these to be changed
1205 independently. For example, if the selected packet is a TCP packet to
1206 port 12345, using this dialog you can instruct Wireshark to decode all
1207 packets to or from that TCP port as HTTP packets.
1209 =item Analyze:User Specified Decodes
1211 Create a new window showing whether any protocol ID to dissector
1212 mappings have been changed by the user. This window also allows the
1213 user to reset all decodes to their default values.
1215 =item Analyze:Follow TCP Stream
1217 If you have a TCP packet selected, display the contents of the data
1218 stream for the TCP connection to which that packet belongs, as text, in
1219 a separate window, and leave the list of packets in a filtered state,
1220 with only those packets that are part of that TCP connection being
1221 displayed. You can revert to your old view by pressing ENTER in the
1222 display filter text box, thereby invoking your old display filter (or
1223 resetting it back to no display filter).
1225 The window in which the data stream is displayed lets you select:
1231 whether to display the entire conversation, or one or the other side of
1236 whether the data being displayed is to be treated as ASCII or EBCDIC
1237 text or as raw hex data;
1241 and lets you print what's currently being displayed, using the same
1242 print options that are used for the I<File:Print Packet> menu item, or
1243 save it as text to a file.
1245 =item Analyze:Follow UDP Stream
1247 =item Analyze:Follow SSL Stream
1249 (Similar to Analyze:Follow TCP Stream)
1251 =item Analyze:Expert Info
1253 =item Analyze:Expert Info Composite
1255 (Kind of) a log of anomalies found by Wireshark in a capture file.
1257 =item Analyze:Conversation Filter
1259 =item Statistics:Summary
1261 Show summary information about the capture, including elapsed time,
1262 packet counts, byte counts, and the like. If a display filter is in
1263 effect, summary information will be shown about the capture and about
1264 the packets currently being displayed.
1266 =item Statistics:Protocol Hierarchy
1268 Show the number of packets, and the number of bytes in those packets,
1269 for each protocol in the trace. It organizes the protocols in the same
1270 hierarchy in which they were found in the trace. Besides counting the
1271 packets in which the protocol exists, a count is also made for packets
1272 in which the protocol is the last protocol in the stack. These
1273 last-protocol counts show you how many packets (and the byte count
1274 associated with those packets) B<ended> in a particular protocol. In
1275 the table, they are listed under "End Packets" and "End Bytes".
1277 =item Statistics:Conversations
1279 Lists of conversations; selectable by protocol. See Statistics:Conversation List below.
1281 =item Statistics:End Points
1283 List of End Point Addresses by protocol with packets/bytes/.... counts.
1285 =item Statistics:Packet Lengths
1287 Grouped counts of packet lengths (0-19 bytes, 20-39 bytes, ...)
1289 =item Statistics:IO Graphs
1291 Open a window where up to 5 graphs in different colors can be displayed
1292 to indicate number of packets or number of bytes per second for all packets
1293 matching the specified filter.
1294 By default only one graph will be displayed showing number of packets per second.
1296 The top part of the window contains the graphs and scales for the X and
1297 Y axis. If the graph is too long to fit inside the window there is a
1298 horizontal scrollbar below the drawing area that can scroll the graphs
1299 to the left or the right. The horizontal axis displays the time into
1300 the capture and the vertical axis will display the measured quantity at
1303 Below the drawing area and the scrollbar are the controls. On the
1304 bottom left there will be five similar sets of controls to control each
1305 individual graph such as "Display:<button>" which button will toggle
1306 that individual graph on/off. If <button> is ticked, the graph will be
1307 displayed. "Color:<color>" which is just a button to show which color
1308 will be used to draw that graph (color is only available in Gtk2
1309 version) and finally "Filter:<filter-text>" which can be used to specify
1310 a display filter for that particular graph.
1312 If filter-text is empty then all packets will be used to calculate the
1313 quantity for that graph. If filter-text is specified only those packets
1314 that match that display filter will be considered in the calculation of
1317 To the right of the 5 graph controls there are four menus to control
1318 global aspects of the draw area and graphs. The "Unit:" menu is used to
1319 control what to measure; "packets/tick", "bytes/tick" or "advanced..."
1321 packets/tick will measure the number of packets matching the (if
1322 specified) display filter for the graph in each measurement interval.
1324 bytes/tick will measure the total number of bytes in all packets matching
1325 the (if specified) display filter for the graph in each measurement
1328 advanced... see below
1330 "Tick interval:" specifies what measurement intervals to use. The
1331 default is 1 second and means that the data will be counted over 1
1334 "Pixels per tick:" specifies how many pixels wide each measurement
1335 interval will be in the drawing area. The default is 5 pixels per tick.
1337 "Y-scale:" controls the max value for the y-axis. Default value is
1338 "auto" which means that B<Wireshark> will try to adjust the maxvalue
1341 "advanced..." If Unit:advanced... is selected the window will display
1342 two more controls for each of the five graphs. One control will be a
1343 menu where the type of calculation can be selected from
1344 SUM,COUNT,MAX,MIN,AVG and LOAD, and one control, textbox, where the name of a
1345 single display filter field can be specified.
1347 The following restrictions apply to type and field combinations:
1349 SUM: available for all types of integers and will calculate the SUM of
1350 all occurrences of this field in the measurement interval. Note that
1351 some field can occur multiple times in the same packet and then all
1352 instances will be summed up. Example: 'tcp.len' which will count the
1353 amount of payload data transferred across TCP in each interval.
1355 COUNT: available for all field types. This will COUNT the number of times
1356 certain field occurs in each interval. Note that some fields
1357 may occur multiple times in each packet and if that is the case
1358 then each instance will be counted independently and COUNT
1359 will be greater than the number of packets.
1361 MAX: available for all integer and relative time fields. This will calculate
1362 the max seen integer/time value seen for the field during the interval.
1363 Example: 'smb.time' which will plot the maximum SMB response time.
1365 MIN: available for all integer and relative time fields. This will calculate
1366 the min seen integer/time value seen for the field during the interval.
1367 Example: 'smb.time' which will plot the minimum SMB response time.
1369 AVG: available for all integer and relative time fields.This will
1370 calculate the average seen integer/time value seen for the field during
1371 the interval. Example: 'smb.time' which will plot the average SMB
1374 LOAD: available only for relative time fields (response times).
1376 Example of advanced:
1377 Display how NFS response time MAX/MIN/AVG changes over time:
1381 filter:nfs&&rpc.time
1386 filter:nfs&&rpc.time
1391 filter:nfs&&rpc.time
1394 Example of advanced:
1395 Display how the average packet size from host a.b.c.d changes over time.
1399 filter:ip.addr==a.b.c.d&&frame.pkt_len
1400 Calc:AVG frame.pkt_len
1403 The LOAD io-stat type is very different from anything you have ever seen
1404 before! While the response times themselves as plotted by MIN,MAX,AVG are
1405 indications on the Server load (which affects the Server response time),
1406 the LOAD measurement measures the Client LOAD.
1407 What this measures is how much workload the client generates,
1408 i.e. how fast will the client issue new commands when the previous ones
1410 i.e. the level of concurrency the client can maintain.
1411 The higher the number, the more and faster is the client issuing new
1412 commands. When the LOAD goes down, it may be due to client load making
1413 the client slower in issuing new commands (there may be other reasons as
1414 well, maybe the client just doesn't have any commands it wants to issue
1417 Load is measured in concurrency/number of overlapping i/o and the value
1418 1000 means there is a constant load of one i/o.
1420 In each tick interval the amount of overlap is measured.
1421 See the graph below containing three commands:
1422 Below the graph are the LOAD values for each interval that would be calculated.
1426 | | o=====* | | | | | |
1428 | o========* | o============* | | |
1430 --------------------------------------------------> Time
1431 500 1500 500 750 1000 500 0 0
1433 =item Statistics:Conversation List
1435 This option will open a new window that displays a list of all
1436 conversations between two endpoints. The list has one row for each
1437 unique conversation and displays total number of packets/bytes seen as
1438 well as number of packets/bytes in each direction.
1440 By default the list is sorted according to the number of packets but by
1441 clicking on the column header; it is possible to re-sort the list in
1442 ascending or descending order by any column.
1444 By first selecting a conversation by clicking on it and then using the
1445 right mouse button (on those platforms that have a right
1446 mouse button) wireshark will display a popup menu offering several different
1447 filter operations to apply to the capture.
1449 These statistics windows can also be invoked from the Wireshark command
1450 line using the B<-z conv> argument.
1452 =item Statistics:Service Response Time
1468 Open a window to display Service Response Time statistics for an
1469 arbitrary DCE-RPC program
1470 interface and display B<Procedure>, B<Number of Calls>, B<Minimum SRT>,
1471 B<Maximum SRT> and B<Average SRT> for all procedures for that
1472 program/version. These windows opened will update in semi-real time to
1473 reflect changes when doing live captures or when reading new capture
1474 files into B<Wireshark>.
1476 This dialog will also allow an optional filter string to be used.
1477 If an optional filter string is used only such DCE-RPC request/response pairs
1478 that match that filter will be used to calculate the statistics. If no filter
1479 string is specified all request/response pairs will be used.
1489 Open a window to display Service Response Time statistics for Fibre Channel
1490 and display B<FC Type>, B<Number of Calls>, B<Minimum SRT>,
1491 B<Maximum SRT> and B<Average SRT> for all FC types.
1492 These windows opened will update in semi-real time to
1493 reflect changes when doing live captures or when reading new capture
1494 files into B<Wireshark>.
1495 The Service Response Time is calculated as the time delta between the
1496 First packet of the exchange and the Last packet of the exchange.
1498 This dialog will also allow an optional filter string to be used.
1499 If an optional filter string is used only such FC first/last exchange pairs
1500 that match that filter will be used to calculate the statistics. If no filter
1501 string is specified all request/response pairs will be used.
1511 Collect requests/response SRT (Service Response Time) data for ITU-T H.225 RAS.
1512 Data collected is B<number of calls> for each known ITU-T H.225 RAS Message Type,
1513 B<Minimum SRT>, B<Maximum SRT>, B<Average SRT>, B<Minimum in Packet>, and B<Maximum in Packet>.
1514 You will also get the number of B<Open Requests> (Unresponded Requests),
1515 B<Discarded Responses> (Responses without matching request) and Duplicate Messages.
1516 These windows opened will update in semi-real time to reflect changes when
1517 doing live captures or when reading new capture files into B<Wireshark>.
1519 You can apply an optional filter string in a dialog box, before starting
1520 the calculation. The statistics will only be calculated
1521 on those calls matching that filter.
1535 Collect requests/response SRT (Service Response Time) data for MGCP.
1536 Data collected is B<number of calls> for each known MGCP Type,
1537 B<Minimum SRT>, B<Maximum SRT>, B<Average SRT>, B<Minimum in Packet>, and B<Maximum in Packet>.
1538 These windows opened will update in semi-real time to reflect changes when
1539 doing live captures or when reading new capture files into B<Wireshark>.
1541 You can apply an optional filter string in a dialog box, before starting
1542 the calculation. The statistics will only be calculated
1543 on those calls matching that filter.
1553 Open a window to display statistics for an arbitrary ONC-RPC program interface
1554 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.
1555 These windows opened will update in semi-real time to reflect changes when
1556 doing live captures or when reading new capture files into B<Wireshark>.
1558 This dialog will also allow an optional filter string to be used.
1559 If an optional filter string is used only such ONC-RPC request/response pairs
1560 that match that filter will be used to calculate the statistics. If no filter
1561 string is specified all request/response pairs will be used.
1563 By first selecting a conversation by clicking on it and then using the
1564 right mouse button (on those platforms that have a right
1565 mouse button) wireshark will display a popup menu offering several different
1566 filter operations to apply to the capture.
1580 Collect call/reply SRT (Service Response Time) data for SMB. Data collected
1581 is the number of calls for each SMB command, MinSRT, MaxSRT and AvgSRT.
1583 The data will be presented as separate tables for all normal SMB commands,
1584 all Transaction2 commands and all NT Transaction commands.
1585 Only those commands that are seen in the capture will have its stats
1587 Only the first command in a xAndX command chain will be used in the
1588 calculation. So for common SessionSetupAndX + TreeConnectAndX chains,
1589 only the SessionSetupAndX call will be used in the statistics.
1590 This is a flaw that might be fixed in the future.
1592 You can apply an optional filter string in a dialog box, before starting
1593 the calculation. The stats will only be calculated
1594 on those calls matching that filter.
1596 By first selecting a conversation by clicking on it and then using the
1597 right mouse button (on those platforms that have a right
1598 mouse button) wireshark will display a popup menu offering several different
1599 filter operations to apply to the capture.
1607 =item Statistics:BOOTP-DHCP
1611 =item Statistics:Compare
1613 Compare two Capture Files
1615 =item Statistics:Flow Graph
1617 Flow Graph: General/TCP
1619 =item Statistics:HTTP
1621 HTTP Load Distribution, Packet Counter & Requests
1623 =item Statistics:IP Addresses
1625 Count/Rate/Percent by IP Address
1627 =item Statistics:IP Destinations
1629 Count/Rate/Percent by IP Address/protocol/port
1631 =item Statistics:IP Protocol Types
1633 Count/Rate/Percent by IP Protocol Types
1635 =item Statistics:ONC-RPC Programs
1637 This dialog will open a window showing aggregated RTT statistics for all
1638 ONC-RPC Programs/versions that exist in the capture file.
1640 =item Statistics:TCP Stream Graph
1642 Graphs: Round Trip; Throughput; Time-Sequence (Stevens); Time-Sequence (tcptrace)
1644 =item Statistics:UDP Multicast streams
1646 Multicast Streams Counts/Rates/... by Source/Destination Address/Port pairs
1648 =item Statistics:WLAN Traffic
1650 WLAN Traffic Statistics
1652 =item Telephony:ITU-T H.225
1654 Count ITU-T H.225 messages and their reasons. In the first column you get a
1655 list of H.225 messages and H.225 message reasons, which occur in the current
1656 capture file. The number of occurrences of each message or reason will be displayed
1657 in the second column.
1658 This window opened will update in semi-real time to reflect changes when
1659 doing live captures or when reading new capture files into B<Wireshark>.
1661 You can apply an optional filter string in a dialog box, before starting
1662 the counter. The statistics will only be calculated
1663 on those calls matching that filter.
1667 Activate a counter for SIP messages. You will get the number of occurrences of each
1668 SIP Method and of each SIP Status-Code. Additionally you also get the number of
1669 resent SIP Messages (only for SIP over UDP).
1671 This window opened will update in semi-real time to reflect changes when
1672 doing live captures or when reading new capture files into B<Wireshark>.
1674 You can apply an optional filter string in a dialog box, before starting
1675 the counter. The statistics will only be calculated
1676 on those calls matching that filter.
1678 =item Tools:Firewall ACL Rules
1686 =item Help:Supported Protocols
1688 List of supported protocols and display filter protocol fields.
1690 =item Help:Manual Pages
1692 Display locally installed HTML versions of these manual pages in a web browser.
1694 =item Help:Wireshark Online
1696 Various links to online resources to be open in a web browser, like
1697 L<http://www.wireshark.org>.
1699 =item Help:About Wireshark
1701 See various information about Wireshark (see L<About|/item_about> dialog below), like the
1702 version, the folders used, the available plugins, ...
1712 The main window contains the usual things like the menu, some toolbars, the
1713 main area and a statusbar. The main area is split into three panes, you can
1714 resize each pane using a "thumb" at the right end of each divider line.
1716 The main window is much more flexible than before. The layout of the main
1717 window can be customized by the I<Layout> page in the dialog box popped
1718 up by I<Edit:Preferences>, the following will describe the layout with the
1725 Some menu items are available for quick access here. There is no way to
1726 customize the items in the toolbar, however the toolbar can be hidden by
1727 I<View:Main Toolbar>.
1729 =item Filter Toolbar
1731 A display filter can be entered into the filter toolbar.
1732 A filter for HTTP, HTTPS, and DNS traffic might look like this:
1734 tcp.port == 80 || tcp.port == 443 || tcp.port == 53
1736 Selecting the I<Filter:> button lets you choose from a list of named
1737 filters that you can optionally save. Pressing the Return or Enter
1738 keys, or selecting the I<Apply> button, will cause the filter to be
1739 applied to the current list of packets. Selecting the I<Reset> button
1740 clears the display filter so that all packets are displayed (again).
1742 There is no way to customize the items in the toolbar, however the toolbar
1743 can be hidden by I<View:Filter Toolbar>.
1745 =item Packet List Pane
1747 The top pane contains the list of network packets that you can scroll
1748 through and select. By default, the packet number, packet timestamp,
1749 source and destination addresses, protocol, and description are
1750 displayed for each packet; the I<Columns> page in the dialog box popped
1751 up by I<Edit:Preferences> lets you change this (although, unfortunately,
1752 you currently have to save the preferences, and exit and restart
1753 Wireshark, for those changes to take effect).
1755 If you click on the heading for a column, the display will be sorted by
1756 that column; clicking on the heading again will reverse the sort order
1759 An effort is made to display information as high up the protocol stack
1760 as possible, e.g. IP addresses are displayed for IP packets, but the
1761 MAC layer address is displayed for unknown packet types.
1763 The right mouse button can be used to pop up a menu of operations.
1765 The middle mouse button can be used to mark a packet.
1767 =item Packet Details Pane
1769 The middle pane contains a display of the details of the
1770 currently-selected packet. The display shows each field and its value
1771 in each protocol header in the stack. The right mouse button can be
1772 used to pop up a menu of operations.
1774 =item Packet Bytes Pane
1776 The lowest pane contains a hex and ASCII dump of the actual packet data.
1777 Selecting a field in the packet details highlights the corresponding
1778 bytes in this section.
1780 The right mouse button can be used to pop up a menu of operations.
1784 The statusbar is divided into three parts, on the left some context dependent
1785 things are shown, like information about the loaded file, in the center the
1786 number of packets are displayed, and on the right the current configuration
1789 The statusbar can be hidden by I<View:Statusbar>.
1795 The I<Preferences> dialog lets you control various personal preferences
1796 for the behavior of B<Wireshark>.
1800 =item User Interface Preferences
1802 The I<User Interface> page is used to modify small aspects of the GUI to
1803 your own personal taste:
1807 =item Selection Bars
1809 The selection bar in the packet list and packet details can have either
1810 a "browse" or "select" behavior. If the selection bar has a "browse"
1811 behavior, the arrow keys will move an outline of the selection bar,
1812 allowing you to browse the rest of the list or details without changing
1813 the selection until you press the space bar. If the selection bar has a
1814 "select" behavior, the arrow keys will move the selection bar and change
1815 the selection to the new item in the packet list or packet details.
1817 =item Save Window Position
1819 If this item is selected, the position of the main Wireshark window will
1820 be saved when Wireshark exits, and used when Wireshark is started again.
1822 =item Save Window Size
1824 If this item is selected, the size of the main Wireshark window will
1825 be saved when Wireshark exits, and used when Wireshark is started again.
1827 =item Save Window Maximized state
1829 If this item is selected the maximize state of the main Wireshark window
1830 will be saved when Wireshark exists, and used when Wireshark is started again.
1832 =item File Open Dialog Behavior
1834 This item allows the user to select how Wireshark handles the listing
1835 of the "File Open" Dialog when opening trace files. "Remember Last
1836 Directory" causes Wireshark to automatically position the dialog in the
1837 directory of the most recently opened file, even between launches of Wireshark.
1838 "Always Open in Directory" allows the user to define a persistent directory
1839 that the dialog will always default to.
1843 Allows the user to specify a persistent File Open directory. Trailing
1844 slashes or backslashes will automatically be added.
1846 =item File Open Preview timeout
1848 This items allows the user to define how much time is spend reading the
1849 capture file to present preview data in the File Open dialog.
1851 =item Open Recent maximum list entries
1853 The File menu supports a recent file list. This items allows the user to
1854 specify how many files are kept track of in this list.
1856 =item Ask for unsaved capture files
1858 When closing a capture file or Wireshark itself if the file isn't saved yet
1859 the user is presented the option to save the file when this item is set.
1861 =item Wrap during find
1863 This items determines the behavior when reaching the beginning or the end
1864 of a capture file. When set the search wraps around and continues, otherwise
1867 =item Settings dialogs show a save button
1869 This item determines if the various dialogs sport an explicit Save button
1870 or that save is implicit in OK / Apply.
1872 =item Web browser command
1874 This entry specifies the command line to launch a web browser. It is used
1875 to access online content, like the Wiki and user guide. Use '%s' to place
1876 the request URL in the command line.
1880 =item Layout Preferences
1882 The I<Layout> page lets you specify the general layout of the main window.
1883 You can choose from six different layouts and fill the three panes with the
1890 The vertical scrollbars in the three panes can be set to be either on
1891 the left or the right.
1893 =item Alternating row colors
1897 The highlight method in the hex dump display for the selected protocol
1898 item can be set to use either inverse video, or bold characters.
1902 =item Filter toolbar placement
1904 =item Custom window title
1908 =item Column Preferences
1910 The I<Columns> page lets you specify the number, title, and format
1911 of each column in the packet list.
1913 The I<Column title> entry is used to specify the title of the column
1914 displayed at the top of the packet list. The type of data that the column
1915 displays can be specified using the I<Column format> option menu.
1916 The row of buttons on the left perform the following actions:
1922 Adds a new column to the list.
1926 Deletes the currently selected list item.
1930 Moves the selected list item up or down one position.
1934 =item Font Preferences
1936 The I<Font> page lets you select the font to be used for most text.
1938 =item Color Preferences
1940 The I<Colors> page can be used to change the color of the text
1941 displayed in the TCP stream window and for marked packets. To change a color,
1942 simply select an attribute from the "Set:" menu and use the color selector to
1943 get the desired color. The new text colors are displayed as a sample text.
1945 =item Capture Preferences
1947 The I<Capture> page lets you specify various parameters for capturing
1948 live packet data; these are used the first time a capture is started.
1950 The I<Interface:> combo box lets you specify the interface from which to
1951 capture packet data, or the name of a FIFO from which to get the packet
1954 The I<Data link type:> option menu lets you, for some interfaces, select
1955 the data link header you want to see on the packets you capture. For
1956 example, in some OSes and with some versions of libpcap, you can choose,
1957 on an 802.11 interface, whether the packets should appear as Ethernet
1958 packets (with a fake Ethernet header) or as 802.11 packets.
1960 The I<Limit each packet to ... bytes> check box lets you set the
1961 snapshot length to use when capturing live data; turn on the check box,
1962 and then set the number of bytes to use as the snapshot length.
1964 The I<Filter:> text entry lets you set a capture filter expression to be
1965 used when capturing.
1967 If any of the environment variables SSH_CONNECTION, SSH_CLIENT,
1968 REMOTEHOST, DISPLAY, or SESSIONNAME are set, Wireshark will create a
1969 default capture filter that excludes traffic from the hosts and ports
1970 defined in those variables.
1972 The I<Capture packets in promiscuous mode> check box lets you specify
1973 whether to put the interface in promiscuous mode when capturing.
1975 The I<Update list of packets in real time> check box lets you specify
1976 that the display should be updated as packets are seen.
1978 The I<Automatic scrolling in live capture> check box lets you specify
1979 whether, in an "Update list of packets in real time" capture, the packet
1980 list pane should automatically scroll to show the most recently captured
1983 =item Printing Preferences
1985 The radio buttons at the top of the I<Printing> page allow you choose
1986 between printing packets with the I<File:Print Packet> menu item as text
1987 or PostScript, and sending the output directly to a command or saving it
1988 to a file. The I<Command:> text entry box, on UNIX-compatible systems,
1989 is the command to send files to (usually B<lpr>), and the I<File:> entry
1990 box lets you enter the name of the file you wish to save to.
1991 Additionally, you can select the I<File:> button to browse the file
1992 system for a particular save file.
1994 =item Name Resolution Preferences
1996 The I<Enable MAC name resolution>, I<Enable network name resolution> and
1997 I<Enable transport name resolution> check boxes let you specify whether
1998 MAC addresses, network addresses, and transport-layer port numbers
1999 should be translated to names.
2001 The I<Enable concurrent DNS name resolution> allows Wireshark to send out
2002 multiple name resolution requests and not wait for the result before
2003 continuing dissection. This speeds up dissection with network name
2004 resolution but initially may miss resolutions. The number of concurrent
2005 requests can be set here as well.
2011 =item RTP Player Preferences
2013 This page allows you to select the number of channels visible in the
2014 RTP player window. It determines the height of the window, more channels
2015 are possible and visible by means of a scroll bar.
2017 =item Protocol Preferences
2019 There are also pages for various protocols that Wireshark dissects,
2020 controlling the way Wireshark handles those protocols.
2024 =item Edit Capture Filter List
2026 =item Edit Display Filter List
2028 =item Capture Filter
2030 =item Display Filter
2036 The I<Edit Capture Filter List> dialog lets you create, modify, and
2037 delete capture filters, and the I<Edit Display Filter List> dialog lets
2038 you create, modify, and delete display filters.
2040 The I<Capture Filter> dialog lets you do all of the editing operations
2041 listed, and also lets you choose or construct a filter to be used when
2044 The I<Display Filter> dialog lets you do all of the editing operations
2045 listed, and also lets you choose or construct a filter to be used to
2046 filter the current capture being viewed.
2048 The I<Read Filter> dialog lets you do all of the editing operations
2049 listed, and also lets you choose or construct a filter to be used to
2050 as a read filter for a capture file you open.
2052 The I<Search Filter> dialog lets you do all of the editing operations
2053 listed, and also lets you choose or construct a filter expression to be
2054 used in a find operation.
2056 In all of those dialogs, the I<Filter name> entry specifies a
2057 descriptive name for a filter, e.g. B<Web and DNS traffic>. The
2058 I<Filter string> entry is the text that actually describes the filtering
2059 action to take, as described above.The dialog buttons perform the
2066 If there is text in the two entry boxes, creates a new associated list
2071 Modifies the currently selected list item to match what's in the entry
2076 Deletes the currently selected list item.
2078 =item Add Expression...
2080 For display filter expressions, pops up a dialog box to allow you to
2081 construct a filter expression to test a particular field; it offers
2082 lists of field names, and, when appropriate, lists from which to select
2083 tests to perform on the field and values with which to compare it. In
2084 that dialog box, the OK button will cause the filter expression you
2085 constructed to be entered into the I<Filter string> entry at the current
2090 In the I<Capture Filter> dialog, closes the dialog box and makes the
2091 filter in the I<Filter string> entry the filter in the I<Capture
2092 Preferences> dialog. In the I<Display Filter> dialog, closes the dialog
2093 box and makes the filter in the I<Filter string> entry the current
2094 display filter, and applies it to the current capture. In the I<Read
2095 Filter> dialog, closes the dialog box and makes the filter in the
2096 I<Filter string> entry the filter in the I<Open Capture File> dialog.
2097 In the I<Search Filter> dialog, closes the dialog box and makes the
2098 filter in the I<Filter string> entry the filter in the I<Find Packet>
2103 Makes the filter in the I<Filter string> entry the current display
2104 filter, and applies it to the current capture.
2108 If the list of filters being edited is the list of
2109 capture filters, saves the current filter list to the personal capture
2110 filters file, and if the list of filters being edited is the list of
2111 display filters, saves the current filter list to the personal display
2116 Closes the dialog without doing anything with the filter in the I<Filter
2121 =item The Color Filters Dialog
2123 This dialog displays a list of color filters and allows it to be
2128 =item THE FILTER LIST
2130 Single rows may be selected by clicking. Multiple rows may be selected
2131 by using the ctrl and shift keys in combination with the mouse button.
2135 Adds a new filter at the bottom of the list and opens the Edit Color
2136 Filter dialog box. You will have to alter the filter expression at
2137 least before the filter will be accepted. The format of color filter
2138 expressions is identical to that of display filters. The new filter is
2139 selected, so it may immediately be moved up and down, deleted or edited.
2140 To avoid confusion all filters are unselected before the new filter is
2145 Opens the Edit Color Filter dialog box for the selected filter. (If this
2146 button is disabled you may have more than one filter selected, making it
2147 ambiguous which is to be edited.)
2151 Enables the selected color filter(s).
2155 Disables the selected color filter(s).
2159 Deletes the selected color filter(s).
2163 Allows you to choose a file in which to save the current list of color
2164 filters. You may also choose to save only the selected filters. A
2165 button is provided to save the filters in the global color filters file
2166 (you must have sufficient permissions to write this file, of course).
2170 Allows you to choose a file containing color filters which are then
2171 added to the bottom of the current list. All the added filters are
2172 selected, so they may be moved to the correct position in the list as a
2173 group. To avoid confusion, all filters are unselected before the new
2174 filters are imported. A button is provided to load the filters from the
2175 global color filters file.
2179 Deletes your personal color filters file, reloads the global
2180 color filters file, if any, and closes the dialog.
2184 Moves the selected filter(s) up the list, making it more likely that
2185 they will be used to color packets.
2189 Moves the selected filter(s) down the list, making it less likely that
2190 they will be used to color packets.
2194 Closes the dialog and uses the color filters as they stand.
2198 Colors the packets according to the current list of color filters, but
2199 does not close the dialog.
2203 Saves the current list of color filters in your personal color filters
2204 file. Unless you do this they will not be used the next time you start
2209 Closes the dialog without changing the coloration of the packets. Note
2210 that changes you have made to the current list of color filters are not
2215 =item Capture Options
2217 The I<Capture Options> dialog lets you specify various parameters for
2218 capturing live packet data.
2220 The I<Interface:> field lets you specify the interface from which to
2221 capture packet data or a command from which to get the packet data via a
2224 The I<Link layer header type:> field lets you specify the interfaces link
2225 layer header type. This field is usually disabled, as most interface have
2226 only one header type.
2228 The I<Capture packets in promiscuous mode> check box lets you specify
2229 whether the interface should be put into promiscuous mode when
2232 The I<Limit each packet to ... bytes> check box and field lets you
2233 specify a maximum number of bytes per packet to capture and save; if the
2234 check box is not checked, the limit will be 65535 bytes.
2236 The I<Capture Filter:> entry lets you specify the capture filter using a
2237 tcpdump-style filter string as described above.
2239 The I<File:> entry lets you specify the file into which captured packets
2240 should be saved, as in the I<Printer Options> dialog above. If not
2241 specified, the captured packets will be saved in a temporary file; you
2242 can save those packets to a file with the I<File:Save As> menu item.
2244 The I<Use multiple files> check box lets you specify that the capture
2245 should be done in "multiple files" mode. This option is disabled, if the
2246 I<Update list of packets in real time> option is checked.
2248 The I<Next file every ... megabyte(s)> check box and fields lets
2249 you specify that a switch to a next file should be done
2250 if the specified filesize is reached. You can also select the appropriate
2251 unit, but beware that the filesize has a maximum of 2 GB.
2252 The check box is forced to be checked, as "multiple files" mode requires a
2253 file size to be specified.
2255 The I<Next file every ... minute(s)> check box and fields lets
2256 you specify that the switch to a next file should be done after the specified
2257 time has elapsed, even if the specified capture size is not reached.
2259 The I<Ring buffer with ... files> field lets you specify the number
2260 of files of a ring buffer. This feature will capture into to the first file
2261 again, after the specified amount of files were used.
2263 The I<Stop capture after ... files> field lets you specify the number
2264 of capture files used, until the capture is stopped.
2266 The I<Stop capture after ... packet(s)> check box and field let
2267 you specify that Wireshark should stop capturing after having captured
2268 some number of packets; if the check box is not checked, Wireshark will
2269 not stop capturing at some fixed number of captured packets.
2271 The I<Stop capture after ... megabyte(s)> check box and field lets
2272 you specify that Wireshark should stop capturing after the file to which
2273 captured packets are being saved grows as large as or larger than some
2274 specified number of megabytes. If the check box is not checked, Wireshark
2275 will not stop capturing at some capture file size (although the operating
2276 system on which Wireshark is running, or the available disk space, may still
2277 limit the maximum size of a capture file). This option is disabled, if
2278 "multiple files" mode is used,
2280 The I<Stop capture after ... second(s)> check box and field let you
2281 specify that Wireshark should stop capturing after it has been capturing
2282 for some number of seconds; if the check box is not checked, Wireshark
2283 will not stop capturing after some fixed time has elapsed.
2285 The I<Update list of packets in real time> check box lets you specify
2286 whether the display should be updated as packets are captured and, if
2287 you specify that, the I<Automatic scrolling in live capture> check box
2288 lets you specify the packet list pane should automatically scroll to
2289 show the most recently captured packets as new packets arrive.
2291 The I<Enable MAC name resolution>, I<Enable network name resolution> and
2292 I<Enable transport name resolution> check boxes let you specify whether
2293 MAC addresses, network addresses, and transport-layer port numbers
2294 should be translated to names.
2298 The I<About> dialog lets you view various information about Wireshark.
2300 =item About:Wireshark
2302 The I<Wireshark> page lets you view general information about Wireshark,
2303 like the installed version, licensing information and such.
2307 The I<Authors> page shows the author and all contributors.
2311 The I<Folders> page lets you view the directory names where Wireshark is
2312 searching it's various configuration and other files.
2316 The I<Plugins> page lets you view the dissector plugin modules
2317 available on your system.
2319 The I<Plugins List> shows the name and version of each dissector plugin
2320 module found on your system.
2322 On Unix-compatible systems, the plugins are looked for in the following
2323 directories: the F<lib/wireshark/plugins/$VERSION> directory under the
2324 main installation directory (for example,
2325 F</usr/local/lib/wireshark/plugins/$VERSION>), and then
2326 F<$HOME/.wireshark/plugins>.
2328 On Windows systems, the plugins are looked for in the following
2329 directories: F<plugins\$VERSION> directory under the main installation
2330 directory (for example, F<C:\Program Files\Wireshark\plugins\$VERSION>),
2331 and then F<%APPDATA%\Wireshark\plugins\$VERSION> (or, if %APPDATA% isn't
2332 defined, F<%USERPROFILE%\Application Data\Wireshark\plugins\$VERSION>).
2334 $VERSION is the version number of the plugin interface, which
2335 is typically the version number of Wireshark. Note that a dissector
2336 plugin module may support more than one protocol; there is not
2337 necessarily a one-to-one correspondence between dissector plugin modules
2338 and protocols. Protocols supported by a dissector plugin module are
2339 enabled and disabled using the I<Edit:Protocols> dialog box, just as
2340 protocols built into Wireshark are.
2344 =head1 CAPTURE FILTER SYNTAX
2346 See the manual page of pcap-filter(4) or, if that doesn't exist, tcpdump(8),
2347 or, if that doesn't exist, L<http://wiki.wireshark.org/CaptureFilters>.
2349 =head1 DISPLAY FILTER SYNTAX
2351 For a complete table of protocol and protocol fields that are filterable
2352 in B<Wireshark> see the wireshark-filter(4) manual page.
2356 These files contains various B<Wireshark> configuration settings.
2362 The F<preferences> files contain global (system-wide) and personal
2363 preference settings. If the system-wide preference file exists, it is
2364 read first, overriding the default settings. If the personal preferences
2365 file exists, it is read next, overriding any previous values. Note: If
2366 the command line flag B<-o> is used (possibly more than once), it will
2367 in turn override values from the preferences files.
2369 The preferences settings are in the form I<prefname>B<:>I<value>,
2371 where I<prefname> is the name of the preference
2372 and I<value> is the value to
2373 which it should be set; white space is allowed between B<:> and
2374 I<value>. A preference setting can be continued on subsequent lines by
2375 indenting the continuation lines with white space. A B<#> character
2376 starts a comment that runs to the end of the line:
2378 # Vertical scrollbars should be on right side?
2379 # TRUE or FALSE (case-insensitive).
2380 gui.scrollbar_on_right: TRUE
2382 The global preferences file is looked for in the F<wireshark> directory
2383 under the F<share> subdirectory of the main installation directory (for
2384 example, F</usr/local/share/wireshark/preferences>) on UNIX-compatible
2385 systems, and in the main installation directory (for example,
2386 F<C:\Program Files\Wireshark\preferences>) on Windows systems.
2388 The personal preferences file is looked for in F<$HOME/.wireshark/preferences> on
2389 UNIX-compatible systems and F<%APPDATA%\Wireshark\preferences> (or, if
2390 %APPDATA% isn't defined, F<%USERPROFILE%\Application
2391 Data\Wireshark\preferences>) on Windows systems.
2393 Note: Whenever the preferences are saved by using the I<Save> button
2394 in the I<Edit:Preferences> dialog box, your personal preferences file
2395 will be overwritten with the new settings, destroying any comments and
2396 unknown/obsolete settings that were in the file.
2400 The F<recent> file contains personal settings (mostly GUI related) such
2401 as the current B<Wireshark> window size. The file is saved at program exit and
2402 read in at program start automatically. Note: The command line flag B<-o>
2403 may be used to override settings from this file.
2405 The settings in this file have the same format as in the F<preferences>
2406 files, and the same directory as for the personal preferences file is
2409 Note: Whenever Wireshark is closed, your recent file
2410 will be overwritten with the new settings, destroying any comments and
2411 unknown/obsolete settings that were in the file.
2413 =item Disabled (Enabled) Protocols
2415 The F<disabled_protos> files contain system-wide and personal lists of
2416 protocols that have been disabled, so that their dissectors are never
2417 called. The files contain protocol names, one per line, where the
2418 protocol name is the same name that would be used in a display filter
2424 If a protocol is listed in the global F<disabled_protos> file, it is not
2425 displayed in the I<Analyze:Enabled Protocols> dialog box, and so cannot
2426 be enabled by the user.
2428 The global F<disabled_protos> file uses the same directory as the global
2431 The personal F<disabled_protos> file uses the same directory as the
2432 personal preferences file.
2434 Note: Whenever the disabled protocols list is saved by using the I<Save>
2435 button in the I<Analyze:Enabled Protocols> dialog box, your personal
2436 disabled protocols file will be overwritten with the new settings,
2437 destroying any comments that were in the file.
2439 =item Name Resolution (hosts)
2441 If the personal F<hosts> file exists, it is
2442 used to resolve IPv4 and IPv6 addresses before any other
2443 attempts are made to resolve them. The file has the standard F<hosts>
2444 file syntax; each line contains one IP address and name, separated by
2445 whitespace. The same directory as for the personal preferences file is used.
2447 Capture filter name resolution is handled by libpcap on UNIX-compatible
2448 systems and WinPCAP on Windows. As such the Wireshark personal F<hosts> file
2449 will not be consulted for capture filter name resolution.
2451 =item Name Resolution (ethers)
2453 The F<ethers> files are consulted to correlate 6-byte hardware addresses to
2454 names. First the personal F<ethers> file is tried and if an address is not
2455 found there the global F<ethers> file is tried next.
2457 Each line contains one hardware address and name, separated by
2458 whitespace. The digits of the hardware address are separated by colons
2459 (:), dashes (-) or periods (.). The same separator character must be
2460 used consistently in an address. The following three lines are valid
2461 lines of an F<ethers> file:
2463 ff:ff:ff:ff:ff:ff Broadcast
2464 c0-00-ff-ff-ff-ff TR_broadcast
2465 00.00.00.00.00.00 Zero_broadcast
2467 The global F<ethers> file is looked for in the F</etc> directory on
2468 UNIX-compatible systems, and in the main installation directory (for
2469 example, F<C:\Program Files\Wireshark>) on Windows systems.
2471 The personal F<ethers> file is looked for in the same directory as the personal
2474 Capture filter name resolution is handled by libpcap on UNIX-compatible
2475 systems and WinPCAP on Windows. As such the Wireshark personal F<ethers> file
2476 will not be consulted for capture filter name resolution.
2478 =item Name Resolution (manuf)
2480 The F<manuf> file is used to match the 3-byte vendor portion of a 6-byte
2481 hardware address with the manufacturer's name; it can also contain well-known
2482 MAC addresses and address ranges specified with a netmask. The format of the
2483 file is the same as the F<ethers> files, except that entries such as:
2487 can be provided, with the 3-byte OUI and the name for a vendor, and
2490 00-00-0C-07-AC/40 All-HSRP-routers
2492 can be specified, with a MAC address and a mask indicating how many bits
2493 of the address must match. The above entry, for example, has 40
2494 significant bits, or 5 bytes, and would match addresses from
2495 00-00-0C-07-AC-00 through 00-00-0C-07-AC-FF. The mask need not be a
2498 The F<manuf> file is looked for in the same directory as the global
2501 =item Name Resolution (ipxnets)
2503 The F<ipxnets> files are used to correlate 4-byte IPX network numbers to
2504 names. First the global F<ipxnets> file is tried and if that address is not
2505 found there the personal one is tried next.
2507 The format is the same as the F<ethers>
2508 file, except that each address is four bytes instead of six.
2509 Additionally, the address can be represented as a single hexadecimal
2510 number, as is more common in the IPX world, rather than four hex octets.
2511 For example, these four lines are valid lines of an F<ipxnets> file:
2515 00:00:BE:EF IT_Server1
2518 The global F<ipxnets> file is looked for in the F</etc> directory on
2519 UNIX-compatible systems, and in the main installation directory (for
2520 example, F<C:\Program Files\Wireshark>) on Windows systems.
2522 The personal F<ipxnets> file is looked for in the same directory as the
2523 personal preferences file.
2525 =item Capture Filters
2527 The F<cfilters> files contain system-wide and personal capture filters.
2528 Each line contains one filter, starting with the string displayed in the
2529 dialog box in quotation marks, followed by the filter string itself:
2534 The global F<cfilters> file uses the same directory as the
2535 global preferences file.
2537 The personal F<cfilters> file uses the same directory as the personal
2538 preferences file. It is written through the Capture:Capture Filters
2541 If the global F<cfilters> file exists, it is used only if the personal
2542 F<cfilters> file does not exist; global and personal capture filters are
2545 =item Display Filters
2547 The F<dfilters> files contain system-wide and personal display filters.
2548 Each line contains one filter, starting with the string displayed in the
2549 dialog box in quotation marks, followed by the filter string itself:
2554 The global F<dfilters> file uses the same directory as the
2555 global preferences file.
2557 The personal F<dfilters> file uses the same directory as the
2558 personal preferences file. It is written through the Analyze:Display
2561 If the global F<dfilters> file exists, it is used only if the personal
2562 F<dfilters> file does not exist; global and personal display filters are
2565 =item Color Filters (Coloring Rules)
2567 The F<colorfilters> files contain system-wide and personal color filters.
2568 Each line contains one filter, starting with the string displayed in the
2569 dialog box, followed by the corresponding display filter. Then the
2570 background and foreground colors are appended:
2573 @tcp@tcp@[59345,58980,65534][0,0,0]
2574 @udp@udp@[28834,57427,65533][0,0,0]
2576 The global F<colorfilters> file uses the same directory as the
2577 global preferences file.
2579 The personal F<colorfilters> file uses the same directory as the
2580 personal preferences file. It is written through the View:Coloring Rules
2583 If the global F<colorfilters> file exists, it is used only if the personal
2584 F<colorfilters> file does not exist; global and personal color filters are
2589 The F<gtkrc> files contain system-wide and personal GTK theme settings.
2591 The global F<gtkrc> file uses the same directory as the
2592 global preferences file.
2594 The personal F<gtkrc> file uses the same directory as the personal
2599 See above in the description of the About:Plugins page.
2603 =head1 ENVIRONMENT VARIABLES
2607 =item WIRESHARK_DEBUG_EP_NO_CHUNKS
2609 Normally per-packet memory is allocated in large "chunks." This behavior
2610 doesn't work well with debugging tools such as Valgrind or ElectricFence.
2611 Export this environment variable to force individual allocations.
2612 Note: disabling chunks also disables canaries (see below).
2614 =item WIRESHARK_DEBUG_SE_NO_CHUNKS
2616 Normally per-file memory is allocated in large "chunks." This behavior
2617 doesn't work well with debugging tools such as Valgrind or ElectricFence.
2618 Export this environment variable to force individual allocations.
2619 Note: disabling chunks also disables canaries (see below).
2621 =item WIRESHARK_DEBUG_EP_NO_CANARY
2623 Normally per-packet memory allocations are separated by "canaries" which
2624 allow detection of memory overruns. This comes at the expense of some extra
2625 memory usage. Exporting this environment variable disables these canaries.
2627 =item WIRESHARK_DEBUG_SE_USE_CANARY
2629 Exporting this environment variable causes per-file memory allocations to be
2630 protected with "canaries" which allow for detection of memory overruns.
2631 This comes at the expense of significant extra memory usage.
2633 =item WIRESHARK_DEBUG_SCRUB_MEMORY
2635 If this environment variable is exported, the contents of per-packet and
2636 per-file memory is initialized to 0xBADDCAFE when the memory is allocated
2637 and is reset to 0xDEADBEEF when the memory is freed. This functionality is
2638 useful mainly to developers looking for bugs in the way memory is handled.
2640 =item WIRESHARK_RUN_FROM_BUILD_DIRECTORY
2642 This environment variable causes the plugins and other data files to be loaded
2643 from the build directory (where the program was compiled) rather than from the
2644 standard locations. It has no effect when the program in question is running
2645 with root (or setuid) permissions on *NIX.
2647 =item WIRESHARK_DATA_DIR
2649 This environment variable causes the various data files to be loaded from
2650 a directory other than the standard locations. It has no effect when the
2651 program in question is running with root (or setuid) permissions on *NIX.
2653 =item WIRESHARK_PYTHON_DIR
2655 This environment variable points to an alternate location for Python.
2656 It has no effect when the program in question is running with root (or setuid)
2657 permissions on *NIX.
2659 =item ERF_RECORDS_TO_CHECK
2661 This environment variable controls the number of ERF records checked when
2662 deciding if a file really is in the ERF format. Setting this environment
2663 variable a number higher than the default (20) would make false positives
2666 =item IPFIX_RECORDS_TO_CHECK
2668 This environment variable controls the number of IPFIX records checked when
2669 deciding if a file really is in the IPFIX format. Setting this environment
2670 variable a number higher than the default (20) would make false positives
2673 =item WIRESHARK_ABORT_ON_DISSECTOR_BUG
2675 If this environment variable is set, B<Wireshark> will call abort(3)
2676 when a dissector bug is encountered. abort(3) will cause the program to
2677 exit abnormally; if you are running B<Wireshark> in a debugger, it
2678 should halt in the debugger and allow inspection of the process, and, if
2679 you are not running it in a debugger, it will, on some OSes, assuming
2680 your environment is configured correctly, generate a core dump file.
2681 This can be useful to developers attempting to troubleshoot a problem
2682 with a protocol dissector.
2684 =item WIRESHARK_EP_VERIFY_POINTERS
2686 This environment variable, if exported, causes certain uses of pointers to be
2687 audited to ensure they do not point to memory that is deallocated after each
2688 packet has been fully dissected. This can be useful to developers writing or
2691 =item WIRESHARK_SE_VERIFY_POINTERS
2693 This environment variable, if exported, causes certain uses of pointers to be
2694 audited to ensure they do not point to memory that is deallocated after when
2695 a capture file is closed. This can be useful to developers writing or
2702 wireshark-filter(4), tshark(1), editcap(1), pcap-filter(4), tcpdump(8),
2703 pcap(3), dumpcap(1), mergecap(1), text2pcap(1)
2707 The latest version of B<Wireshark> can be found at
2708 L<http://www.wireshark.org>.
2710 HTML versions of the Wireshark project man pages are available at:
2711 L<http://www.wireshark.org/docs/man-pages>.