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 sizeE<gt> ] >
12 S<[ B<-c> E<lt>capture packet countE<gt> ]>
13 S<[ B<-C> E<lt>configuration profileE<gt> ]>
14 S<[ B<-d> E<lt>display filterE<gt> ]>
16 S<[ B<--display=>E<lt>X display to useE<gt> ] >
17 S<[ B<-f> E<lt>capture filterE<gt> ]>
18 S<[ B<-g> E<lt>packet numberE<gt> ]>
21 S<[ B<-i> E<lt>capture interfaceE<gt>|- ]>
24 S<[ B<-J> E<lt>jump filterE<gt> ]>
26 S<[ B<-K> E<lt>keytabE<gt> ]>
29 S<[ B<-m> E<lt>fontE<gt> ]>
31 S<[ B<-N> E<lt>name resolving flagsE<gt> ] >
32 S<[ B<-o> E<lt>preference/recent settingE<gt> ] ...>
34 S<[ B<-P> E<lt>path settingE<gt>]>
35 S<[ B<-r> E<lt>infileE<gt> ]>
36 S<[ B<-R> E<lt>read (display) filterE<gt> ]>
37 S<[ B<-s> E<lt>capture snaplenE<gt> ]>
39 S<[ B<-t> ad|a|r|d|dd|e ]>
41 S<[ B<-w> E<lt>outfileE<gt> ]>
42 S<[ B<-X> E<lt>eXtension optionE<gt> ]>
43 S<[ B<-y> E<lt>capture link typeE<gt> ]>
44 S<[ B<-z> E<lt>statisticsE<gt> ]>
45 S<[ E<lt>infileE<gt> ]>
49 B<Wireshark> is a GUI network protocol analyzer. It lets you
50 interactively browse packet data from a live network or from a
51 previously saved capture file. B<Wireshark>'s native capture file format
52 is B<libpcap> format, which is also the format used by B<tcpdump> and
55 B<Wireshark> can read / import the following file formats:
60 libpcap - captures from B<Wireshark>/B<TShark>/B<dumpcap>, B<tcpdump>,
61 and various other tools using libpcap's/tcpdump's capture format
64 pcap-ng - "next-generation" successor to libpcap format
67 B<snoop> and B<atmsnoop> captures
70 Shomiti/Finisar B<Surveyor> captures
73 Novell B<LANalyzer> captures
76 Microsoft B<Network Monitor> captures
79 AIX's B<iptrace> captures
82 Cinco Networks B<NetXRay> captures
85 Network Associates Windows-based B<Sniffer> captures
88 Network General/Network Associates DOS-based B<Sniffer> (compressed or uncompressed) captures
91 AG Group/WildPackets B<EtherPeek>/B<TokenPeek>/B<AiroPeek>/B<EtherHelp>/B<PacketGrabber> captures
94 B<RADCOM>'s WAN/LAN analyzer captures
97 Network Instruments B<Observer> version 9 captures
100 B<Lucent/Ascend> router debug output
103 files from HP-UX's B<nettl>
106 B<Toshiba's> ISDN routers dump output
109 the output from B<i4btrace> from the ISDN4BSD project
112 traces from the B<EyeSDN> USB S0.
115 the output in B<IPLog> format from the Cisco Secure Intrusion Detection System
118 B<pppd logs> (pppdump format)
121 the output from VMS's B<TCPIPtrace>/B<TCPtrace>/B<UCX$TRACE> utilities
124 the text output from the B<DBS Etherwatch> VMS utility
127 Visual Networks' B<Visual UpTime> traffic capture
130 the output from B<CoSine> L2 debug
133 the output from InfoVista's B<5View> LAN agents
136 Endace Measurement Systems' ERF format captures
139 Linux Bluez Bluetooth stack B<hcidump -w> traces
142 Catapult DCT2000 .out files
145 Gammu generated text output from Nokia DCT3 phones in Netmonitor mode
148 IBM Series (OS/400) Comm traces (ASCII & UNICODE)
151 Juniper Netscreen snoop files
154 Symbian OS btsnoop files
157 TamoSoft CommView files
160 Textronix K12xx 32bit .rf5 format files
163 Textronix K12 text file format captures
166 Apple PacketLogger files
169 Files from Aethra Telecommunications' PC108 software for their test
173 MPEG-2 Transport Streams as defined in ISO/IEC 13818-1
177 There is no need to tell B<Wireshark> what type of
178 file you are reading; it will determine the file type by itself.
179 B<Wireshark> is also capable of reading any of these file formats if they
180 are compressed using gzip. B<Wireshark> recognizes this directly from
181 the file; the '.gz' extension is not required for this purpose.
183 Like other protocol analyzers, B<Wireshark>'s main window shows 3 views
184 of a packet. It shows a summary line, briefly describing what the
185 packet is. A packet details display is shown, allowing you to drill
186 down to exact protocol or field that you interested in. Finally, a hex
187 dump shows you exactly what the packet looks like when it goes over the
190 In addition, B<Wireshark> has some features that make it unique. It can
191 assemble all the packets in a TCP conversation and show you the ASCII
192 (or EBCDIC, or hex) data in that conversation. Display filters in
193 B<Wireshark> are very powerful; more fields are filterable in B<Wireshark>
194 than in other protocol analyzers, and the syntax you can use to create
195 your filters is richer. As B<Wireshark> progresses, expect more and more
196 protocol fields to be allowed in display filters.
198 Packet capturing is performed with the pcap library. The capture filter
199 syntax follows the rules of the pcap library. This syntax is different
200 from the display filter syntax.
202 Compressed file support uses (and therefore requires) the zlib library.
203 If the zlib library is not present, B<Wireshark> will compile, but will
204 be unable to read compressed files.
206 The pathname of a capture file to be read can be specified with the
207 B<-r> option or can be specified as a command-line argument.
211 Most users will want to start B<Wireshark> without options and configure
212 it from the menus instead. Those users may just skip this section.
216 =item -a E<lt>capture autostop conditionE<gt>
218 Specify a criterion that specifies when B<Wireshark> is to stop writing
219 to a capture file. The criterion is of the form I<test>B<:>I<value>,
220 where I<test> is one of:
222 B<duration>:I<value> Stop writing to a capture file after I<value> seconds have
225 B<filesize>:I<value> Stop writing to a capture file after it reaches a size of
226 I<value> kilobytes (where a kilobyte is 1024 bytes). If this option is used
227 together with the -b option, Wireshark will stop writing to the current
228 capture file and switch to the next one if filesize is reached.
230 B<files>:I<value> Stop writing to capture files after I<value> number of files
233 =item -b E<lt>capture ring buffer optionE<gt>
235 Cause B<Wireshark> to run in "multiple files" mode. In "multiple files" mode,
236 B<Wireshark> will write to several capture files. When the first capture file
237 fills up, B<Wireshark> will switch writing to the next file and so on.
239 The created filenames are based on the filename given with the B<-w> flag,
240 the number of the file and on the creation date and time,
241 e.g. outfile_00001_20050604120117.pcap, outfile_00002_20050604120523.pcap, ...
243 With the I<files> option it's also possible to form a "ring buffer".
244 This will fill up new files until the number of files specified,
245 at which point B<Wireshark> will discard the data in the first file and start
246 writing to that file and so on. If the I<files> option is not set,
247 new files filled up until one of the capture stop conditions match (or
248 until the disk is full).
250 The criterion is of the form I<key>B<:>I<value>,
251 where I<key> is one of:
253 B<duration>:I<value> switch to the next file after I<value> seconds have
254 elapsed, even if the current file is not completely filled up.
256 B<filesize>:I<value> switch to the next file after it reaches a size of
257 I<value> kilobytes (where a kilobyte is 1024 bytes).
259 B<files>:I<value> begin again with the first file after I<value> number of
260 files were written (form a ring buffer). This value must be less than 100000.
261 Caution should be used when using large numbers of files: some filesystems do
262 not handle many files in a single directory well. The B<files> criterion
263 requires either B<duration> or B<filesize> to be specified to control when to
264 go to the next file. It should be noted that each B<-b> parameter takes exactly
265 one criterion; to specify two criterion, each must be preceded by the B<-b>
268 Example: B<-b filesize:1024 -b files:5> results in a ring buffer of five files
269 of size one megabyte.
271 =item -B E<lt>capture buffer sizeE<gt>
273 Set capture buffer size (in MB, default is 2MB). This is used by the
274 the capture driver to buffer packet data until that data can be written
275 to disk. If you encounter packet drops while capturing, try to increase
276 this size. Note that, while B<Wireshark> attempts to set the buffer size
277 to 2MB by default, and can be told to set it to a larger value, the
278 system or interface on which you're capturing might silently limit the
279 capture buffer size to a lower value or raise it to a higher value.
281 This is available on UNIX systems with libpcap 1.0.0 or later and on
282 Windows. It is not available on UNIX systems with earlier versions of
285 This option can occur multiple times. If used before the first
286 occurrence of the B<-i> option, it sets the default capture buffer size.
287 If used after an B<-i> option, it sets the capture buffer size for
288 the interface specified by the last B<-i> option occurring before
289 this option. If the capture buffer size is not set specifically,
290 the default capture buffer size is used if provided.
292 =item -c E<lt>capture packet countE<gt>
294 Set the maximum number of packets to read when capturing live
297 =item -C E<lt>configuration profileE<gt>
299 Start with the given configuration profile.
301 =item -d E<lt>display filterE<gt>
303 Start with the given display filter.
307 Print a list of the interfaces on which B<Wireshark> can capture, and
308 exit. For each network interface, a number and an
309 interface name, possibly followed by a text description of the
310 interface, is printed. The interface name or the number can be supplied
311 to the B<-i> flag to specify an interface on which to capture.
313 This can be useful on systems that don't have a command to list them
314 (e.g., Windows systems, or UNIX systems lacking B<ifconfig -a>);
315 the number can be useful on Windows 2000 and later systems, where the
316 interface name is a somewhat complex string.
318 Note that "can capture" means that B<Wireshark> was able to open
319 that device to do a live capture; if, on your system, a program doing a
320 network capture must be run from an account with special privileges (for
321 example, as root), then, if B<Wireshark> is run with the B<-D> flag and
322 is not run from such an account, it will not list any interfaces.
324 =item --display=E<lt>X display to useE<gt>
326 Specifies the X display to use. A hostname and screen (otherhost:0.0)
327 or just a screen (:0.0) can be specified. This option is not available
330 =item -f E<lt>capture filterE<gt>
332 Set the capture filter expression.
334 This option can occur multiple times. If used before the first
335 occurrence of the B<-i> option, it sets the default capture filter expression.
336 If used after an B<-i> option, it sets the capture filter expression for
337 the interface specified by the last B<-i> option occurring before
338 this option. If the capture filter expression is not set specifically,
339 the default capture filter expression is used if provided.
341 =item -g E<lt>packet numberE<gt>
343 After reading in a capture file using the B<-r> flag, go to the given I<packet number>.
347 Print the version and options and exit.
351 Hide the capture info dialog during live packet capture.
353 =item -i E<lt>capture interfaceE<gt>|-
355 Set the name of the network interface or pipe to use for live packet
358 Network interface names should match one of the names listed in
359 "B<wireshark -D>" (described above); a number, as reported by
360 "B<wireshark -D>", can also be used. If you're using UNIX, "B<netstat
361 -i>" or "B<ifconfig -a>" might also work to list interface names,
362 although not all versions of UNIX support the B<-a> flag to B<ifconfig>.
364 If no interface is specified, B<Wireshark> searches the list of
365 interfaces, choosing the first non-loopback interface if there are any
366 non-loopback interfaces, and choosing the first loopback interface if
367 there are no non-loopback interfaces. If there are no interfaces at all,
368 B<Wireshark> reports an error and doesn't start the capture.
370 Pipe names should be either the name of a FIFO (named pipe) or ``-'' to
371 read data from the standard input. On Windows systems, pipe names must be
372 of the form ``\\pipe\.\B<pipename>''. Data read from pipes must be in
373 standard libpcap format.
375 This option can occur multiple times. When capturing from multiple
376 interfaces, the capture file will be saved in pcap-ng format.
380 Put the interface in "monitor mode"; this is supported only on IEEE
381 802.11 Wi-Fi interfaces, and supported only on some operating systems.
383 Note that in monitor mode the adapter might disassociate from the
384 network with which it's associated, so that you will not be able to use
385 any wireless networks with that adapter. This could prevent accessing
386 files on a network server, or resolving host names or network addresses,
387 if you are capturing in monitor mode and are not connected to another
388 network with another adapter.
390 This option can occur multiple times. If used before the first
391 occurrence of the B<-i> option, it enables the monitor mode for all interfaces.
392 If used after an B<-i> option, it enables the monitor mode for
393 the interface specified by the last B<-i> option occurring before
398 Use after B<-J> to change the behavior when no exact match is found for
399 the filter. With this option select the first packet before.
401 =item -J E<lt>jump filterE<gt>
403 After reading in a capture file using the B<-r> flag, jump to the packet
404 matching the filter (display filter syntax). If no exact match is found
405 the first packet after that is selected.
409 Start the capture session immediately. If the B<-i> flag was
410 specified, the capture uses the specified interface. Otherwise,
411 B<Wireshark> searches the list of interfaces, choosing the first
412 non-loopback interface if there are any non-loopback interfaces, and
413 choosing the first loopback interface if there are no non-loopback
414 interfaces; if there are no interfaces, B<Wireshark> reports an error and
415 doesn't start the capture.
417 =item -K E<lt>keytabE<gt>
419 Load kerberos crypto keys from the specified keytab file.
420 This option can be used multiple times to load keys from several files.
422 Example: B<-K krb5.keytab>
426 Turn on automatic scrolling if the packet display is being updated
427 automatically as packets arrive during a capture (as specified by the
432 List the data link types supported by the interface and exit.
434 =item -m E<lt>fontE<gt>
436 Set the name of the font used by B<Wireshark> for most text. B<Wireshark>
437 will construct the name of the bold font used for the data in the byte
438 view pane that corresponds to the field selected in the packet details
439 pane from the name of the main text font.
443 Disable network object name resolution (such as hostname, TCP and UDP port
444 names), the B<-N> flag might override this one.
446 =item -N E<lt>name resolving flagsE<gt>
448 Turn on name resolving only for particular types of addresses and port
449 numbers, with name resolving for other types of addresses and port
450 numbers turned off. This flag overrides B<-n> if both B<-N> and B<-n> are
451 present. If both B<-N> and B<-n> flags are not present, all name resolutions
454 The argument is a string that may contain the letters:
456 B<m> to enable MAC address resolution
458 B<n> to enable network address resolution
460 B<N> to enable using external resolvers (e.g., DNS) for network address
463 B<t> to enable transport-layer port number resolution
465 B<C> to enable concurrent (asynchronous) DNS lookups
467 =item -o E<lt>preference/recent settingE<gt>
469 Set a preference or recent value, overriding the default value and any value
470 read from a preference/recent file. The argument to the flag is a string of
471 the form I<prefname>B<:>I<value>, where I<prefname> is the name of the
472 preference/recent value (which is the same name that would appear in the
473 preference/recent file), and I<value> is the value to which it should be set.
474 Since B<Ethereal> 0.10.12, the recent settings replaces the formerly used
475 -B, -P and -T flags to manipulate the GUI dimensions.
477 If I<prefname> is "uat", you can override settings in various user access
478 tables using the form uatB<:>I<uat filename>:I<uat record>. I<uat filename>
479 must be the name of a UAT file, e.g. I<user_dlts>. I<uat_record> must be in
480 the form of a valid record for that file, including quotes. For instance, to
481 specify a user DLT from the command line, you would use
485 -o "uat:user_dlts:\"User 0 (DLT=147)\",\"cops\",\"0\",\"\",\"0\",\"\""
491 I<Don't> put the interface into promiscuous mode. Note that the
492 interface might be in promiscuous mode for some other reason; hence,
493 B<-p> cannot be used to ensure that the only traffic that is captured is
494 traffic sent to or from the machine on which B<Wireshark> is running,
495 broadcast traffic, and multicast traffic to addresses received by that
498 This option can occur multiple times. If used before the first
499 occurrence of the B<-i> option, no interface will be put into the
501 If used after an B<-i> option, the interface specified by the last B<-i>
502 option occurring before this option will not be put into the
505 =item -P E<lt>path settingE<gt>
507 Special path settings usually detected automatically. This is used for
508 special cases, e.g. starting Wireshark from a known location on an USB stick.
510 The criterion is of the form I<key>B<:>I<path>, where I<key> is one of:
512 B<persconf>:I<path> path of personal configuration files, like the
515 B<persdata>:I<path> path of personal data files, it's the folder initially
516 opened. After the very first initialization, the recent file will keep the
519 =item -r E<lt>infileE<gt>
521 Read packet data from I<infile>, can be any supported capture file format
522 (including gzipped files). It's not possible to use named pipes or stdin
523 here! To capture from a pipe or from stdin use B<-i ->
525 =item -R E<lt>read (display) filterE<gt>
527 When reading a capture file specified with the B<-r> flag, causes the
528 specified filter (which uses the syntax of display filters, rather than
529 that of capture filters) to be applied to all packets read from the
530 capture file; packets not matching the filter are discarded.
532 =item -s E<lt>capture snaplenE<gt>
534 Set the default snapshot length to use when capturing live data.
535 No more than I<snaplen> bytes of each network packet will be read into
536 memory, or saved to disk. A value of 0 specifies a snapshot length of
537 65535, so that the full packet is captured; this is the default.
539 This option can occur multiple times. If used before the first
540 occurrence of the B<-i> option, it sets the default snapshot length.
541 If used after an B<-i> option, it sets the snapshot length for
542 the interface specified by the last B<-i> option occurring before
543 this option. If the snapshot length is not set specifically,
544 the default snapshot length is used if provided.
548 Automatically update the packet display as packets are coming in.
550 =item -t ad|a|r|d|dd|e
552 Set the format of the packet timestamp displayed in the packet list
553 window. The format can be one of:
555 B<ad> absolute with date: The absolute date and time is the actual time and
556 date the packet was captured
558 B<a> absolute: The absolute time is the actual time the packet was captured,
559 with no date displayed
561 B<r> relative: The relative time is the time elapsed between the first packet
562 and the current packet
564 B<d> delta: The delta time is the time since the previous packet was
567 B<dd> delta_displayed: The delta_displayed time is the time since the
568 previous displayed packet was captured
570 B<e> epoch: The time in seconds since epoch (Jan 1, 1970 00:00:00)
572 The default format is relative.
576 Print the version and exit.
578 =item -w E<lt>outfileE<gt>
580 Set the default capture file name.
582 =item -X E<lt>eXtension optionsE<gt>
584 Specify an option to be passed to an B<Wireshark> module. The eXtension option
585 is in the form I<extension_key>B<:>I<value>, where I<extension_key> can be:
587 B<lua_script>:I<lua_script_filename> tells B<Wireshark> to load the given script in addition to the
590 B<stdin_descr>:I<description> tells B<Wireshark> to use the given description when
591 capturing from standard input (B<-i ->).
593 =item -y E<lt>capture link typeE<gt>
595 If a capture is started from the command line with B<-k>, set the data
596 link type to use while capturing packets. The values reported by B<-L>
597 are the values that can be used.
599 This option can occur multiple times. If used before the first
600 occurrence of the B<-i> option, it sets the default capture link type.
601 If used after an B<-i> option, it sets the capture link type for
602 the interface specified by the last B<-i> option occurring before
603 this option. If the capture link type is not set specifically,
604 the default capture link type is used if provided.
606 =item -z E<lt>statisticsE<gt>
608 Get B<Wireshark> to collect various types of statistics and display the result
609 in a window that updates in semi-real time.
611 Currently implemented statistics are:
615 =item B<-z> conv,I<type>[,I<filter>]
617 Create a table that lists all conversations that could be seen in the
618 capture. I<type> specifies the conversation endpoint types for which we
619 want to generate the statistics; currently the supported ones are:
621 "eth" Ethernet addresses
622 "fc" Fibre Channel addresses
623 "fddi" FDDI addresses
625 "ipv6" IPv6 addresses
627 "tcp" TCP/IP socket pairs Both IPv4 and IPv6 are supported
628 "tr" Token Ring addresses
629 "udp" UDP/IP socket pairs Both IPv4 and IPv6 are supported
631 If the optional I<filter> is specified, only those packets that match the
632 filter will be used in the calculations.
634 The table is presented with one line for each conversation and displays
635 the number of packets/bytes in each direction as well as the total
636 number of packets/bytes. By default, the table is sorted according to
637 the total number of packets.
639 These tables can also be generated at runtime by selecting the appropriate
640 conversation type from the menu "Tools/Statistics/Conversation List/".
642 =item B<-z> dcerpc,srt,I<uuid>,I<major>.I<minor>[,I<filter>]
644 Collect call/reply SRT (Service Response Time) data for DCERPC interface I<uuid>,
645 version I<major>.I<minor>.
646 Data collected is the number of calls for each procedure, MinSRT, MaxSRT
649 Example: S<B<-z dcerpc,srt,12345778-1234-abcd-ef00-0123456789ac,1.0>> will collect data for the CIFS SAMR Interface.
651 This option can be used multiple times on the command line.
653 If the optional I<filter> is provided, the stats will only be calculated
654 on those calls that match that filter.
656 Example: S<B<-z dcerpc,srt,12345778-1234-abcd-ef00-0123456789ac,1.0,ip.addr==1.2.3.4>> will collect SAMR
657 SRT statistics for a specific host.
659 =item B<-z> fc,srt[,I<filter>]
661 Collect call/reply SRT (Service Response Time) data for FC. Data collected
662 is the number of calls for each Fibre Channel command, MinSRT, MaxSRT and AvgSRT.
664 Example: B<-z fc,srt>
665 will calculate the Service Response Time as the time delta between the
666 First packet of the exchange and the Last packet of the exchange.
668 The data will be presented as separate tables for all normal FC commands,
669 Only those commands that are seen in the capture will have its stats
672 This option can be used multiple times on the command line.
674 If the optional I<filter> is provided, the stats will only be calculated
675 on those calls that match that filter.
677 Example: B<-z "fc,srt,fc.id==01.02.03"> will collect stats only for
678 FC packets exchanged by the host at FC address 01.02.03 .
680 =item B<-z> h225,counter[I<,filter>]
682 Count ITU-T H.225 messages and their reasons. In the first column you get a
683 list of H.225 messages and H.225 message reasons which occur in the current
684 capture file. The number of occurrences of each message or reason is displayed
685 in the second column.
687 Example: B<-z h225,counter>
689 This option can be used multiple times on the command line.
691 If the optional I<filter> is provided, the stats will only be calculated
692 on those calls that match that filter.
694 Example: B<-z "h225,counter,ip.addr==1.2.3.4"> will collect stats only for
695 H.225 packets exchanged by the host at IP address 1.2.3.4 .
697 =item B<-z> h225,srt[I<,filter>]
699 Collect request/response SRT (Service Response Time) data for ITU-T H.225 RAS.
700 Data collected is the number of calls of each ITU-T H.225 RAS Message Type,
701 Minimum SRT, Maximum SRT, Average SRT, Minimum in Packet, and Maximum in Packet.
702 You will also get the number of Open Requests (Unresponded Requests),
703 Discarded Responses (Responses without matching request) and Duplicate Messages.
705 Example: B<-z h225,srt>
707 This option can be used multiple times on the command line.
709 If the optional I<filter> is provided, the stats will only be calculated
710 on those calls that match that filter.
712 Example: B<-z "h225,srt,ip.addr==1.2.3.4"> will collect stats only for
713 ITU-T H.225 RAS packets exchanged by the host at IP address 1.2.3.4 .
717 Collect packet/bytes statistics for the capture in intervals of 1 second.
718 This option will open a window with up to 5 color-coded graphs where
719 number-of-packets-per-second or number-of-bytes-per-second statistics
720 can be calculated and displayed.
722 This option can be used multiple times on the command line.
724 This graph window can also be opened from the Analyze:Statistics:Traffic:IO-Stat
727 =item B<-z> ldap,srt[,I<filter>]
729 Collect call/reply SRT (Service Response Time) data for LDAP. Data collected
730 is the number of calls for each implemented LDAP command, MinSRT, MaxSRT and AvgSRT.
732 Example: B<-z ldap,srt>
733 will calculate the Service Response Time as the time delta between the
734 Request and the Response.
736 The data will be presented as separate tables for all implemented LDAP commands,
737 Only those commands that are seen in the capture will have its stats
740 This option can be used multiple times on the command line.
742 If the optional I<filter> is provided, the stats will only be calculated
743 on those calls that match that filter.
745 Example: use B<-z "ldap,srt,ip.addr==10.1.1.1"> will collect stats only for
746 LDAP packets exchanged by the host at IP address 10.1.1.1 .
748 The only LDAP commands that are currently implemented and for which the stats will be available are:
758 =item B<-z> megaco,srt[I<,filter>]
760 Collect request/response SRT (Service Response Time) data for MEGACO.
761 (This is similar to B<-z smb,srt>). Data collected is the number of calls
762 for each known MEGACO Command, Minimum SRT, Maximum SRT and Average SRT.
764 Example: B<-z megaco,srt>
766 This option can be used multiple times on the command line.
768 If the optional I<filter> is provided, the stats will only be calculated
769 on those calls that match that filter.
771 Example: B<-z "megaco,srt,ip.addr==1.2.3.4"> will collect stats only for
772 MEGACO packets exchanged by the host at IP address 1.2.3.4 .
774 =item B<-z> mgcp,srt[I<,filter>]
776 Collect request/response SRT (Service Response Time) data for MGCP.
777 (This is similar to B<-z smb,srt>). Data collected is the number of calls
778 for each known MGCP Type, Minimum SRT, Maximum SRT and Average SRT.
780 Example: B<-z mgcp,srt>
782 This option can be used multiple times on the command line.
784 If the optional I<filter> is provided, the stats will only be calculated
785 on those calls that match that filter.
787 Example: B<-z "mgcp,srt,ip.addr==1.2.3.4"> will collect stats only for
788 MGCP packets exchanged by the host at IP address 1.2.3.4 .
790 =item B<-z> rpc,programs
792 Collect call/reply SRT data for all known ONC-RPC programs/versions.
793 Data collected is the number of calls for each protocol/version, MinSRT,
796 =item B<-z> rpc,srt,I<program>,I<version>[,<filter>]
798 Collect call/reply SRT (Service Response Time) data for I<program>/I<version>. Data collected
799 is the number of calls for each procedure, MinSRT, MaxSRT and AvgSRT.
801 Example: B<-z rpc,srt,100003,3> will collect data for NFS v3.
803 This option can be used multiple times on the command line.
805 If the optional I<filter> is provided, the stats will only be calculated
806 on those calls that match that filter.
808 Example: S<B<-z rpc,srt,100003,3,nfs.fh.hash==0x12345678>> will collect NFS v3
809 SRT statistics for a specific file.
811 =item B<-z> scsi,srt,I<cmdset>[,<filter>]
813 Collect call/reply SRT (Service Response Time) data for SCSI commandset <cmdset>.
815 Commandsets are 0:SBC 1:SSC 5:MMC
818 is the number of calls for each procedure, MinSRT, MaxSRT and AvgSRT.
820 Example: B<-z scsi,srt,0> will collect data for SCSI BLOCK COMMANDS (SBC).
822 This option can be used multiple times on the command line.
824 If the optional I<filter> is provided, the stats will only be calculated
825 on those calls that match that filter.
827 Example: B<-z scsi,srt,0,ip.addr==1.2.3.4> will collect SCSI SBC
828 SRT statistics for a specific iscsi/ifcp/fcip host.
830 =item B<-z> sip,stat[I<,filter>]
832 This option will activate a counter for SIP messages. You will get the number
833 of occurrences of each SIP Method and of each SIP Status-Code. Additionally you
834 also get the number of resent SIP Messages (only for SIP over UDP).
836 Example: B<-z sip,stat>
838 This option can be used multiple times on the command line.
840 If the optional I<filter> is provided, the stats will only be calculated
841 on those calls that match that filter.
843 Example: B<-z "sip,stat,ip.addr==1.2.3.4"> will collect stats only for
844 SIP packets exchanged by the host at IP address 1.2.3.4 .
846 =item B<-z> smb,srt[,I<filter>]
848 Collect call/reply SRT (Service Response Time) data for SMB. Data collected
849 is the number of calls for each SMB command, MinSRT, MaxSRT and AvgSRT.
851 Example: B<-z smb,srt>
853 The data will be presented as separate tables for all normal SMB commands,
854 all Transaction2 commands and all NT Transaction commands.
855 Only those commands that are seen in the capture will have their stats
857 Only the first command in a xAndX command chain will be used in the
858 calculation. So for common SessionSetupAndX + TreeConnectAndX chains,
859 only the SessionSetupAndX call will be used in the statistics.
860 This is a flaw that might be fixed in the future.
862 This option can be used multiple times on the command line.
864 If the optional I<filter> is provided, the stats will only be calculated
865 on those calls that match that filter.
867 Example: B<-z "smb,srt,ip.addr==1.2.3.4"> will collect stats only for
868 SMB packets exchanged by the host at IP address 1.2.3.4 .
870 =item B<-z> voip,calls
872 This option will show a window that shows VoIP calls found in the capture file.
873 This is the same window shown as when you go to the Statistics Menu and choose
876 Example: B<-z voip,calls>
890 =item File:Open Recent
894 Merge another capture file to the currently loaded one. The I<File:Merge>
895 dialog box allows the merge "Prepended", "Chronologically" or "Appended",
896 relative to the already loaded one.
900 Open or close a capture file. The I<File:Open> dialog box
901 allows a filter to be specified; when the capture file is read, the
902 filter is applied to all packets read from the file, and packets not
903 matching the filter are discarded. The I<File:Open Recent> is a submenu
904 and will show a list of previously opened files.
910 Save the current capture, or the packets currently displayed from that
911 capture, to a file. Check boxes let you select whether to save all
912 packets, or just those that have passed the current display filter and/or
913 those that are currently marked, and an option menu lets you select (from
914 a list of file formats in which at particular capture, or the packets
915 currently displayed from that capture, can be saved), a file format in
918 =item File:File Set:List Files
920 Show a dialog box that lists all files of the file set matching the currently
921 loaded file. A file set is a compound of files resulting from a capture using
922 the "multiple files" / "ringbuffer" mode, recognizable by the filename pattern,
923 e.g.: Filename_00001_20050604101530.pcap.
925 =item File:File Set:Next File
927 =item File:File Set:Previous File
929 If the currently loaded file is part of a file set (see above), open the
930 next / previous file in that set.
934 Export captured data into an external format. Note: the data cannot be
935 imported back into Wireshark, so be sure to keep the capture file.
939 Print packet data from the current capture. You can select the range of
940 packets to be printed (which packets are printed), and the output format of
941 each packet (how each packet is printed). The output format will be similar
942 to the displayed values, so a summary line, the packet details view, and/or
943 the hex dump of the packet can be printed.
945 Printing options can be set with the I<Edit:Preferences> menu item, or in the
946 dialog box popped up by this menu item.
950 Exit the application.
952 =item Edit:Copy:Description
954 Copies the description of the selected field in the protocol tree to
957 =item Edit:Copy:Fieldname
959 Copies the fieldname of the selected field in the protocol tree to
962 =item Edit:Copy:Value
964 Copies the value of the selected field in the protocol tree to
967 =item Edit:Copy:As Filter
969 Create a display filter based on the data currently highlighted in the
970 packet details and copy that filter to the clipboard.
972 If that data is a field that can be tested in a display filter
973 expression, the display filter will test that field; otherwise, the
974 display filter will be based on the absolute offset within the packet.
975 Therefore it could be unreliable if the packet contains protocols with
976 variable-length headers, such as a source-routed token-ring packet.
978 =item Edit:Find Packet
980 Search forward or backward, starting with the currently selected packet
981 (or the most recently selected packet, if no packet is selected). Search
982 criteria can be a display filter expression, a string of hexadecimal
983 digits, or a text string.
985 When searching for a text string, you can search the packet data, or you
986 can search the text in the Info column in the packet list pane or in the
989 Hexadecimal digits can be separated by colons, periods, or dashes.
990 Text string searches can be ASCII or Unicode (or both), and may be
995 =item Edit:Find Previous
997 Search forward / backward for a packet matching the filter from the previous
998 search, starting with the currently selected packet (or the most recently
999 selected packet, if no packet is selected).
1001 =item Edit:Mark Packet (toggle)
1003 Mark (or unmark if currently marked) the selected packet. The field
1004 "frame.marked" is set for packets that are marked, so that, for example,
1005 a display filters can be used to display only marked packets, and so that
1006 the L<Edit:Find Packet|/item_edit_3afind_packet> dialog can be used to find the next or previous
1009 =item Edit:Find Next Mark
1011 =item Edit:Find Previous Mark
1013 Find next/previous marked packet.
1015 =item Edit:Mark All Packets
1017 =item Edit:Unmark All Packets
1019 Mark / Unmark all packets that are currently displayed.
1021 =item Edit:Time Reference:Set Time Reference (toggle)
1023 Set (or unset if currently set) the selected packet as a Time Reference packet.
1024 When a packet is set as a Time Reference packet, the timestamps in the packet
1025 list pane will be replaced with the string "*REF*".
1026 The relative time timestamp in later packets will then be calculated relative
1027 to the timestamp of this Time Reference packet and not the first packet in
1030 Packets that have been selected as Time Reference packets will always be
1031 displayed in the packet list pane. Display filters will not affect or
1034 If there is a column displayed for "Cumulative Bytes" this counter will
1035 be reset at every Time Reference packet.
1037 =item Edit:Time Reference:Find Next
1039 =item Edit:Time Reference:Find Previous
1041 Search forward / backward for a time referenced packet.
1043 =item Edit:Configuration Profiles
1045 Manage configuration profiles to be able to use more than one set of
1046 preferences and configurations.
1048 =item Edit:Preferences
1050 Set the GUI, capture, printing and protocol options
1051 (see L<Preferences|/item_preferences> dialog below).
1053 =item View:Main Toolbar
1055 =item View:Filter Toolbar
1057 =item View:Statusbar
1059 Show or hide the main window controls.
1061 =item View:Packet List
1063 =item View:Packet Details
1065 =item View:Packet Bytes
1067 Show or hide the main window panes.
1069 =item View:Time Display Format
1071 Set the format of the packet timestamp displayed in the packet list window.
1073 =item View:Name Resolution:Resolve Name
1075 Try to resolve a name for the currently selected item.
1077 =item View:Name Resolution:Enable for ... Layer
1079 Enable or disable translation of addresses to names in the display.
1081 =item View:Colorize Packet List
1083 Enable or disable the coloring rules. Disabling will improve performance.
1085 =item View:Auto Scroll in Live Capture
1087 Enable or disable the automatic scrolling of the
1088 packet list while a live capture is in progress.
1094 Zoom into / out of the main window data (by changing the font size).
1096 =item View:Normal Size
1098 Reset the zoom factor of zoom in / zoom out back to normal font size.
1100 =item View:Resize All Columns
1102 Resize all columns to best fit the current packet display.
1104 =item View:Expand Subtrees
1106 Expands the currently selected item and it's subtrees in the packet details.
1108 =item View:Expand All
1110 =item View:Collapse All
1112 Expand / Collapse all branches of the packet details.
1114 =item View:Colorize Conversation
1116 Select color for a conversation.
1118 =item View:Reset Coloring 1-10
1120 Reset Color for a conversation.
1122 =item View:Coloring Rules
1124 Change the foreground and background colors of the packet information in
1125 the list of packets, based upon display filters. The list of display
1126 filters is applied to each packet sequentially. After the first display
1127 filter matches a packet, any additional display filters in the list are
1128 ignored. Therefore, if you are filtering on the existence of protocols,
1129 you should list the higher-level protocols first, and the lower-level
1134 =item How Colorization Works
1136 Packets are colored according to a list of color filters. Each filter
1137 consists of a name, a filter expression and a coloration. A packet is
1138 colored according to the first filter that it matches. Color filter
1139 expressions use exactly the same syntax as display filter expressions.
1141 When Wireshark starts, the color filters are loaded from:
1145 1. The user's personal color filters file or, if that does not exist,
1147 2. The global color filters file.
1151 If neither of these exist then the packets will not be colored.
1155 =item View:Show Packet In New Window
1157 Create a new window containing a packet details view and a hex dump
1158 window of the currently selected packet; this window will continue to
1159 display that packet's details and data even if another packet is
1164 Reload a capture file. Same as I<File:Close> and I<File:Open> the same
1169 Go back in previously visited packets history.
1173 Go forward in previously visited packets history.
1175 =item Go:Go To Packet
1177 Go to a particular numbered packet.
1179 =item Go:Go To Corresponding Packet
1181 If a field in the packet details pane containing a packet number is
1182 selected, go to the packet number specified by that field. (This works
1183 only if the dissector that put that entry into the packet details put it
1184 into the details as a filterable field rather than just as text.) This
1185 can be used, for example, to go to the packet for the request
1186 corresponding to a reply, or the reply corresponding to a request, if
1187 that packet number has been put into the packet details.
1189 =item Go:Previous Packet
1191 =item Go:Next Packet
1193 =item Go:First Packet
1195 =item Go:Last Packet
1197 Go to the previous / next / first / last packet in the capture.
1199 =item Go:Previous Packet In Conversation
1201 =item Go:Next Packet In Conversation
1203 Go to the previous / next packet of the conversation (TCP, UDP or IP)
1205 =item Capture:Interfaces
1207 Shows a dialog box with all currently known interfaces and displaying the
1208 current network traffic amount. Capture sessions can be started from here.
1209 Beware: keeping this box open results in high system load!
1211 =item Capture:Options
1213 Initiate a live packet capture (see L<Capture Options|/item_capture_options>
1214 dialog below). If no filename is specified, a temporary file will be created
1215 to hold the capture. The location of the file can be chosen by setting your
1216 TMPDIR environment variable before starting B<Wireshark>. Otherwise, the
1217 default TMPDIR location is system-dependent, but is likely either F</var/tmp>
1222 Start a live packet capture with the previously selected options. This won't
1223 open the options dialog box, and can be convenient for repeatedly capturing
1224 with the same options.
1228 Stop a running live capture.
1230 =item Capture:Restart
1232 While a live capture is running, stop it and restart with the same options
1233 again. This can be convenient to remove irrelevant packets, if no valuable
1234 packets were captured so far.
1236 =item Capture:Capture Filters
1238 Edit the saved list of capture filters, allowing filters to be added,
1239 changed, or deleted.
1241 =item Analyze:Display Filters
1243 Edit the saved list of display filters, allowing filters to be added,
1244 changed, or deleted.
1246 =item Analyze:Display Filter Macros
1248 Create shortcuts for complex macros
1250 =item Analyze:Apply as Filter
1252 Create a display filter based on the data currently highlighted in the
1253 packet details and apply the filter.
1255 If that data is a field that can be tested in a display filter
1256 expression, the display filter will test that field; otherwise, the
1257 display filter will be based on the absolute offset within the packet.
1258 Therefore it could be unreliable if the packet contains protocols with
1259 variable-length headers, such as a source-routed token-ring packet.
1261 The B<Selected> option creates a display filter that tests for a match
1262 of the data; the B<Not Selected> option creates a display filter that
1263 tests for a non-match of the data. The B<And Selected>, B<Or Selected>,
1264 B<And Not Selected>, and B<Or Not Selected> options add to the end of
1265 the display filter in the strip at the top (or bottom) an AND or OR
1266 operator followed by the new display filter expression.
1268 =item Analyze:Prepare a Filter
1270 Create a display filter based on the data currently highlighted in the
1271 packet details. The filter strip at the top (or bottom) is updated but
1272 it is not yet applied.
1274 =item Analyze:Enabled Protocols
1276 Allow protocol dissection to be enabled or disabled for a specific
1277 protocol. Individual protocols can be enabled or disabled by clicking
1278 on them in the list or by highlighting them and pressing the space bar.
1279 The entire list can be enabled, disabled, or inverted using the buttons
1282 When a protocol is disabled, dissection in a particular packet stops
1283 when that protocol is reached, and Wireshark moves on to the next packet.
1284 Any higher-layer protocols that would otherwise have been processed will
1285 not be displayed. For example, disabling TCP will prevent the dissection
1286 and display of TCP, HTTP, SMTP, Telnet, and any other protocol exclusively
1289 The list of protocols can be saved, so that Wireshark will start up with
1290 the protocols in that list disabled.
1292 =item Analyze:Decode As
1294 If you have a packet selected, present a dialog allowing you to change
1295 which dissectors are used to decode this packet. The dialog has one
1296 panel each for the link layer, network layer and transport layer
1297 protocol/port numbers, and will allow each of these to be changed
1298 independently. For example, if the selected packet is a TCP packet to
1299 port 12345, using this dialog you can instruct Wireshark to decode all
1300 packets to or from that TCP port as HTTP packets.
1302 =item Analyze:User Specified Decodes
1304 Create a new window showing whether any protocol ID to dissector
1305 mappings have been changed by the user. This window also allows the
1306 user to reset all decodes to their default values.
1308 =item Analyze:Follow TCP Stream
1310 If you have a TCP packet selected, display the contents of the data
1311 stream for the TCP connection to which that packet belongs, as text, in
1312 a separate window, and leave the list of packets in a filtered state,
1313 with only those packets that are part of that TCP connection being
1314 displayed. You can revert to your old view by pressing ENTER in the
1315 display filter text box, thereby invoking your old display filter (or
1316 resetting it back to no display filter).
1318 The window in which the data stream is displayed lets you select:
1324 whether to display the entire conversation, or one or the other side of
1329 whether the data being displayed is to be treated as ASCII or EBCDIC
1330 text or as raw hex data;
1334 and lets you print what's currently being displayed, using the same
1335 print options that are used for the I<File:Print Packet> menu item, or
1336 save it as text to a file.
1338 =item Analyze:Follow UDP Stream
1340 =item Analyze:Follow SSL Stream
1342 (Similar to Analyze:Follow TCP Stream)
1344 =item Analyze:Expert Info
1346 =item Analyze:Expert Info Composite
1348 (Kind of) a log of anomalies found by Wireshark in a capture file.
1350 =item Analyze:Conversation Filter
1352 =item Statistics:Summary
1354 Show summary information about the capture, including elapsed time,
1355 packet counts, byte counts, and the like. If a display filter is in
1356 effect, summary information will be shown about the capture and about
1357 the packets currently being displayed.
1359 =item Statistics:Protocol Hierarchy
1361 Show the number of packets, and the number of bytes in those packets,
1362 for each protocol in the trace. It organizes the protocols in the same
1363 hierarchy in which they were found in the trace. Besides counting the
1364 packets in which the protocol exists, a count is also made for packets
1365 in which the protocol is the last protocol in the stack. These
1366 last-protocol counts show you how many packets (and the byte count
1367 associated with those packets) B<ended> in a particular protocol. In
1368 the table, they are listed under "End Packets" and "End Bytes".
1370 =item Statistics:Conversations
1372 Lists of conversations; selectable by protocol. See Statistics:Conversation List below.
1374 =item Statistics:End Points
1376 List of End Point Addresses by protocol with packets/bytes/.... counts.
1378 =item Statistics:Packet Lengths
1380 Grouped counts of packet lengths (0-19 bytes, 20-39 bytes, ...)
1382 =item Statistics:IO Graphs
1384 Open a window where up to 5 graphs in different colors can be displayed
1385 to indicate number of packets or number of bytes per second for all packets
1386 matching the specified filter.
1387 By default only one graph will be displayed showing number of packets per second.
1389 The top part of the window contains the graphs and scales for the X and
1390 Y axis. If the graph is too long to fit inside the window there is a
1391 horizontal scrollbar below the drawing area that can scroll the graphs
1392 to the left or the right. The horizontal axis displays the time into
1393 the capture and the vertical axis will display the measured quantity at
1396 Below the drawing area and the scrollbar are the controls. On the
1397 bottom left there will be five similar sets of controls to control each
1398 individual graph such as "Display:<button>" which button will toggle
1399 that individual graph on/off. If <button> is ticked, the graph will be
1400 displayed. "Color:<color>" which is just a button to show which color
1401 will be used to draw that graph (color is only available in Gtk2
1402 version) and finally "Filter:<filter-text>" which can be used to specify
1403 a display filter for that particular graph.
1405 If filter-text is empty then all packets will be used to calculate the
1406 quantity for that graph. If filter-text is specified only those packets
1407 that match that display filter will be considered in the calculation of
1410 To the right of the 5 graph controls there are four menus to control
1411 global aspects of the draw area and graphs. The "Unit:" menu is used to
1412 control what to measure; "packets/tick", "bytes/tick" or "advanced..."
1414 packets/tick will measure the number of packets matching the (if
1415 specified) display filter for the graph in each measurement interval.
1417 bytes/tick will measure the total number of bytes in all packets matching
1418 the (if specified) display filter for the graph in each measurement
1421 advanced... see below
1423 "Tick interval:" specifies what measurement intervals to use. The
1424 default is 1 second and means that the data will be counted over 1
1427 "Pixels per tick:" specifies how many pixels wide each measurement
1428 interval will be in the drawing area. The default is 5 pixels per tick.
1430 "Y-scale:" controls the max value for the y-axis. Default value is
1431 "auto" which means that B<Wireshark> will try to adjust the maxvalue
1434 "advanced..." If Unit:advanced... is selected the window will display
1435 two more controls for each of the five graphs. One control will be a
1436 menu where the type of calculation can be selected from
1437 SUM,COUNT,MAX,MIN,AVG and LOAD, and one control, textbox, where the name of a
1438 single display filter field can be specified.
1440 The following restrictions apply to type and field combinations:
1442 SUM: available for all types of integers and will calculate the SUM of
1443 all occurrences of this field in the measurement interval. Note that
1444 some field can occur multiple times in the same packet and then all
1445 instances will be summed up. Example: 'tcp.len' which will count the
1446 amount of payload data transferred across TCP in each interval.
1448 COUNT: available for all field types. This will COUNT the number of times
1449 certain field occurs in each interval. Note that some fields
1450 may occur multiple times in each packet and if that is the case
1451 then each instance will be counted independently and COUNT
1452 will be greater than the number of packets.
1454 MAX: available for all integer and relative time fields. This will calculate
1455 the max seen integer/time value seen for the field during the interval.
1456 Example: 'smb.time' which will plot the maximum SMB response time.
1458 MIN: available for all integer and relative time fields. This will calculate
1459 the min seen integer/time value seen for the field during the interval.
1460 Example: 'smb.time' which will plot the minimum SMB response time.
1462 AVG: available for all integer and relative time fields.This will
1463 calculate the average seen integer/time value seen for the field during
1464 the interval. Example: 'smb.time' which will plot the average SMB
1467 LOAD: available only for relative time fields (response times).
1469 Example of advanced:
1470 Display how NFS response time MAX/MIN/AVG changes over time:
1474 filter:nfs&&rpc.time
1479 filter:nfs&&rpc.time
1484 filter:nfs&&rpc.time
1487 Example of advanced:
1488 Display how the average packet size from host a.b.c.d changes over time.
1492 filter:ip.addr==a.b.c.d&&frame.pkt_len
1493 Calc:AVG frame.pkt_len
1496 The LOAD io-stat type is very different from anything you have ever seen
1497 before! While the response times themselves as plotted by MIN,MAX,AVG are
1498 indications on the Server load (which affects the Server response time),
1499 the LOAD measurement measures the Client LOAD.
1500 What this measures is how much workload the client generates,
1501 i.e. how fast will the client issue new commands when the previous ones
1503 i.e. the level of concurrency the client can maintain.
1504 The higher the number, the more and faster is the client issuing new
1505 commands. When the LOAD goes down, it may be due to client load making
1506 the client slower in issuing new commands (there may be other reasons as
1507 well, maybe the client just doesn't have any commands it wants to issue
1510 Load is measured in concurrency/number of overlapping i/o and the value
1511 1000 means there is a constant load of one i/o.
1513 In each tick interval the amount of overlap is measured.
1514 See the graph below containing three commands:
1515 Below the graph are the LOAD values for each interval that would be calculated.
1519 | | o=====* | | | | | |
1521 | o========* | o============* | | |
1523 --------------------------------------------------> Time
1524 500 1500 500 750 1000 500 0 0
1526 =item Statistics:Conversation List
1528 This option will open a new window that displays a list of all
1529 conversations between two endpoints. The list has one row for each
1530 unique conversation and displays total number of packets/bytes seen as
1531 well as number of packets/bytes in each direction.
1533 By default the list is sorted according to the number of packets but by
1534 clicking on the column header; it is possible to re-sort the list in
1535 ascending or descending order by any column.
1537 By first selecting a conversation by clicking on it and then using the
1538 right mouse button (on those platforms that have a right
1539 mouse button) wireshark will display a popup menu offering several different
1540 filter operations to apply to the capture.
1542 These statistics windows can also be invoked from the Wireshark command
1543 line using the B<-z conv> argument.
1545 =item Statistics:Service Response Time
1561 Open a window to display Service Response Time statistics for an
1562 arbitrary DCE-RPC program
1563 interface and display B<Procedure>, B<Number of Calls>, B<Minimum SRT>,
1564 B<Maximum SRT> and B<Average SRT> for all procedures for that
1565 program/version. These windows opened will update in semi-real time to
1566 reflect changes when doing live captures or when reading new capture
1567 files into B<Wireshark>.
1569 This dialog will also allow an optional filter string to be used.
1570 If an optional filter string is used only such DCE-RPC request/response pairs
1571 that match that filter will be used to calculate the statistics. If no filter
1572 string is specified all request/response pairs will be used.
1582 Open a window to display Service Response Time statistics for Fibre Channel
1583 and display B<FC Type>, B<Number of Calls>, B<Minimum SRT>,
1584 B<Maximum SRT> and B<Average SRT> for all FC types.
1585 These windows opened will update in semi-real time to
1586 reflect changes when doing live captures or when reading new capture
1587 files into B<Wireshark>.
1588 The Service Response Time is calculated as the time delta between the
1589 First packet of the exchange and the Last packet of the exchange.
1591 This dialog will also allow an optional filter string to be used.
1592 If an optional filter string is used only such FC first/last exchange pairs
1593 that match that filter will be used to calculate the statistics. If no filter
1594 string is specified all request/response pairs will be used.
1604 Collect requests/response SRT (Service Response Time) data for ITU-T H.225 RAS.
1605 Data collected is B<number of calls> for each known ITU-T H.225 RAS Message Type,
1606 B<Minimum SRT>, B<Maximum SRT>, B<Average SRT>, B<Minimum in Packet>, and B<Maximum in Packet>.
1607 You will also get the number of B<Open Requests> (Unresponded Requests),
1608 B<Discarded Responses> (Responses without matching request) and Duplicate Messages.
1609 These windows opened will update in semi-real time to reflect changes when
1610 doing live captures or when reading new capture files into B<Wireshark>.
1612 You can apply an optional filter string in a dialog box, before starting
1613 the calculation. The statistics will only be calculated
1614 on those calls matching that filter.
1628 Collect requests/response SRT (Service Response Time) data for MGCP.
1629 Data collected is B<number of calls> for each known MGCP Type,
1630 B<Minimum SRT>, B<Maximum SRT>, B<Average SRT>, B<Minimum in Packet>, and B<Maximum in Packet>.
1631 These windows opened will update in semi-real time to reflect changes when
1632 doing live captures or when reading new capture files into B<Wireshark>.
1634 You can apply an optional filter string in a dialog box, before starting
1635 the calculation. The statistics will only be calculated
1636 on those calls matching that filter.
1646 Open a window to display statistics for an arbitrary ONC-RPC program interface
1647 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.
1648 These windows opened will update in semi-real time to reflect changes when
1649 doing live captures or when reading new capture files into B<Wireshark>.
1651 This dialog will also allow an optional filter string to be used.
1652 If an optional filter string is used only such ONC-RPC request/response pairs
1653 that match that filter will be used to calculate the statistics. If no filter
1654 string is specified all request/response pairs will be used.
1656 By first selecting a conversation by clicking on it and then using the
1657 right mouse button (on those platforms that have a right
1658 mouse button) wireshark will display a popup menu offering several different
1659 filter operations to apply to the capture.
1673 Collect call/reply SRT (Service Response Time) data for SMB. Data collected
1674 is the number of calls for each SMB command, MinSRT, MaxSRT and AvgSRT.
1676 The data will be presented as separate tables for all normal SMB commands,
1677 all Transaction2 commands and all NT Transaction commands.
1678 Only those commands that are seen in the capture will have its stats
1680 Only the first command in a xAndX command chain will be used in the
1681 calculation. So for common SessionSetupAndX + TreeConnectAndX chains,
1682 only the SessionSetupAndX call will be used in the statistics.
1683 This is a flaw that might be fixed in the future.
1685 You can apply an optional filter string in a dialog box, before starting
1686 the calculation. The stats will only be calculated
1687 on those calls matching that filter.
1689 By first selecting a conversation by clicking on it and then using the
1690 right mouse button (on those platforms that have a right
1691 mouse button) wireshark will display a popup menu offering several different
1692 filter operations to apply to the capture.
1700 =item Statistics:BOOTP-DHCP
1704 =item Statistics:Compare
1706 Compare two Capture Files
1708 =item Statistics:Flow Graph
1710 Flow Graph: General/TCP
1712 =item Statistics:HTTP
1714 HTTP Load Distribution, Packet Counter & Requests
1716 =item Statistics:IP Addresses
1718 Count/Rate/Percent by IP Address
1720 =item Statistics:IP Destinations
1722 Count/Rate/Percent by IP Address/protocol/port
1724 =item Statistics:IP Protocol Types
1726 Count/Rate/Percent by IP Protocol Types
1728 =item Statistics:ONC-RPC Programs
1730 This dialog will open a window showing aggregated SRT statistics for all
1731 ONC-RPC Programs/versions that exist in the capture file.
1733 =item Statistics:TCP Stream Graph
1735 Graphs: Round Trip; Throughput; Time-Sequence (Stevens); Time-Sequence (tcptrace)
1737 =item Statistics:UDP Multicast streams
1739 Multicast Streams Counts/Rates/... by Source/Destination Address/Port pairs
1741 =item Statistics:WLAN Traffic
1743 WLAN Traffic Statistics
1745 =item Telephony:ITU-T H.225
1747 Count ITU-T H.225 messages and their reasons. In the first column you get a
1748 list of H.225 messages and H.225 message reasons, which occur in the current
1749 capture file. The number of occurrences of each message or reason will be displayed
1750 in the second column.
1751 This window opened will update in semi-real time to reflect changes when
1752 doing live captures or when reading new capture files into B<Wireshark>.
1754 You can apply an optional filter string in a dialog box, before starting
1755 the counter. The statistics will only be calculated
1756 on those calls matching that filter.
1760 Activate a counter for SIP messages. You will get the number of occurrences of each
1761 SIP Method and of each SIP Status-Code. Additionally you also get the number of
1762 resent SIP Messages (only for SIP over UDP).
1764 This window opened will update in semi-real time to reflect changes when
1765 doing live captures or when reading new capture files into B<Wireshark>.
1767 You can apply an optional filter string in a dialog box, before starting
1768 the counter. The statistics will only be calculated
1769 on those calls matching that filter.
1771 =item Tools:Firewall ACL Rules
1779 =item Help:Supported Protocols
1781 List of supported protocols and display filter protocol fields.
1783 =item Help:Manual Pages
1785 Display locally installed HTML versions of these manual pages in a web browser.
1787 =item Help:Wireshark Online
1789 Various links to online resources to be open in a web browser, like
1790 L<http://www.wireshark.org>.
1792 =item Help:About Wireshark
1794 See various information about Wireshark (see L<About|/item_about> dialog below), like the
1795 version, the folders used, the available plugins, ...
1805 The main window contains the usual things like the menu, some toolbars, the
1806 main area and a statusbar. The main area is split into three panes, you can
1807 resize each pane using a "thumb" at the right end of each divider line.
1809 The main window is much more flexible than before. The layout of the main
1810 window can be customized by the I<Layout> page in the dialog box popped
1811 up by I<Edit:Preferences>, the following will describe the layout with the
1818 Some menu items are available for quick access here. There is no way to
1819 customize the items in the toolbar, however the toolbar can be hidden by
1820 I<View:Main Toolbar>.
1822 =item Filter Toolbar
1824 A display filter can be entered into the filter toolbar.
1825 A filter for HTTP, HTTPS, and DNS traffic might look like this:
1827 tcp.port == 80 || tcp.port == 443 || tcp.port == 53
1829 Selecting the I<Filter:> button lets you choose from a list of named
1830 filters that you can optionally save. Pressing the Return or Enter
1831 keys, or selecting the I<Apply> button, will cause the filter to be
1832 applied to the current list of packets. Selecting the I<Reset> button
1833 clears the display filter so that all packets are displayed (again).
1835 There is no way to customize the items in the toolbar, however the toolbar
1836 can be hidden by I<View:Filter Toolbar>.
1838 =item Packet List Pane
1840 The top pane contains the list of network packets that you can scroll
1841 through and select. By default, the packet number, packet timestamp,
1842 source and destination addresses, protocol, and description are
1843 displayed for each packet; the I<Columns> page in the dialog box popped
1844 up by I<Edit:Preferences> lets you change this (although, unfortunately,
1845 you currently have to save the preferences, and exit and restart
1846 Wireshark, for those changes to take effect).
1848 If you click on the heading for a column, the display will be sorted by
1849 that column; clicking on the heading again will reverse the sort order
1852 An effort is made to display information as high up the protocol stack
1853 as possible, e.g. IP addresses are displayed for IP packets, but the
1854 MAC layer address is displayed for unknown packet types.
1856 The right mouse button can be used to pop up a menu of operations.
1858 The middle mouse button can be used to mark a packet.
1860 =item Packet Details Pane
1862 The middle pane contains a display of the details of the
1863 currently-selected packet. The display shows each field and its value
1864 in each protocol header in the stack. The right mouse button can be
1865 used to pop up a menu of operations.
1867 =item Packet Bytes Pane
1869 The lowest pane contains a hex and ASCII dump of the actual packet data.
1870 Selecting a field in the packet details highlights the corresponding
1871 bytes in this section.
1873 The right mouse button can be used to pop up a menu of operations.
1877 The statusbar is divided into three parts, on the left some context dependent
1878 things are shown, like information about the loaded file, in the center the
1879 number of packets are displayed, and on the right the current configuration
1882 The statusbar can be hidden by I<View:Statusbar>.
1888 The I<Preferences> dialog lets you control various personal preferences
1889 for the behavior of B<Wireshark>.
1893 =item User Interface Preferences
1895 The I<User Interface> page is used to modify small aspects of the GUI to
1896 your own personal taste:
1900 =item Selection Bars
1902 The selection bar in the packet list and packet details can have either
1903 a "browse" or "select" behavior. If the selection bar has a "browse"
1904 behavior, the arrow keys will move an outline of the selection bar,
1905 allowing you to browse the rest of the list or details without changing
1906 the selection until you press the space bar. If the selection bar has a
1907 "select" behavior, the arrow keys will move the selection bar and change
1908 the selection to the new item in the packet list or packet details.
1910 =item Save Window Position
1912 If this item is selected, the position of the main Wireshark window will
1913 be saved when Wireshark exits, and used when Wireshark is started again.
1915 =item Save Window Size
1917 If this item is selected, the size of the main Wireshark window will
1918 be saved when Wireshark exits, and used when Wireshark is started again.
1920 =item Save Window Maximized state
1922 If this item is selected the maximize state of the main Wireshark window
1923 will be saved when Wireshark exists, and used when Wireshark is started again.
1925 =item File Open Dialog Behavior
1927 This item allows the user to select how Wireshark handles the listing
1928 of the "File Open" Dialog when opening trace files. "Remember Last
1929 Directory" causes Wireshark to automatically position the dialog in the
1930 directory of the most recently opened file, even between launches of Wireshark.
1931 "Always Open in Directory" allows the user to define a persistent directory
1932 that the dialog will always default to.
1936 Allows the user to specify a persistent File Open directory. Trailing
1937 slashes or backslashes will automatically be added.
1939 =item File Open Preview timeout
1941 This items allows the user to define how much time is spend reading the
1942 capture file to present preview data in the File Open dialog.
1944 =item Open Recent maximum list entries
1946 The File menu supports a recent file list. This items allows the user to
1947 specify how many files are kept track of in this list.
1949 =item Ask for unsaved capture files
1951 When closing a capture file or Wireshark itself if the file isn't saved yet
1952 the user is presented the option to save the file when this item is set.
1954 =item Wrap during find
1956 This items determines the behavior when reaching the beginning or the end
1957 of a capture file. When set the search wraps around and continues, otherwise
1960 =item Settings dialogs show a save button
1962 This item determines if the various dialogs sport an explicit Save button
1963 or that save is implicit in OK / Apply.
1965 =item Web browser command
1967 This entry specifies the command line to launch a web browser. It is used
1968 to access online content, like the Wiki and user guide. Use '%s' to place
1969 the request URL in the command line.
1971 =item Display LEDs in the Expert Infos dialog tab labels
1973 This item determines if LED-like colored images are displayed in the
1974 Expert Infos dialog tab labels.
1978 =item Layout Preferences
1980 The I<Layout> page lets you specify the general layout of the main window.
1981 You can choose from six different layouts and fill the three panes with the
1988 The vertical scrollbars in the three panes can be set to be either on
1989 the left or the right.
1991 =item Alternating row colors
1995 The highlight method in the hex dump display for the selected protocol
1996 item can be set to use either inverse video, or bold characters.
2000 =item Filter toolbar placement
2002 =item Custom window title
2006 =item Column Preferences
2008 The I<Columns> page lets you specify the number, title, and format
2009 of each column in the packet list.
2011 The I<Column title> entry is used to specify the title of the column
2012 displayed at the top of the packet list. The type of data that the column
2013 displays can be specified using the I<Column format> option menu.
2014 The row of buttons on the left perform the following actions:
2020 Adds a new column to the list.
2024 Deletes the currently selected list item.
2028 Moves the selected list item up or down one position.
2032 =item Font Preferences
2034 The I<Font> page lets you select the font to be used for most text.
2036 =item Color Preferences
2038 The I<Colors> page can be used to change the color of the text
2039 displayed in the TCP stream window and for marked packets. To change a color,
2040 simply select an attribute from the "Set:" menu and use the color selector to
2041 get the desired color. The new text colors are displayed as a sample text.
2043 =item Capture Preferences
2045 The I<Capture> page lets you specify various parameters for capturing
2046 live packet data; these are used the first time a capture is started.
2048 The I<Interface:> combo box lets you specify the interface from which to
2049 capture packet data, or the name of a FIFO from which to get the packet
2052 The I<Data link type:> option menu lets you, for some interfaces, select
2053 the data link header you want to see on the packets you capture. For
2054 example, in some OSes and with some versions of libpcap, you can choose,
2055 on an 802.11 interface, whether the packets should appear as Ethernet
2056 packets (with a fake Ethernet header) or as 802.11 packets.
2058 The I<Limit each packet to ... bytes> check box lets you set the
2059 snapshot length to use when capturing live data; turn on the check box,
2060 and then set the number of bytes to use as the snapshot length.
2062 The I<Filter:> text entry lets you set a capture filter expression to be
2063 used when capturing.
2065 If any of the environment variables SSH_CONNECTION, SSH_CLIENT,
2066 REMOTEHOST, DISPLAY, or SESSIONNAME are set, Wireshark will create a
2067 default capture filter that excludes traffic from the hosts and ports
2068 defined in those variables.
2070 The I<Capture packets in promiscuous mode> check box lets you specify
2071 whether to put the interface in promiscuous mode when capturing.
2073 The I<Update list of packets in real time> check box lets you specify
2074 that the display should be updated as packets are seen.
2076 The I<Automatic scrolling in live capture> check box lets you specify
2077 whether, in an "Update list of packets in real time" capture, the packet
2078 list pane should automatically scroll to show the most recently captured
2081 =item Printing Preferences
2083 The radio buttons at the top of the I<Printing> page allow you choose
2084 between printing packets with the I<File:Print Packet> menu item as text
2085 or PostScript, and sending the output directly to a command or saving it
2086 to a file. The I<Command:> text entry box, on UNIX-compatible systems,
2087 is the command to send files to (usually B<lpr>), and the I<File:> entry
2088 box lets you enter the name of the file you wish to save to.
2089 Additionally, you can select the I<File:> button to browse the file
2090 system for a particular save file.
2092 =item Name Resolution Preferences
2094 The I<Enable MAC name resolution>, I<Enable network name resolution> and
2095 I<Enable transport name resolution> check boxes let you specify whether
2096 MAC addresses, network addresses, and transport-layer port numbers
2097 should be translated to names.
2099 The I<Enable concurrent DNS name resolution> allows Wireshark to send out
2100 multiple name resolution requests and not wait for the result before
2101 continuing dissection. This speeds up dissection with network name
2102 resolution but initially may miss resolutions. The number of concurrent
2103 requests can be set here as well.
2109 =item RTP Player Preferences
2111 This page allows you to select the number of channels visible in the
2112 RTP player window. It determines the height of the window, more channels
2113 are possible and visible by means of a scroll bar.
2115 =item Protocol Preferences
2117 There are also pages for various protocols that Wireshark dissects,
2118 controlling the way Wireshark handles those protocols.
2122 =item Edit Capture Filter List
2124 =item Edit Display Filter List
2126 =item Capture Filter
2128 =item Display Filter
2134 The I<Edit Capture Filter List> dialog lets you create, modify, and
2135 delete capture filters, and the I<Edit Display Filter List> dialog lets
2136 you create, modify, and delete display filters.
2138 The I<Capture Filter> dialog lets you do all of the editing operations
2139 listed, and also lets you choose or construct a filter to be used when
2142 The I<Display Filter> dialog lets you do all of the editing operations
2143 listed, and also lets you choose or construct a filter to be used to
2144 filter the current capture being viewed.
2146 The I<Read Filter> dialog lets you do all of the editing operations
2147 listed, and also lets you choose or construct a filter to be used to
2148 as a read filter for a capture file you open.
2150 The I<Search Filter> dialog lets you do all of the editing operations
2151 listed, and also lets you choose or construct a filter expression to be
2152 used in a find operation.
2154 In all of those dialogs, the I<Filter name> entry specifies a
2155 descriptive name for a filter, e.g. B<Web and DNS traffic>. The
2156 I<Filter string> entry is the text that actually describes the filtering
2157 action to take, as described above.The dialog buttons perform the
2164 If there is text in the two entry boxes, creates a new associated list
2169 Modifies the currently selected list item to match what's in the entry
2174 Deletes the currently selected list item.
2176 =item Add Expression...
2178 For display filter expressions, pops up a dialog box to allow you to
2179 construct a filter expression to test a particular field; it offers
2180 lists of field names, and, when appropriate, lists from which to select
2181 tests to perform on the field and values with which to compare it. In
2182 that dialog box, the OK button will cause the filter expression you
2183 constructed to be entered into the I<Filter string> entry at the current
2188 In the I<Capture Filter> dialog, closes the dialog box and makes the
2189 filter in the I<Filter string> entry the filter in the I<Capture
2190 Preferences> dialog. In the I<Display Filter> dialog, closes the dialog
2191 box and makes the filter in the I<Filter string> entry the current
2192 display filter, and applies it to the current capture. In the I<Read
2193 Filter> dialog, closes the dialog box and makes the filter in the
2194 I<Filter string> entry the filter in the I<Open Capture File> dialog.
2195 In the I<Search Filter> dialog, closes the dialog box and makes the
2196 filter in the I<Filter string> entry the filter in the I<Find Packet>
2201 Makes the filter in the I<Filter string> entry the current display
2202 filter, and applies it to the current capture.
2206 If the list of filters being edited is the list of
2207 capture filters, saves the current filter list to the personal capture
2208 filters file, and if the list of filters being edited is the list of
2209 display filters, saves the current filter list to the personal display
2214 Closes the dialog without doing anything with the filter in the I<Filter
2219 =item The Color Filters Dialog
2221 This dialog displays a list of color filters and allows it to be
2226 =item THE FILTER LIST
2228 Single rows may be selected by clicking. Multiple rows may be selected
2229 by using the ctrl and shift keys in combination with the mouse button.
2233 Adds a new filter at the bottom of the list and opens the Edit Color
2234 Filter dialog box. You will have to alter the filter expression at
2235 least before the filter will be accepted. The format of color filter
2236 expressions is identical to that of display filters. The new filter is
2237 selected, so it may immediately be moved up and down, deleted or edited.
2238 To avoid confusion all filters are unselected before the new filter is
2243 Opens the Edit Color Filter dialog box for the selected filter. (If this
2244 button is disabled you may have more than one filter selected, making it
2245 ambiguous which is to be edited.)
2249 Enables the selected color filter(s).
2253 Disables the selected color filter(s).
2257 Deletes the selected color filter(s).
2261 Allows you to choose a file in which to save the current list of color
2262 filters. You may also choose to save only the selected filters. A
2263 button is provided to save the filters in the global color filters file
2264 (you must have sufficient permissions to write this file, of course).
2268 Allows you to choose a file containing color filters which are then
2269 added to the bottom of the current list. All the added filters are
2270 selected, so they may be moved to the correct position in the list as a
2271 group. To avoid confusion, all filters are unselected before the new
2272 filters are imported. A button is provided to load the filters from the
2273 global color filters file.
2277 Deletes your personal color filters file, reloads the global
2278 color filters file, if any, and closes the dialog.
2282 Moves the selected filter(s) up the list, making it more likely that
2283 they will be used to color packets.
2287 Moves the selected filter(s) down the list, making it less likely that
2288 they will be used to color packets.
2292 Closes the dialog and uses the color filters as they stand.
2296 Colors the packets according to the current list of color filters, but
2297 does not close the dialog.
2301 Saves the current list of color filters in your personal color filters
2302 file. Unless you do this they will not be used the next time you start
2307 Closes the dialog without changing the coloration of the packets. Note
2308 that changes you have made to the current list of color filters are not
2313 =item Capture Options
2315 The I<Capture Options> dialog lets you specify various parameters for
2316 capturing live packet data.
2318 The I<Interface:> field lets you specify the interface from which to
2319 capture packet data or a command from which to get the packet data via a
2322 The I<Link layer header type:> field lets you specify the interfaces link
2323 layer header type. This field is usually disabled, as most interface have
2324 only one header type.
2326 The I<Capture packets in promiscuous mode> check box lets you specify
2327 whether the interface should be put into promiscuous mode when
2330 The I<Limit each packet to ... bytes> check box and field lets you
2331 specify a maximum number of bytes per packet to capture and save; if the
2332 check box is not checked, the limit will be 65535 bytes.
2334 The I<Capture Filter:> entry lets you specify the capture filter using a
2335 tcpdump-style filter string as described above.
2337 The I<File:> entry lets you specify the file into which captured packets
2338 should be saved, as in the I<Printer Options> dialog above. If not
2339 specified, the captured packets will be saved in a temporary file; you
2340 can save those packets to a file with the I<File:Save As> menu item.
2342 The I<Use multiple files> check box lets you specify that the capture
2343 should be done in "multiple files" mode. This option is disabled, if the
2344 I<Update list of packets in real time> option is checked.
2346 The I<Next file every ... megabyte(s)> check box and fields lets
2347 you specify that a switch to a next file should be done
2348 if the specified filesize is reached. You can also select the appropriate
2349 unit, but beware that the filesize has a maximum of 2 GB.
2350 The check box is forced to be checked, as "multiple files" mode requires a
2351 file size to be specified.
2353 The I<Next file every ... minute(s)> check box and fields lets
2354 you specify that the switch to a next file should be done after the specified
2355 time has elapsed, even if the specified capture size is not reached.
2357 The I<Ring buffer with ... files> field lets you specify the number
2358 of files of a ring buffer. This feature will capture into to the first file
2359 again, after the specified amount of files were used.
2361 The I<Stop capture after ... files> field lets you specify the number
2362 of capture files used, until the capture is stopped.
2364 The I<Stop capture after ... packet(s)> check box and field let
2365 you specify that Wireshark should stop capturing after having captured
2366 some number of packets; if the check box is not checked, Wireshark will
2367 not stop capturing at some fixed number of captured packets.
2369 The I<Stop capture after ... megabyte(s)> check box and field lets
2370 you specify that Wireshark should stop capturing after the file to which
2371 captured packets are being saved grows as large as or larger than some
2372 specified number of megabytes. If the check box is not checked, Wireshark
2373 will not stop capturing at some capture file size (although the operating
2374 system on which Wireshark is running, or the available disk space, may still
2375 limit the maximum size of a capture file). This option is disabled, if
2376 "multiple files" mode is used,
2378 The I<Stop capture after ... second(s)> check box and field let you
2379 specify that Wireshark should stop capturing after it has been capturing
2380 for some number of seconds; if the check box is not checked, Wireshark
2381 will not stop capturing after some fixed time has elapsed.
2383 The I<Update list of packets in real time> check box lets you specify
2384 whether the display should be updated as packets are captured and, if
2385 you specify that, the I<Automatic scrolling in live capture> check box
2386 lets you specify the packet list pane should automatically scroll to
2387 show the most recently captured packets as new packets arrive.
2389 The I<Enable MAC name resolution>, I<Enable network name resolution> and
2390 I<Enable transport name resolution> check boxes let you specify whether
2391 MAC addresses, network addresses, and transport-layer port numbers
2392 should be translated to names.
2396 The I<About> dialog lets you view various information about Wireshark.
2398 =item About:Wireshark
2400 The I<Wireshark> page lets you view general information about Wireshark,
2401 like the installed version, licensing information and such.
2405 The I<Authors> page shows the author and all contributors.
2409 The I<Folders> page lets you view the directory names where Wireshark is
2410 searching it's various configuration and other files.
2414 The I<Plugins> page lets you view the dissector plugin modules
2415 available on your system.
2417 The I<Plugins List> shows the name and version of each dissector plugin
2418 module found on your system.
2420 On Unix-compatible systems, the plugins are looked for in the following
2421 directories: the F<lib/wireshark/plugins/$VERSION> directory under the
2422 main installation directory (for example,
2423 F</usr/local/lib/wireshark/plugins/$VERSION>), and then
2424 F<$HOME/.wireshark/plugins>.
2426 On Windows systems, the plugins are looked for in the following
2427 directories: F<plugins\$VERSION> directory under the main installation
2428 directory (for example, F<C:\Program Files\Wireshark\plugins\$VERSION>),
2429 and then F<%APPDATA%\Wireshark\plugins\$VERSION> (or, if %APPDATA% isn't
2430 defined, F<%USERPROFILE%\Application Data\Wireshark\plugins\$VERSION>).
2432 $VERSION is the version number of the plugin interface, which
2433 is typically the version number of Wireshark. Note that a dissector
2434 plugin module may support more than one protocol; there is not
2435 necessarily a one-to-one correspondence between dissector plugin modules
2436 and protocols. Protocols supported by a dissector plugin module are
2437 enabled and disabled using the I<Edit:Protocols> dialog box, just as
2438 protocols built into Wireshark are.
2442 =head1 CAPTURE FILTER SYNTAX
2444 See the manual page of pcap-filter(7) or, if that doesn't exist, tcpdump(8),
2445 or, if that doesn't exist, L<http://wiki.wireshark.org/CaptureFilters>.
2447 =head1 DISPLAY FILTER SYNTAX
2449 For a complete table of protocol and protocol fields that are filterable
2450 in B<Wireshark> see the wireshark-filter(4) manual page.
2454 These files contains various B<Wireshark> configuration settings.
2460 The F<preferences> files contain global (system-wide) and personal
2461 preference settings. If the system-wide preference file exists, it is
2462 read first, overriding the default settings. If the personal preferences
2463 file exists, it is read next, overriding any previous values. Note: If
2464 the command line flag B<-o> is used (possibly more than once), it will
2465 in turn override values from the preferences files.
2467 The preferences settings are in the form I<prefname>B<:>I<value>,
2469 where I<prefname> is the name of the preference
2470 and I<value> is the value to
2471 which it should be set; white space is allowed between B<:> and
2472 I<value>. A preference setting can be continued on subsequent lines by
2473 indenting the continuation lines with white space. A B<#> character
2474 starts a comment that runs to the end of the line:
2476 # Vertical scrollbars should be on right side?
2477 # TRUE or FALSE (case-insensitive).
2478 gui.scrollbar_on_right: TRUE
2480 The global preferences file is looked for in the F<wireshark> directory
2481 under the F<share> subdirectory of the main installation directory (for
2482 example, F</usr/local/share/wireshark/preferences>) on UNIX-compatible
2483 systems, and in the main installation directory (for example,
2484 F<C:\Program Files\Wireshark\preferences>) on Windows systems.
2486 The personal preferences file is looked for in F<$HOME/.wireshark/preferences> on
2487 UNIX-compatible systems and F<%APPDATA%\Wireshark\preferences> (or, if
2488 %APPDATA% isn't defined, F<%USERPROFILE%\Application
2489 Data\Wireshark\preferences>) on Windows systems.
2491 Note: Whenever the preferences are saved by using the I<Save> button
2492 in the I<Edit:Preferences> dialog box, your personal preferences file
2493 will be overwritten with the new settings, destroying any comments and
2494 unknown/obsolete settings that were in the file.
2498 The F<recent> file contains personal settings (mostly GUI related) such
2499 as the current B<Wireshark> window size. The file is saved at program exit and
2500 read in at program start automatically. Note: The command line flag B<-o>
2501 may be used to override settings from this file.
2503 The settings in this file have the same format as in the F<preferences>
2504 files, and the same directory as for the personal preferences file is
2507 Note: Whenever Wireshark is closed, your recent file
2508 will be overwritten with the new settings, destroying any comments and
2509 unknown/obsolete settings that were in the file.
2511 =item Disabled (Enabled) Protocols
2513 The F<disabled_protos> files contain system-wide and personal lists of
2514 protocols that have been disabled, so that their dissectors are never
2515 called. The files contain protocol names, one per line, where the
2516 protocol name is the same name that would be used in a display filter
2522 If a protocol is listed in the global F<disabled_protos> file, it is not
2523 displayed in the I<Analyze:Enabled Protocols> dialog box, and so cannot
2524 be enabled by the user.
2526 The global F<disabled_protos> file uses the same directory as the global
2529 The personal F<disabled_protos> file uses the same directory as the
2530 personal preferences file.
2532 Note: Whenever the disabled protocols list is saved by using the I<Save>
2533 button in the I<Analyze:Enabled Protocols> dialog box, your personal
2534 disabled protocols file will be overwritten with the new settings,
2535 destroying any comments that were in the file.
2537 =item Name Resolution (hosts)
2539 If the personal F<hosts> file exists, it is
2540 used to resolve IPv4 and IPv6 addresses before any other
2541 attempts are made to resolve them. The file has the standard F<hosts>
2542 file syntax; each line contains one IP address and name, separated by
2543 whitespace. The same directory as for the personal preferences file is used.
2545 Capture filter name resolution is handled by libpcap on UNIX-compatible
2546 systems and WinPCAP on Windows. As such the Wireshark personal F<hosts> file
2547 will not be consulted for capture filter name resolution.
2549 =item Name Resolution (ethers)
2551 The F<ethers> files are consulted to correlate 6-byte hardware addresses to
2552 names. First the personal F<ethers> file is tried and if an address is not
2553 found there the global F<ethers> file is tried next.
2555 Each line contains one hardware address and name, separated by
2556 whitespace. The digits of the hardware address are separated by colons
2557 (:), dashes (-) or periods (.). The same separator character must be
2558 used consistently in an address. The following three lines are valid
2559 lines of an F<ethers> file:
2561 ff:ff:ff:ff:ff:ff Broadcast
2562 c0-00-ff-ff-ff-ff TR_broadcast
2563 00.00.00.00.00.00 Zero_broadcast
2565 The global F<ethers> file is looked for in the F</etc> directory on
2566 UNIX-compatible systems, and in the main installation directory (for
2567 example, F<C:\Program Files\Wireshark>) on Windows systems.
2569 The personal F<ethers> file is looked for in the same directory as the personal
2572 Capture filter name resolution is handled by libpcap on UNIX-compatible
2573 systems and WinPCAP on Windows. As such the Wireshark personal F<ethers> file
2574 will not be consulted for capture filter name resolution.
2576 =item Name Resolution (manuf)
2578 The F<manuf> file is used to match the 3-byte vendor portion of a 6-byte
2579 hardware address with the manufacturer's name; it can also contain well-known
2580 MAC addresses and address ranges specified with a netmask. The format of the
2581 file is the same as the F<ethers> files, except that entries such as:
2585 can be provided, with the 3-byte OUI and the name for a vendor, and
2588 00-00-0C-07-AC/40 All-HSRP-routers
2590 can be specified, with a MAC address and a mask indicating how many bits
2591 of the address must match. The above entry, for example, has 40
2592 significant bits, or 5 bytes, and would match addresses from
2593 00-00-0C-07-AC-00 through 00-00-0C-07-AC-FF. The mask need not be a
2596 The F<manuf> file is looked for in the same directory as the global
2599 =item Name Resolution (ipxnets)
2601 The F<ipxnets> files are used to correlate 4-byte IPX network numbers to
2602 names. First the global F<ipxnets> file is tried and if that address is not
2603 found there the personal one is tried next.
2605 The format is the same as the F<ethers>
2606 file, except that each address is four bytes instead of six.
2607 Additionally, the address can be represented as a single hexadecimal
2608 number, as is more common in the IPX world, rather than four hex octets.
2609 For example, these four lines are valid lines of an F<ipxnets> file:
2613 00:00:BE:EF IT_Server1
2616 The global F<ipxnets> file is looked for in the F</etc> directory on
2617 UNIX-compatible systems, and in the main installation directory (for
2618 example, F<C:\Program Files\Wireshark>) on Windows systems.
2620 The personal F<ipxnets> file is looked for in the same directory as the
2621 personal preferences file.
2623 =item Capture Filters
2625 The F<cfilters> files contain system-wide and personal capture filters.
2626 Each line contains one filter, starting with the string displayed in the
2627 dialog box in quotation marks, followed by the filter string itself:
2632 The global F<cfilters> file uses the same directory as the
2633 global preferences file.
2635 The personal F<cfilters> file uses the same directory as the personal
2636 preferences file. It is written through the Capture:Capture Filters
2639 If the global F<cfilters> file exists, it is used only if the personal
2640 F<cfilters> file does not exist; global and personal capture filters are
2643 =item Display Filters
2645 The F<dfilters> files contain system-wide and personal display filters.
2646 Each line contains one filter, starting with the string displayed in the
2647 dialog box in quotation marks, followed by the filter string itself:
2652 The global F<dfilters> file uses the same directory as the
2653 global preferences file.
2655 The personal F<dfilters> file uses the same directory as the
2656 personal preferences file. It is written through the Analyze:Display
2659 If the global F<dfilters> file exists, it is used only if the personal
2660 F<dfilters> file does not exist; global and personal display filters are
2663 =item Color Filters (Coloring Rules)
2665 The F<colorfilters> files contain system-wide and personal color filters.
2666 Each line contains one filter, starting with the string displayed in the
2667 dialog box, followed by the corresponding display filter. Then the
2668 background and foreground colors are appended:
2671 @tcp@tcp@[59345,58980,65534][0,0,0]
2672 @udp@udp@[28834,57427,65533][0,0,0]
2674 The global F<colorfilters> file uses the same directory as the
2675 global preferences file.
2677 The personal F<colorfilters> file uses the same directory as the
2678 personal preferences file. It is written through the View:Coloring Rules
2681 If the global F<colorfilters> file exists, it is used only if the personal
2682 F<colorfilters> file does not exist; global and personal color filters are
2687 The F<gtkrc> files contain system-wide and personal GTK theme settings.
2689 The global F<gtkrc> file uses the same directory as the
2690 global preferences file.
2692 The personal F<gtkrc> file uses the same directory as the personal
2697 See above in the description of the About:Plugins page.
2701 =head1 ENVIRONMENT VARIABLES
2705 =item WIRESHARK_DEBUG_EP_NO_CHUNKS
2707 Normally per-packet memory is allocated in large "chunks." This behavior
2708 doesn't work well with debugging tools such as Valgrind or ElectricFence.
2709 Export this environment variable to force individual allocations.
2710 Note: disabling chunks also disables canaries (see below).
2712 =item WIRESHARK_DEBUG_SE_NO_CHUNKS
2714 Normally per-file memory is allocated in large "chunks." This behavior
2715 doesn't work well with debugging tools such as Valgrind or ElectricFence.
2716 Export this environment variable to force individual allocations.
2717 Note: disabling chunks also disables canaries (see below).
2719 =item WIRESHARK_DEBUG_EP_NO_CANARY
2721 Normally per-packet memory allocations are separated by "canaries" which
2722 allow detection of memory overruns. This comes at the expense of some extra
2723 memory usage. Exporting this environment variable disables these canaries.
2725 =item WIRESHARK_DEBUG_SE_USE_CANARY
2727 Exporting this environment variable causes per-file memory allocations to be
2728 protected with "canaries" which allow for detection of memory overruns.
2729 This comes at the expense of significant extra memory usage.
2731 =item WIRESHARK_DEBUG_SCRUB_MEMORY
2733 If this environment variable is set, the contents of per-packet and
2734 per-file memory is initialized to 0xBADDCAFE when the memory is allocated
2735 and is reset to 0xDEADBEEF when the memory is freed. This functionality is
2736 useful mainly to developers looking for bugs in the way memory is handled.
2738 =item WIRESHARK_DEBUG_USE_SLICES
2740 Exporting this environment variable causes slab allocations to be done using
2741 glib's g_slice routines. This, combined with glib's G_SLICE=always-malloc
2742 setting, can help developers looking for bugs in the way memory is handled.
2744 =item WIRESHARK_RUN_FROM_BUILD_DIRECTORY
2746 This environment variable causes the plugins and other data files to be loaded
2747 from the build directory (where the program was compiled) rather than from the
2748 standard locations. It has no effect when the program in question is running
2749 with root (or setuid) permissions on *NIX.
2751 =item WIRESHARK_DATA_DIR
2753 This environment variable causes the various data files to be loaded from
2754 a directory other than the standard locations. It has no effect when the
2755 program in question is running with root (or setuid) permissions on *NIX.
2757 =item WIRESHARK_PYTHON_DIR
2759 This environment variable points to an alternate location for Python.
2760 It has no effect when the program in question is running with root (or setuid)
2761 permissions on *NIX.
2763 =item ERF_RECORDS_TO_CHECK
2765 This environment variable controls the number of ERF records checked when
2766 deciding if a file really is in the ERF format. Setting this environment
2767 variable a number higher than the default (20) would make false positives
2770 =item IPFIX_RECORDS_TO_CHECK
2772 This environment variable controls the number of IPFIX records checked when
2773 deciding if a file really is in the IPFIX format. Setting this environment
2774 variable a number higher than the default (20) would make false positives
2777 =item WIRESHARK_ABORT_ON_DISSECTOR_BUG
2779 If this environment variable is set, B<Wireshark> will call abort(3)
2780 when a dissector bug is encountered. abort(3) will cause the program to
2781 exit abnormally; if you are running B<Wireshark> in a debugger, it
2782 should halt in the debugger and allow inspection of the process, and, if
2783 you are not running it in a debugger, it will, on some OSes, assuming
2784 your environment is configured correctly, generate a core dump file.
2785 This can be useful to developers attempting to troubleshoot a problem
2786 with a protocol dissector.
2788 =item WIRESHARK_EP_VERIFY_POINTERS
2790 This environment variable, if set, causes certain uses of pointers to be
2791 audited to ensure they do not point to memory that is deallocated after each
2792 packet has been fully dissected. This can be useful to developers writing or
2795 =item WIRESHARK_SE_VERIFY_POINTERS
2797 This environment variable, if set, causes certain uses of pointers to be
2798 audited to ensure they do not point to memory that is deallocated after when
2799 a capture file is closed. This can be useful to developers writing or
2802 =item WIRESHARK_QUIT_AFTER_CAPTURE
2804 Cause B<Wireshark> to exit after the end of the capture session. This
2805 doesn't automatically start a capture; you must still use B<-k> to do
2806 that. You must also specify an autostop condition, e.g. B<-c> or B<-a
2807 duration:...>. This means that you will not be able to see the results
2808 of the capture after it stops; it's primarily useful for testing.
2810 =item WIRESHARK_ABORT_ON_OUT_OF_MEMORY
2812 This environment variable, if present, causes abort(3) to be called if certain
2813 out-of-memory conditions (which normally result in an exception and an
2814 explanatory error message) are experienced. This can be useful to developers
2815 debugging out-of-memory conditions.
2821 wireshark-filter(4), tshark(1), editcap(1), pcap(3), dumpcap(1), mergecap(1),
2822 text2pcap(1), pcap-filter(7) or tcpdump(8) if it doesn't exist.
2826 The latest version of B<Wireshark> can be found at
2827 L<http://www.wireshark.org>.
2829 HTML versions of the Wireshark project man pages are available at:
2830 L<http://www.wireshark.org/docs/man-pages>.