Add missing comments in syntax description for -z expert
[obnox/wireshark/wip.git] / doc / wireshark.pod.template
1
2 =head1 NAME
3
4 wireshark - Interactively dump and analyze network traffic
5
6 =head1 SYNOPSIS
7
8 B<wireshark>
9 S<[ B<-a> E<lt>capture autostop conditionE<gt> ] ...>
10 S<[ B<-b> E<lt>capture ring buffer optionE<gt> ] ...>
11 S<[ B<-B> E<lt>capture buffer size (Win32 only)E<gt> ] >
12 S<[ B<-c> E<lt>capture packet countE<gt> ]>
13 S<[ B<-C> E<lt>configuration profileE<gt> ]>
14 S<[ B<-d> E<lt>display filterE<gt> ]>
15 S<[ B<-D> ]>
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> ]>
19 S<[ B<-h> ]>
20 S<[ B<-H> ]>
21 S<[ B<-i> E<lt>capture interfaceE<gt>|- ]>
22 S<[ B<-I> ]>
23 S<[ B<-J> E<lt>jump filterE<gt> ]>
24 S<[ B<-j> ]>
25 S<[ B<-k> ]>
26 S<[ B<-K> E<lt>keytabE<gt> ]>
27 S<[ B<-l> ]>
28 S<[ B<-L> ]>
29 S<[ B<-m> E<lt>fontE<gt> ]>
30 S<[ B<-n> ]>
31 S<[ B<-N> E<lt>name resolving flagsE<gt> ] >
32 S<[ B<-o> E<lt>preference/recent settingE<gt> ] ...>
33 S<[ B<-p> ]>
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> ]>
38 S<[ B<-s> E<lt>capture snaplenE<gt> ]>
39 S<[ B<-t> ad|a|r|d|dd|e ]>
40 S<[ B<-v> ]>
41 S<[ B<-w> E<lt>outfileE<gt> ]>
42 S<[ B<-y> E<lt>capture link typeE<gt> ]>
43 S<[ B<-X> E<lt>eXtension optionE<gt> ]>
44 S<[ B<-z> E<lt>statisticsE<gt> ]>
45 S<[ E<lt>infileE<gt> ]>
46
47 =head1 DESCRIPTION
48
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
53 various other tools.
54
55 B<Wireshark> can read / import the following file formats:
56
57 =over 4
58
59 =item *
60 libpcap - captures from B<Wireshark>/B<TShark>/B<dumpcap>, B<tcpdump>,
61 and various other tools using libpcap's/tcpdump's capture format
62
63 =item *
64 pcap-ng - "next-generation" successor to libpcap format
65
66 =item *
67 B<snoop> and B<atmsnoop> captures
68
69 =item *
70 Shomiti/Finisar B<Surveyor> captures
71
72 =item *
73 Novell B<LANalyzer> captures
74
75 =item *
76 Microsoft B<Network Monitor> captures
77
78 =item *
79 AIX's B<iptrace> captures
80
81 =item *
82 Cinco Networks B<NetXRay> captures
83
84 =item *
85 Network Associates Windows-based B<Sniffer> captures
86
87 =item *
88 Network General/Network Associates DOS-based B<Sniffer> (compressed or uncompressed) captures
89
90 =item *
91 AG Group/WildPackets B<EtherPeek>/B<TokenPeek>/B<AiroPeek>/B<EtherHelp>/B<PacketGrabber> captures
92
93 =item *
94 B<RADCOM>'s WAN/LAN analyzer captures
95
96 =item *
97 Network Instruments B<Observer> version 9 captures
98
99 =item *
100 B<Lucent/Ascend> router debug output
101
102 =item *
103 files from HP-UX's B<nettl>
104
105 =item *
106 B<Toshiba's> ISDN routers dump output
107
108 =item *
109 the output from B<i4btrace> from the ISDN4BSD project
110
111 =item *
112 traces from the B<EyeSDN> USB S0.
113
114 =item *
115 the output in B<IPLog> format from the Cisco Secure Intrusion Detection System
116
117 =item *
118 B<pppd logs> (pppdump format)
119
120 =item *
121 the output from VMS's B<TCPIPtrace>/B<TCPtrace>/B<UCX$TRACE> utilities
122
123 =item *
124 the text output from the B<DBS Etherwatch> VMS utility
125
126 =item *
127 Visual Networks' B<Visual UpTime> traffic capture
128
129 =item *
130 the output from B<CoSine> L2 debug
131
132 =item *
133 the output from Accellent's B<5Views> LAN agents
134
135 =item *
136 Endace Measurement Systems' ERF format captures
137
138 =item *
139 Linux Bluez Bluetooth stack B<hcidump -w> traces
140
141 =item *
142 Catapult DCT2000 .out files
143
144 =item *
145 Gammu generated text output from Nokia DCT3 phones in Netmonitor mode
146
147 =item *
148 IBM Series (OS/400) Comm traces (ASCII & UNICODE)
149
150 =item *
151 Juniper Netscreen snoop files
152
153 =item *
154 Symbian OS btsnoop files
155
156 =item *
157 TamoSoft CommView files
158
159 =item *
160 Textronix K12xx 32bit .rf5 format files
161
162 =item *
163 Textronix K12 text file format captures
164
165 =item *
166 Apple PacketLogger files
167
168 =item *
169 Files from Aethra Telecommunications' PC108 software for their test
170 instruments
171
172 =back
173
174 There is no need to tell B<Wireshark> what type of
175 file you are reading; it will determine the file type by itself.
176 B<Wireshark> is also capable of reading any of these file formats if they
177 are compressed using gzip.  B<Wireshark> recognizes this directly from
178 the file; the '.gz' extension is not required for this purpose.
179
180 Like other protocol analyzers, B<Wireshark>'s main window shows 3 views
181 of a packet.  It shows a summary line, briefly describing what the
182 packet is.  A packet details display is shown, allowing you to drill
183 down to exact protocol or field that you interested in.  Finally, a hex
184 dump shows you exactly what the packet looks like when it goes over the
185 wire.
186
187 In addition, B<Wireshark> has some features that make it unique.  It can
188 assemble all the packets in a TCP conversation and show you the ASCII
189 (or EBCDIC, or hex) data in that conversation.  Display filters in
190 B<Wireshark> are very powerful; more fields are filterable in B<Wireshark>
191 than in other protocol analyzers, and the syntax you can use to create
192 your filters is richer.  As B<Wireshark> progresses, expect more and more
193 protocol fields to be allowed in display filters.
194
195 Packet capturing is performed with the pcap library.  The capture filter
196 syntax follows the rules of the pcap library.  This syntax is different
197 from the display filter syntax.
198
199 Compressed file support uses (and therefore requires) the zlib library.
200 If the zlib library is not present, B<Wireshark> will compile, but will
201 be unable to read compressed files.
202
203 The pathname of a capture file to be read can be specified with the
204 B<-r> option or can be specified as a command-line argument.
205
206 =head1 OPTIONS
207
208 Most users will want to start B<Wireshark> without options and configure
209 it from the menus instead.  Those users may just skip this section.
210
211 =over 4
212
213 =item -a  E<lt>capture autostop conditionE<gt>
214
215 Specify a criterion that specifies when B<Wireshark> is to stop writing
216 to a capture file.  The criterion is of the form I<test>B<:>I<value>,
217 where I<test> is one of:
218
219 B<duration>:I<value> Stop writing to a capture file after I<value> seconds have
220 elapsed.
221
222 B<filesize>:I<value> Stop writing to a capture file after it reaches a size of
223 I<value> kilobytes (where a kilobyte is 1024 bytes).  If this option is used
224 together with the -b option, Wireshark will stop writing to the current
225 capture file and switch to the next one if filesize is reached.
226
227 B<files>:I<value> Stop writing to capture files after I<value> number of files
228 were written.
229
230 =item -b  E<lt>capture ring buffer optionE<gt>
231
232 Cause B<Wireshark> to run in "multiple files" mode.  In "multiple files" mode,
233 B<Wireshark> will write to several capture files.  When the first capture file
234 fills up, B<Wireshark> will switch writing to the next file and so on.
235
236 The created filenames are based on the filename given with the B<-w> flag,
237 the number of the file and on the creation date and time,
238 e.g. outfile_00001_20050604120117.pcap, outfile_00002_20050604120523.pcap, ...
239
240 With the I<files> option it's also possible to form a "ring buffer".
241 This will fill up new files until the number of files specified,
242 at which point B<Wireshark> will discard the data in the first file and start
243 writing to that file and so on.  If the I<files> option is not set,
244 new files filled up until one of the capture stop conditions match (or
245 until the disk is full).
246
247 The criterion is of the form I<key>B<:>I<value>,
248 where I<key> is one of:
249
250 B<duration>:I<value> switch to the next file after I<value> seconds have
251 elapsed, even if the current file is not completely filled up.
252
253 B<filesize>:I<value> switch to the next file after it reaches a size of
254 I<value> kilobytes (where a kilobyte is 1024 bytes).
255
256 B<files>:I<value> begin again with the first file after I<value> number of
257 files were written (form a ring buffer).  This value must be less than 100000.
258 Caution should be used when using large numbers of files: some filesystems do
259 not handle many files in a single directory well.  The B<files> criterion
260 requires either B<duration> or B<filesize> to be specified to control when to
261 go to the next file.  It should be noted that each B<-b> parameter takes exactly
262 one criterion; to specify two criterion, each must be preceded by the B<-b>
263 option.
264
265 Example: B<-b filesize:1024 -b files:5> results in a ring buffer of five files
266 of size one megabyte.
267
268 =item -B  E<lt>capture buffer sizeE<gt>
269
270 Set capture buffer size (in MB, default is 1MB).  This is used by the
271 the capture driver to buffer packet data until that data can be written
272 to disk.  If you encounter packet drops while capturing, try to increase
273 this size.  Note that, while B<Tshark> attempts to set the buffer size
274 to 1MB by default, and can be told to set it to a larger value, the
275 system or interface on which you're capturing might silently limit the
276 capture buffer size to a lower value or raise it to a higher value.
277
278 This is available on UNIX systems with libpcap 1.0.0 or later and on
279 Windows.  It is not available on UNIX systems with earlier versions of
280 libpcap.
281
282 This option can occur multiple times.  If used before the first
283 occurrence of the B<-i> option, it sets the default capture buffer size.
284 If used after an B<-i> option, it sets the capture buffer size for
285 the interface specified by the last B<-i> option occurring before
286 this option.  If the capture buffer size is not set specifically,
287 the default capture buffer size is used if provided.
288
289 =item -c  E<lt>capture packet countE<gt>
290
291 Set the maximum number of packets to read when capturing live
292 data.
293
294 =item -C  E<lt>configuration profileE<gt>
295
296 Start with the given configuration profile.
297
298 =item -d  E<lt>display filterE<gt>
299
300 Start with the given display filter.
301
302 =item -D
303
304 Print a list of the interfaces on which B<Wireshark> can capture, and
305 exit.  For each network interface, a number and an
306 interface name, possibly followed by a text description of the
307 interface, is printed.  The interface name or the number can be supplied
308 to the B<-i> flag to specify an interface on which to capture.
309
310 This can be useful on systems that don't have a command to list them
311 (e.g., Windows systems, or UNIX systems lacking B<ifconfig -a>);
312 the number can be useful on Windows 2000 and later systems, where the
313 interface name is a somewhat complex string.
314
315 Note that "can capture" means that B<Wireshark> was able to open
316 that device to do a live capture; if, on your system, a program doing a
317 network capture must be run from an account with special privileges (for
318 example, as root), then, if B<Wireshark> is run with the B<-D> flag and
319 is not run from such an account, it will not list any interfaces.
320
321 =item --display=E<lt>X display to useE<gt>
322
323 Specifies the X display to use.  A hostname and screen (otherhost:0.0)
324 or just a screen (:0.0) can be specified.  This option is not available
325 under Windows.
326
327 =item -f  E<lt>capture filterE<gt>
328
329 Set the capture filter expression.
330
331 This option can occur multiple times.  If used before the first
332 occurrence of the B<-i> option, it sets the default capture filter expression.
333 If used after an B<-i> option, it sets the capture filter expression for
334 the interface specified by the last B<-i> option occurring before
335 this option.  If the capture filter expression is not set specifically,
336 the default capture filter expression is used if provided.
337
338 =item -g  E<lt>packet numberE<gt>
339
340 After reading in a capture file using the B<-r> flag, go to the given I<packet number>.
341
342 =item -h
343
344 Print the version and options and exit.
345
346 =item -H
347
348 Hide the capture info dialog during live packet capture.
349
350 =item -i  E<lt>capture interfaceE<gt>|-
351
352 Set the name of the network interface or pipe to use for live packet
353 capture.
354
355 Network interface names should match one of the names listed in
356 "B<wireshark -D>" (described above); a number, as reported by
357 "B<wireshark -D>", can also be used.  If you're using UNIX, "B<netstat
358 -i>" or "B<ifconfig -a>" might also work to list interface names,
359 although not all versions of UNIX support the B<-a> flag to B<ifconfig>.
360
361 If no interface is specified, B<Wireshark> searches the list of
362 interfaces, choosing the first non-loopback interface if there are any
363 non-loopback interfaces, and choosing the first loopback interface if
364 there are no non-loopback interfaces.  If there are no interfaces at all,
365 B<Wireshark> reports an error and doesn't start the capture.
366
367 Pipe names should be either the name of a FIFO (named pipe) or ``-'' to
368 read data from the standard input.  On Windows systems, pipe names must be
369 of the form ``\\pipe\.\B<pipename>''.  Data read from pipes must be in
370 standard libpcap format.
371
372 This option can occur multiple times.  When capturing from multiple
373 interfaces, the capture file will be saved in pcap-ng format.
374
375 =item -I
376
377 Put the interface in "monitor mode"; this is supported only on IEEE
378 802.11 Wi-Fi interfaces, and supported only on some operating systems.
379
380 Note that in monitor mode the adapter might disassociate from the
381 network with which it's associated, so that you will not be able to use
382 any wireless networks with that adapter.  This could prevent accessing
383 files on a network server, or resolving host names or network addresses,
384 if you are capturing in monitor mode and are not connected to another
385 network with another adapter.
386
387 This option can occur multiple times.  If used before the first
388 occurrence of the B<-i> option, it enables the monitor mode for all interfaces.
389 If used after an B<-i> option, it enables the monitor mode for
390 the interface specified by the last B<-i> option occurring before
391 this option.
392
393 =item -J  E<lt>jump filterE<gt>
394
395 After reading in a capture file using the B<-r> flag, jump to the packet
396 matching the filter (display filter syntax).  If no exact match is found
397 the first packet after that is selected.
398
399 =item -j
400
401 Use after B<-J> to change the behavior when no exact match is found for
402 the filter.  With this option select the first packet before.
403
404 =item -k
405
406 Start the capture session immediately.  If the B<-i> flag was
407 specified, the capture uses the specified interface.  Otherwise,
408 B<Wireshark> searches the list of interfaces, choosing the first
409 non-loopback interface if there are any non-loopback interfaces, and
410 choosing the first loopback interface if there are no non-loopback
411 interfaces; if there are no interfaces, B<Wireshark> reports an error and
412 doesn't start the capture.
413
414 =item -K  E<lt>keytabE<gt>
415
416 Load kerberos crypto keys from the specified keytab file.
417 This option can be used multiple times to load keys from several files.
418
419 Example: B<-K krb5.keytab>
420
421 =item -l
422
423 Turn on automatic scrolling if the packet display is being updated
424 automatically as packets arrive during a capture (as specified by the
425 B<-S> flag).
426
427 =item -L
428
429 List the data link types supported by the interface and exit.
430
431 =item -m  E<lt>fontE<gt>
432
433 Set the name of the font used by B<Wireshark> for most text.  B<Wireshark>
434 will construct the name of the bold font used for the data in the byte
435 view pane that corresponds to the field selected in the packet details
436 pane from the name of the main text font.
437
438 =item -n
439
440 Disable network object name resolution (such as hostname, TCP and UDP port
441 names), the B<-N> flag might override this one.
442
443 =item -N  E<lt>name resolving flagsE<gt>
444
445 Turn on name resolving only for particular types of addresses and port
446 numbers, with name resolving for other types of addresses and port
447 numbers turned off.  This flag overrides B<-n> if both B<-N> and B<-n> are
448 present.  If both B<-N> and B<-n> flags are not present, all name resolutions
449 are turned on.
450
451 The argument is a string that may contain the letters:
452
453 B<m> to enable MAC address resolution
454
455 B<n> to enable network address resolution
456
457 B<t> to enable transport-layer port number resolution
458
459 B<C> to enable concurrent (asynchronous) DNS lookups
460
461 =item -o  E<lt>preference/recent settingE<gt>
462
463 Set a preference or recent value, overriding the default value and any value
464 read from a preference/recent file.  The argument to the flag is a string of
465 the form I<prefname>B<:>I<value>, where I<prefname> is the name of the
466 preference/recent value (which is the same name that would appear in the
467 preference/recent file), and I<value> is the value to which it should be set.
468 Since B<Ethereal> 0.10.12, the recent settings replaces the formerly used
469 -B, -P and -T flags to manipulate the GUI dimensions.
470
471 If I<prefname> is "uat", you can override settings in various user access
472 tables using the form uatB<:>I<uat filename>:I<uat record>.  I<uat filename>
473 must be the name of a UAT file, e.g. I<user_dlts>.  I<uat_record> must be in
474 the form of a valid record for that file, including quotes.  For instance, to
475 specify a user DLT from the command line, you would use
476
477 =over
478
479 -o "uat:user_dlts:\"User 0 (DLT=147)\",\"cops\",\"0\",\"\",\"0\",\"\""
480
481 =back
482
483 =item -p
484
485 I<Don't> put the interface into promiscuous mode.  Note that the
486 interface might be in promiscuous mode for some other reason; hence,
487 B<-p> cannot be used to ensure that the only traffic that is captured is
488 traffic sent to or from the machine on which B<Wireshark> is running,
489 broadcast traffic, and multicast traffic to addresses received by that
490 machine.
491
492 This option can occur multiple times.  If used before the first
493 occurrence of the B<-i> option, no interface will be put into the
494 promiscuous mode.
495 If used after an B<-i> option, the interface specified by the last B<-i>
496 option occurring before this option will not be put into the
497 promiscuous mode.
498
499 =item -P E<lt>path settingE<gt>
500
501 Special path settings usually detected automatically.  This is used for
502 special cases, e.g. starting Wireshark from a known location on an USB stick.
503
504 The criterion is of the form I<key>B<:>I<path>, where I<key> is one of:
505
506 B<persconf>:I<path> path of personal configuration files, like the
507 preferences files.
508
509 B<persdata>:I<path> path of personal data files, it's the folder initially
510 opened.  After the very first initialization, the recent file will keep the
511 folder last used.
512
513 =item -r  E<lt>infileE<gt>
514
515 Read packet data from I<infile>, can be any supported capture file format
516 (including gzipped files).  It's not possible to use named pipes or stdin
517 here!
518
519 =item -R  E<lt>read (display) filterE<gt>
520
521 When reading a capture file specified with the B<-r> flag, causes the
522 specified filter (which uses the syntax of display filters, rather than
523 that of capture filters) to be applied to all packets read from the
524 capture file; packets not matching the filter are discarded.
525
526 =item -S
527
528 Automatically update the packet display as packets are coming in.
529
530 =item -s  E<lt>capture snaplenE<gt>
531
532 Set the default snapshot length to use when capturing live data.
533 No more than I<snaplen> bytes of each network packet will be read into
534 memory, or saved to disk.  A value of 0 specifies a snapshot length of
535 65535, so that the full packet is captured; this is the default.
536
537 This option can occur multiple times.  If used before the first
538 occurrence of the B<-i> option, it sets the default snapshot length.
539 If used after an B<-i> option, it sets the snapshot length for
540 the interface specified by the last B<-i> option occurring before
541 this option.  If the snapshot length is not set specifically,
542 the default snapshot length is used if provided.
543
544 =item -t  ad|a|r|d|dd|e
545
546 Set the format of the packet timestamp displayed in the packet list
547 window.  The format can be one of:
548
549 B<ad> absolute with date: The absolute date and time is the actual time and
550 date the packet was captured
551
552 B<a> absolute: The absolute time is the actual time the packet was captured,
553 with no date displayed
554
555 B<r> relative: The relative time is the time elapsed between the first packet
556 and the current packet
557
558 B<d> delta: The delta time is the time since the previous packet was
559 captured
560
561 B<dd> delta_displayed: The delta_displayed time is the time since the
562 previous displayed packet was captured
563
564 B<e> epoch: The time in seconds since epoch (Jan 1, 1970 00:00:00)
565
566 The default format is relative.
567
568 =item -v
569
570 Print the version and exit.
571
572 =item -w  E<lt>outfileE<gt>
573
574 Set the default capture file name.
575
576 =item -y  E<lt>capture link typeE<gt>
577
578 If a capture is started from the command line with B<-k>, set the data
579 link type to use while capturing packets.  The values reported by B<-L>
580 are the values that can be used.
581
582 This option can occur multiple times.  If used before the first
583 occurrence of the B<-i> option, it sets the default capture link type.
584 If used after an B<-i> option, it sets the capture link type for
585 the interface specified by the last B<-i> option occurring before
586 this option.  If the capture link type is not set specifically,
587 the default capture link type is used if provided.
588
589 =item -X E<lt>eXtension optionsE<gt>
590
591 Specify an option to be passed to an B<Wireshark> module.  The eXtension option
592 is in the form I<extension_key>B<:>I<value>, where I<extension_key> can be:
593
594 B<lua_script>:I<lua_script_filename> tells B<Wireshark> to load the given script in addition to the
595 default Lua scripts.
596
597 B<stdin_descr>:I<description> tells B<Wireshark> to use the given description when
598 capturing from standard input (B<-i ->).
599
600 =item -z  E<lt>statisticsE<gt>
601
602 Get B<Wireshark> to collect various types of statistics and display the result
603 in a window that updates in semi-real time.
604
605 Currently implemented statistics are:
606
607 =over 4
608
609 =item B<-z> dcerpc,srt,I<uuid>,I<major>.I<minor>[,I<filter>]
610
611 Collect call/reply SRT (Service Response Time) data for DCERPC interface I<uuid>,
612 version I<major>.I<minor>.
613 Data collected is the number of calls for each procedure, MinSRT, MaxSRT
614 and AvgSRT.
615
616 Example: S<B<-z dcerpc,srt,12345778-1234-abcd-ef00-0123456789ac,1.0>> will collect data for the CIFS SAMR Interface.
617
618 This option can be used multiple times on the command line.
619
620 If the optional I<filter>  is provided, the stats will only be calculated
621 on those calls that match that filter.
622
623 Example: S<B<-z dcerpc,srt,12345778-1234-abcd-ef00-0123456789ac,1.0,ip.addr==1.2.3.4>> will collect SAMR
624 SRT statistics for a specific host.
625
626 =item B<-z> io,stat
627
628 Collect packet/bytes statistics for the capture in intervals of 1 second.
629 This option will open a window with up to 5 color-coded graphs where
630 number-of-packets-per-second or number-of-bytes-per-second statistics
631 can be calculated and displayed.
632
633 This option can be used multiple times on the command line.
634
635 This graph window can also be opened from the Analyze:Statistics:Traffic:IO-Stat
636 menu item.
637
638 =item B<-z> rpc,srt,I<program>,I<version>[,<filter>]
639
640 Collect call/reply SRT (Service Response Time) data for I<program>/I<version>.  Data collected
641 is the number of calls for each procedure, MinSRT, MaxSRT and AvgSRT.
642
643 Example: B<-z rpc,srt,100003,3> will collect data for NFS v3.
644
645 This option can be used multiple times on the command line.
646
647 If the optional I<filter> is provided, the stats will only be calculated
648 on those calls that match that filter.
649
650 Example: S<B<-z rpc,srt,100003,3,nfs.fh.hash==0x12345678>> will collect NFS v3
651 SRT statistics for a specific file.
652
653 =item B<-z> rpc,programs
654
655 Collect call/reply SRT data for all known ONC-RPC programs/versions.
656 Data collected is the number of calls for each protocol/version, MinSRT,
657 MaxSRT and AvgSRT.
658
659 =item B<-z> scsi,srt,I<cmdset>[,<filter>]
660
661 Collect call/reply SRT (Service Response Time) data for SCSI commandset <cmdset>.
662
663 Commandsets are 0:SBC   1:SSC  5:MMC
664
665 Data collected
666 is the number of calls for each procedure, MinSRT, MaxSRT and AvgSRT.
667
668 Example: B<-z scsi,srt,0> will collect data for SCSI BLOCK COMMANDS (SBC).
669
670 This option can be used multiple times on the command line.
671
672 If the optional I<filter> is provided, the stats will only be calculated
673 on those calls that match that filter.
674
675 Example: B<-z scsi,srt,0,ip.addr==1.2.3.4> will collect SCSI SBC
676 SRT statistics for a specific iscsi/ifcp/fcip host.
677
678 =item B<-z> smb,srt[,I<filter>]
679
680 Collect call/reply SRT (Service Response Time) data for SMB.  Data collected
681 is the number of calls for each SMB command, MinSRT, MaxSRT and AvgSRT.
682
683 Example: B<-z smb,srt>
684
685 The data will be presented as separate tables for all normal SMB commands,
686 all Transaction2 commands and all NT Transaction commands.
687 Only those commands that are seen in the capture will have their stats
688 displayed.
689 Only the first command in a xAndX command chain will be used in the
690 calculation.  So for common SessionSetupAndX + TreeConnectAndX chains,
691 only the SessionSetupAndX call will be used in the statistics.
692 This is a flaw that might be fixed in the future.
693
694 This option can be used multiple times on the command line.
695
696 If the optional I<filter> is provided, the stats will only be calculated
697 on those calls that match that filter.
698
699 Example: B<-z "smb,srt,ip.addr==1.2.3.4"> will collect stats only for
700 SMB packets exchanged by the host at IP address 1.2.3.4 .
701
702 =item B<-z> fc,srt[,I<filter>]
703
704 Collect call/reply SRT (Service Response Time) data for FC.  Data collected
705 is the number of calls for each Fibre Channel command, MinSRT, MaxSRT and AvgSRT.
706
707 Example: B<-z fc,srt>
708 will calculate the Service Response Time as the time delta between the
709 First packet of the exchange and the Last packet of the exchange.
710
711 The data will be presented as separate tables for all normal FC commands,
712 Only those commands that are seen in the capture will have its stats
713 displayed.
714
715 This option can be used multiple times on the command line.
716
717 If the optional I<filter> is provided, the stats will only be calculated
718 on those calls that match that filter.
719
720 Example: B<-z "fc,srt,fc.id==01.02.03"> will collect stats only for
721 FC packets exchanged by the host at FC address 01.02.03 .
722
723 =item B<-z> ldap,srt[,I<filter>]
724
725 Collect call/reply SRT (Service Response Time) data for LDAP.  Data collected
726 is the number of calls for each implemented LDAP command, MinSRT, MaxSRT and AvgSRT.
727
728 Example: B<-z ldap,srt>
729 will calculate the Service Response Time as the time delta between the
730 Request and the Response.
731
732 The data will be presented as separate tables for all implemented LDAP commands,
733 Only those commands that are seen in the capture will have its stats
734 displayed.
735
736 This option can be used multiple times on the command line.
737
738 If the optional I<filter> is provided, the stats will only be calculated
739 on those calls that match that filter.
740
741 Example: use B<-z "ldap,srt,ip.addr==10.1.1.1"> will collect stats only for
742 LDAP packets exchanged by the host at IP address 10.1.1.1 .
743
744 The only LDAP commands that are currently implemented and for which the stats will be available are:
745 BIND
746 SEARCH
747 MODIFY
748 ADD
749 DELETE
750 MODRDN
751 COMPARE
752 EXTENDED
753
754 =item B<-z> mgcp,srt[I<,filter>]
755
756 Collect request/response SRT (Service Response Time) data for MGCP.
757 (This is similar to B<-z smb,srt>).  Data collected is the number of calls
758 for each known MGCP Type, Minimum SRT, Maximum SRT and Average SRT.
759
760 Example: B<-z mgcp,srt>
761
762 This option can be used multiple times on the command line.
763
764 If the optional I<filter> is provided, the stats will only be calculated
765 on those calls that match that filter.
766
767 Example: B<-z "mgcp,srt,ip.addr==1.2.3.4"> will collect stats only for
768 MGCP packets exchanged by the host at IP address 1.2.3.4 .
769
770 =item B<-z> megaco,srt[I<,filter>]
771
772 Collect request/response SRT (Service Response Time) data for MEGACO.
773 (This is similar to B<-z smb,srt>).  Data collected is the number of calls
774 for each known MEGACO Command, Minimum SRT, Maximum SRT and Average SRT.
775
776 Example: B<-z megaco,srt>
777
778 This option can be used multiple times on the command line.
779
780 If the optional I<filter> is provided, the stats will only be calculated
781 on those calls that match that filter.
782
783 Example: B<-z "megaco,srt,ip.addr==1.2.3.4"> will collect stats only for
784 MEGACO packets exchanged by the host at IP address 1.2.3.4 .
785
786 =item B<-z> conv,I<type>[,I<filter>]
787
788 Create a table that lists all conversations that could be seen in the
789 capture.  I<type> specifies the conversation endpoint types for which we
790 want to generate the statistics; currently the supported ones are:
791
792   "eth"   Ethernet addresses
793   "fc"    Fibre Channel addresses
794   "fddi"  FDDI addresses
795   "ip"    IPv4 addresses
796   "ipv6"  IPv6 addresses
797   "ipx"   IPX addresses
798   "tcp"   TCP/IP socket pairs   Both IPv4 and IPv6 are supported
799   "tr"    Token Ring addresses
800   "udp"   UDP/IP socket pairs   Both IPv4 and IPv6 are supported
801
802 If the optional I<filter> is specified, only those packets that match the
803 filter will be used in the calculations.
804
805 The table is presented with one line for each conversation and displays
806 the number of packets/bytes in each direction as well as the total
807 number of packets/bytes.  By default, the table is sorted according to
808 the total number of packets.
809
810 These tables can also be generated at runtime by selecting the appropriate
811 conversation type from the menu "Tools/Statistics/Conversation List/".
812
813 =item B<-z> h225,counter[I<,filter>]
814
815 Count ITU-T H.225 messages and their reasons.  In the first column you get a
816 list of H.225 messages and H.225 message reasons which occur in the current
817 capture file.  The number of occurrences of each message or reason is displayed
818 in the second column.
819
820 Example: B<-z h225,counter>
821
822 This option can be used multiple times on the command line.
823
824 If the optional I<filter> is provided, the stats will only be calculated
825 on those calls that match that filter.
826
827 Example: B<-z "h225,counter,ip.addr==1.2.3.4"> will collect stats only for
828 H.225 packets exchanged by the host at IP address 1.2.3.4 .
829
830 =item B<-z> h225,srt[I<,filter>]
831
832 Collect request/response SRT (Service Response Time) data for ITU-T H.225 RAS.
833 Data collected is the number of calls of each ITU-T H.225 RAS Message Type,
834 Minimum SRT, Maximum SRT, Average SRT, Minimum in Packet, and Maximum in Packet.
835 You will also get the number of Open Requests (Unresponded Requests),
836 Discarded Responses (Responses without matching request) and Duplicate Messages.
837
838 Example: B<-z h225,srt>
839
840 This option can be used multiple times on the command line.
841
842 If the optional I<filter> is provided, the stats will only be calculated
843 on those calls that match that filter.
844
845 Example: B<-z "h225,srt,ip.addr==1.2.3.4"> will collect stats only for
846 ITU-T H.225 RAS packets exchanged by the host at IP address 1.2.3.4 .
847
848 =item B<-z> sip,stat[I<,filter>]
849
850 This option will activate a counter for SIP messages.  You will get the number
851 of occurrences of each SIP Method and of each SIP Status-Code.  Additionally you
852 also get the number of resent SIP Messages (only for SIP over UDP).
853
854 Example: B<-z sip,stat>
855
856 This option can be used multiple times on the command line.
857
858 If the optional I<filter> is provided, the stats will only be calculated
859 on those calls that match that filter.
860
861 Example: B<-z "sip,stat,ip.addr==1.2.3.4"> will collect stats only for
862 SIP packets exchanged by the host at IP address 1.2.3.4 .
863
864 =item B<-z> voip,calls
865
866 This option will show a window that shows VoIP calls found in the capture file.
867 This is the same window shown as when you go to the Statistics Menu and choose
868 VoIP Calls.
869
870 Example: B<-z voip,calls>
871
872 =back
873
874 =back
875
876 =head1 INTERFACE
877
878 =head2 MENU ITEMS
879
880 =over 4
881
882 =item File:Open
883
884 =item File:Open Recent
885
886 =item File:Merge
887
888 Merge another capture file to the currently loaded one.  The I<File:Merge>
889 dialog box allows the merge "Prepended", "Chronologically" or "Appended",
890 relative to the already loaded one.
891
892 =item File:Close
893
894 Open or close a capture file.  The I<File:Open> dialog box
895 allows a filter to be specified; when the capture file is read, the
896 filter is applied to all packets read from the file, and packets not
897 matching the filter are discarded.  The I<File:Open Recent> is a submenu
898 and will show a list of previously opened files.
899
900 =item File:Save
901
902 =item File:Save As
903
904 Save the current capture, or the packets currently displayed from that
905 capture, to a file.  Check boxes let you select whether to save all
906 packets, or just those that have passed the current display filter and/or
907 those that are currently marked, and an option menu lets you select (from
908 a list of file formats in which at particular capture, or the packets
909 currently displayed from that capture, can be saved), a file format in
910 which to save it.
911
912 =item File:File Set:List Files
913
914 Show a dialog box that lists all files of the file set matching the currently
915 loaded file.  A file set is a compound of files resulting from a capture using
916 the "multiple files" / "ringbuffer" mode, recognizable by the filename pattern,
917 e.g.: Filename_00001_20050604101530.pcap.
918
919 =item File:File Set:Next File
920
921 =item File:File Set:Previous File
922
923 If the currently loaded file is part of a file set (see above), open the
924 next / previous file in that set.
925
926 =item File:Export
927
928 Export captured data into an external format.  Note: the data cannot be
929 imported back into Wireshark, so be sure to keep the capture file.
930
931 =item File:Print
932
933 Print packet data from the current capture.  You can select the range of
934 packets to be printed (which packets are printed), and the output format of
935 each packet (how each packet is printed).  The output format will be similar
936 to the displayed values, so a summary line, the packet details view, and/or
937 the hex dump of the packet can be printed.
938
939 Printing options can be set with the I<Edit:Preferences> menu item, or in the
940 dialog box popped up by this menu item.
941
942 =item File:Quit
943
944 Exit the application.
945
946 =item Edit:Copy:Description
947
948 Copies the description of the selected field in the protocol tree to
949 the clipboard.
950
951 =item Edit:Copy:Fieldname
952
953 Copies the fieldname of the selected field in the protocol tree to
954 the clipboard.
955
956 =item Edit:Copy:Value
957
958 Copies the value of the selected field in the protocol tree to
959 the clipboard.
960
961 =item Edit:Copy:As Filter
962
963 Create a display filter based on the data currently highlighted in the
964 packet details and copy that filter to the clipboard.
965
966 If that data is a field that can be tested in a display filter
967 expression, the display filter will test that field; otherwise, the
968 display filter will be based on the absolute offset within the packet.
969 Therefore it could be unreliable if the packet contains protocols with
970 variable-length headers, such as a source-routed token-ring packet.
971
972 =item Edit:Find Packet
973
974 Search forward or backward, starting with the currently selected packet
975 (or the most recently selected packet, if no packet is selected).  Search
976 criteria can be a display filter expression, a string of hexadecimal
977 digits, or a text string.
978
979 When searching for a text string, you can search the packet data, or you
980 can search the text in the Info column in the packet list pane or in the
981 packet details pane.
982
983 Hexadecimal digits can be separated by colons, periods, or dashes.
984 Text string searches can be ASCII or Unicode (or both), and may be
985 case insensitive.
986
987 =item Edit:Find Next
988
989 =item Edit:Find Previous
990
991 Search forward / backward for a packet matching the filter from the previous
992 search, starting with the currently selected packet (or the most recently
993 selected packet, if no packet is selected).
994
995 =item Edit:Mark Packet (toggle)
996
997 Mark (or unmark if currently marked) the selected packet.  The field
998 "frame.marked" is set for packets that are marked, so that, for example,
999 a display filters can be used to display only marked packets, and so that
1000 the L<Edit:Find Packet|/item_edit_3afind_packet> dialog can be used to find the next or previous
1001 marked packet.
1002
1003 =item Edit:Find Next Mark
1004
1005 =item Edit:Find Previous Mark
1006
1007 Find next/previous marked packet.
1008
1009 =item Edit:Mark All Packets
1010
1011 =item Edit:Unmark All Packets
1012
1013 Mark / Unmark all packets that are currently displayed.
1014
1015 =item Edit:Time Reference:Set Time Reference (toggle)
1016
1017 Set (or unset if currently set) the selected packet as a Time Reference packet.
1018 When a packet is set as a Time Reference packet, the timestamps in the packet
1019 list pane will be replaced with the string "*REF*".
1020 The relative time timestamp in later packets will then be calculated relative
1021 to the timestamp of this Time Reference packet and not the first packet in
1022 the capture.
1023
1024 Packets that have been selected as Time Reference packets will always be
1025 displayed in the packet list pane.  Display filters will not affect or
1026 hide these packets.
1027
1028 If there is a column displayed for "Cumulative Bytes" this counter will
1029 be reset at every Time Reference packet.
1030
1031 =item Edit:Time Reference:Find Next
1032
1033 =item Edit:Time Reference:Find Previous
1034
1035 Search forward / backward for a time referenced packet.
1036
1037 =item Edit:Configuration Profiles
1038
1039 Manage configuration profiles to be able to use more than one set of
1040 preferences and configurations.
1041
1042 =item Edit:Preferences
1043
1044 Set the GUI, capture, printing and protocol options
1045 (see L<Preferences|/item_preferences> dialog below).
1046
1047 =item View:Main Toolbar
1048
1049 =item View:Filter Toolbar
1050
1051 =item View:Statusbar
1052
1053 Show or hide the main window controls.
1054
1055 =item View:Packet List
1056
1057 =item View:Packet Details
1058
1059 =item View:Packet Bytes
1060
1061 Show or hide the main window panes.
1062
1063 =item View:Time Display Format
1064
1065 Set the format of the packet timestamp displayed in the packet list window.
1066
1067 =item View:Name Resolution:Resolve Name
1068
1069 Try to resolve a name for the currently selected item.
1070
1071 =item View:Name Resolution:Enable for ... Layer
1072
1073 Enable or disable translation of addresses to names in the display.
1074
1075 =item View:Colorize Packet List
1076
1077 Enable or disable the coloring rules.  Disabling will improve performance.
1078
1079 =item View:Auto Scroll in Live Capture
1080
1081 Enable or disable the automatic scrolling of the
1082 packet list while a live capture is in progress.
1083
1084 =item View:Zoom In
1085
1086 =item View:Zoom Out
1087
1088 Zoom into / out of the main window data (by changing the font size).
1089
1090 =item View:Normal Size
1091
1092 Reset the zoom factor of zoom in / zoom out back to normal font size.
1093
1094 =item View:Resize All Columns
1095
1096 Resize all columns to best fit the current packet display.
1097
1098 =item View:Expand Subtrees
1099
1100 Expands the currently selected item and it's subtrees in the packet details.
1101
1102 =item View:Expand All
1103
1104 =item View:Collapse All
1105
1106 Expand / Collapse all branches of the packet details.
1107
1108 =item View:Colorize Conversation
1109
1110 Select color for a conversation.
1111
1112 =item View:Reset Coloring 1-10
1113
1114 Reset Color for a conversation.
1115
1116 =item View:Coloring Rules
1117
1118 Change the foreground and background colors of the packet information in
1119 the list of packets, based upon display filters.  The list of display
1120 filters is applied to each packet sequentially.  After the first display
1121 filter matches a packet, any additional display filters in the list are
1122 ignored.  Therefore, if you are filtering on the existence of protocols,
1123 you should list the higher-level protocols first, and the lower-level
1124 protocols last.
1125
1126 =over
1127
1128 =item How Colorization Works
1129
1130 Packets are colored according to a list of color filters.  Each filter
1131 consists of a name, a filter expression and a coloration.  A packet is
1132 colored according to the first filter that it matches.  Color filter
1133 expressions use exactly the same syntax as display filter expressions.
1134
1135 When Wireshark starts, the color filters are loaded from:
1136
1137 =over
1138
1139 1. The user's personal color filters file or, if that does not exist,
1140
1141 2. The global color filters file.
1142
1143 =back
1144
1145 If neither of these exist then the packets will not be colored.
1146
1147 =back
1148
1149 =item View:Show Packet In New Window
1150
1151 Create a new window containing a packet details view and a hex dump
1152 window of the currently selected packet; this window will continue to
1153 display that packet's details and data even if another packet is
1154 selected.
1155
1156 =item View:Reload
1157
1158 Reload a capture file.  Same as I<File:Close> and I<File:Open> the same
1159 file again.
1160
1161 =item Go:Back
1162
1163 Go back in previously visited packets history.
1164
1165 =item Go:Forward
1166
1167 Go forward in previously visited packets history.
1168
1169 =item Go:Go To Packet
1170
1171 Go to a particular numbered packet.
1172
1173 =item Go:Go To Corresponding Packet
1174
1175 If a field in the packet details pane containing a packet number is
1176 selected, go to the packet number specified by that field.  (This works
1177 only if the dissector that put that entry into the packet details put it
1178 into the details as a filterable field rather than just as text.) This
1179 can be used, for example, to go to the packet for the request
1180 corresponding to a reply, or the reply corresponding to a request, if
1181 that packet number has been put into the packet details.
1182
1183 =item Go:Previous Packet
1184
1185 =item Go:Next Packet
1186
1187 =item Go:First Packet
1188
1189 =item Go:Last Packet
1190
1191 Go to the previous / next / first / last packet in the capture.
1192
1193 =item Go:Previous Packet In Conversation
1194
1195 =item Go:Next Packet In Conversation
1196
1197 Go to the previous / next packet of the conversation (TCP, UDP or IP)
1198
1199 =item Capture:Interfaces
1200
1201 Shows a dialog box with all currently known interfaces and displaying the
1202 current network traffic amount.  Capture sessions can be started from here.
1203 Beware: keeping this box open results in high system load!
1204
1205 =item Capture:Options
1206
1207 Initiate a live packet capture (see L<Capture Options|/item_capture_options>
1208 dialog below).  If no filename is specified, a temporary file will be created
1209 to hold the capture.  The location of the file can be chosen by setting your
1210 TMPDIR environment variable before starting B<Wireshark>.  Otherwise, the
1211 default TMPDIR location is system-dependent, but is likely either F</var/tmp>
1212 or F</tmp>.
1213
1214 =item Capture:Start
1215
1216 Start a live packet capture with the previously selected options.  This won't
1217 open the options dialog box, and can be convenient for repeatedly capturing
1218 with the same options.
1219
1220 =item Capture:Stop
1221
1222 Stop a running live capture.
1223
1224 =item Capture:Restart
1225
1226 While a live capture is running, stop it and restart with the same options
1227 again.  This can be convenient to remove irrelevant packets, if no valuable
1228 packets were captured so far.
1229
1230 =item Capture:Capture Filters
1231
1232 Edit the saved list of capture filters, allowing filters to be added,
1233 changed, or deleted.
1234
1235 =item Analyze:Display Filters
1236
1237 Edit the saved list of display filters, allowing filters to be added,
1238 changed, or deleted.
1239
1240 =item Analyze:Display Filter Macros
1241
1242 Create shortcuts for complex macros
1243
1244 =item Analyze:Apply as Filter
1245
1246 Create a display filter based on the data currently highlighted in the
1247 packet details and apply the filter.
1248
1249 If that data is a field that can be tested in a display filter
1250 expression, the display filter will test that field; otherwise, the
1251 display filter will be based on the absolute offset within the packet.
1252 Therefore it could be unreliable if the packet contains protocols with
1253 variable-length headers, such as a source-routed token-ring packet.
1254
1255 The B<Selected> option creates a display filter that tests for a match
1256 of the data; the B<Not Selected> option creates a display filter that
1257 tests for a non-match of the data.  The B<And Selected>, B<Or Selected>,
1258 B<And Not Selected>, and B<Or Not Selected> options add to the end of
1259 the display filter in the strip at the top (or bottom) an AND or OR
1260 operator followed by the new display filter expression.
1261
1262 =item Analyze:Prepare a Filter
1263
1264 Create a display filter based on the data currently highlighted in the
1265 packet details.  The filter strip at the top (or bottom) is updated but
1266 it is not yet applied.
1267
1268 =item Analyze:Enabled Protocols
1269
1270 Allow protocol dissection to be enabled or disabled for a specific
1271 protocol.  Individual protocols can be enabled or disabled by clicking
1272 on them in the list or by highlighting them and pressing the space bar.
1273 The entire list can be enabled, disabled, or inverted using the buttons
1274 below the list.
1275
1276 When a protocol is disabled, dissection in a particular packet stops
1277 when that protocol is reached, and Wireshark moves on to the next packet.
1278 Any higher-layer protocols that would otherwise have been processed will
1279 not be displayed.  For example, disabling TCP will prevent the dissection
1280 and display of TCP, HTTP, SMTP, Telnet, and any other protocol exclusively
1281 dependent on TCP.
1282
1283 The list of protocols can be saved, so that Wireshark will start up with
1284 the protocols in that list disabled.
1285
1286 =item Analyze:Decode As
1287
1288 If you have a packet selected, present a dialog allowing you to change
1289 which dissectors are used to decode this packet.  The dialog has one
1290 panel each for the link layer, network layer and transport layer
1291 protocol/port numbers, and will allow each of these to be changed
1292 independently.  For example, if the selected packet is a TCP packet to
1293 port 12345, using this dialog you can instruct Wireshark to decode all
1294 packets to or from that TCP port as HTTP packets.
1295
1296 =item Analyze:User Specified Decodes
1297
1298 Create a new window showing whether any protocol ID to dissector
1299 mappings have been changed by the user.  This window also allows the
1300 user to reset all decodes to their default values.
1301
1302 =item Analyze:Follow TCP Stream
1303
1304 If you have a TCP packet selected, display the contents of the data
1305 stream for the TCP connection to which that packet belongs, as text, in
1306 a separate window, and leave the list of packets in a filtered state,
1307 with only those packets that are part of that TCP connection being
1308 displayed.  You can revert to your old view by pressing ENTER in the
1309 display filter text box, thereby invoking your old display filter (or
1310 resetting it back to no display filter).
1311
1312 The window in which the data stream is displayed lets you select:
1313
1314 =over 8
1315
1316 =item *
1317
1318 whether to display the entire conversation, or one or the other side of
1319 it;
1320
1321 =item *
1322
1323 whether the data being displayed is to be treated as ASCII or EBCDIC
1324 text or as raw hex data;
1325
1326 =back
1327
1328 and lets you print what's currently being displayed, using the same
1329 print options that are used for the I<File:Print Packet> menu item, or
1330 save it as text to a file.
1331
1332 =item Analyze:Follow UDP Stream
1333
1334 =item Analyze:Follow SSL Stream
1335
1336 (Similar to Analyze:Follow TCP Stream)
1337
1338 =item Analyze:Expert Info
1339
1340 =item Analyze:Expert Info Composite
1341
1342 (Kind of) a log of anomalies found by Wireshark in a capture file.
1343
1344 =item Analyze:Conversation Filter
1345
1346 =item Statistics:Summary
1347
1348 Show summary information about the capture, including elapsed time,
1349 packet counts, byte counts, and the like.  If a display filter is in
1350 effect, summary information will be shown about the capture and about
1351 the packets currently being displayed.
1352
1353 =item Statistics:Protocol Hierarchy
1354
1355 Show the number of packets, and the number of bytes in those packets,
1356 for each protocol in the trace.  It organizes the protocols in the same
1357 hierarchy in which they were found in the trace.  Besides counting the
1358 packets in which the protocol exists, a count is also made for packets
1359 in which the protocol is the last protocol in the stack.  These
1360 last-protocol counts show you how many packets (and the byte count
1361 associated with those packets) B<ended> in a particular protocol.  In
1362 the table, they are listed under "End Packets" and "End Bytes".
1363
1364 =item Statistics:Conversations
1365
1366 Lists of conversations; selectable by protocol.  See Statistics:Conversation List below.
1367
1368 =item Statistics:End Points
1369
1370 List of End Point Addresses by protocol with packets/bytes/.... counts.
1371
1372 =item Statistics:Packet Lengths
1373
1374 Grouped counts of packet lengths (0-19 bytes, 20-39 bytes, ...)
1375
1376 =item Statistics:IO Graphs
1377
1378 Open a window where up to 5 graphs in different colors can be displayed
1379 to indicate number of packets or number of bytes per second for all packets
1380 matching the specified filter.
1381 By default only one graph will be displayed showing number of packets per second.
1382
1383 The top part of the window contains the graphs and scales for the X and
1384 Y axis.  If the graph is too long to fit inside the window there is a
1385 horizontal scrollbar below the drawing area that can scroll the graphs
1386 to the left or the right.  The horizontal axis displays the time into
1387 the capture and the vertical axis will display the measured quantity at
1388 that time.
1389
1390 Below the drawing area and the scrollbar are the controls.  On the
1391 bottom left there will be five similar sets of controls to control each
1392 individual graph such as "Display:<button>" which button will toggle
1393 that individual graph on/off.  If <button> is ticked, the graph will be
1394 displayed.  "Color:<color>" which is just a button to show which color
1395 will be used to draw that graph (color is only available in Gtk2
1396 version) and finally "Filter:<filter-text>" which can be used to specify
1397 a display filter for that particular graph.
1398
1399 If filter-text is empty then all packets will be used to calculate the
1400 quantity for that graph.  If filter-text is specified only those packets
1401 that match that display filter will be considered in the calculation of
1402 quantity.
1403
1404 To the right of the 5 graph controls there are four menus to control
1405 global aspects of the draw area and graphs.  The "Unit:" menu is used to
1406 control what to measure; "packets/tick", "bytes/tick" or "advanced..."
1407
1408 packets/tick will measure the number of packets matching the (if
1409 specified) display filter for the graph in each measurement interval.
1410
1411 bytes/tick will measure the total number of bytes in all packets matching
1412 the (if specified) display filter for the graph in each measurement
1413 interval.
1414
1415 advanced... see below
1416
1417 "Tick interval:" specifies what measurement intervals to use.  The
1418 default is 1 second and means that the data will be counted over 1
1419 second intervals.
1420
1421 "Pixels per tick:" specifies how many pixels wide each measurement
1422 interval will be in the drawing area.  The default is 5 pixels per tick.
1423
1424 "Y-scale:" controls the max value for the y-axis.  Default value is
1425 "auto" which means that B<Wireshark> will try to adjust the maxvalue
1426 automatically.
1427
1428 "advanced..." If Unit:advanced...  is selected the window will display
1429 two more controls for each of the five graphs.  One control will be a
1430 menu where the type of calculation can be selected from
1431 SUM,COUNT,MAX,MIN,AVG and LOAD, and one control, textbox, where the name of a
1432 single display filter field can be specified.
1433
1434 The following restrictions apply to type and field combinations:
1435
1436 SUM: available for all types of integers and will calculate the SUM of
1437 all occurrences of this field in the measurement interval.  Note that
1438 some field can occur multiple times in the same packet and then all
1439 instances will be summed up.  Example: 'tcp.len' which will count the
1440 amount of payload data transferred across TCP in each interval.
1441
1442 COUNT: available for all field types.  This will COUNT the number of times
1443 certain field occurs in each interval.  Note that some fields
1444 may occur multiple times in each packet and if that is the case
1445 then each instance will be counted independently and COUNT
1446 will be greater than the number of packets.
1447
1448 MAX: available for all integer and relative time fields.  This will calculate
1449 the max seen integer/time value seen for the field during the interval.
1450 Example: 'smb.time' which will plot the maximum SMB response time.
1451
1452 MIN: available for all integer and relative time fields.  This will calculate
1453 the min seen integer/time value seen for the field during the interval.
1454 Example: 'smb.time' which will plot the minimum SMB response time.
1455
1456 AVG: available for all integer and relative time fields.This will
1457 calculate the average seen integer/time value seen for the field during
1458 the interval.  Example: 'smb.time' which will plot the average SMB
1459 response time.
1460
1461 LOAD: available only for relative time fields (response times).
1462
1463 Example of advanced:
1464 Display how NFS response time MAX/MIN/AVG changes over time:
1465
1466 Set first graph to:
1467
1468    filter:nfs&&rpc.time
1469    Calc:MAX rpc.time
1470
1471 Set second graph to
1472
1473    filter:nfs&&rpc.time
1474    Calc:AVG rpc.time
1475
1476 Set third graph to
1477
1478    filter:nfs&&rpc.time
1479    Calc:MIN rpc.time
1480
1481 Example of advanced:
1482 Display how the average packet size from host a.b.c.d changes over time.
1483
1484 Set first graph to
1485
1486    filter:ip.addr==a.b.c.d&&frame.pkt_len
1487    Calc:AVG frame.pkt_len
1488
1489 LOAD:
1490 The LOAD io-stat type is very different from anything you have ever seen
1491 before! While the response times themselves as plotted by MIN,MAX,AVG are
1492 indications on the Server load (which affects the Server response time),
1493 the LOAD measurement measures the Client LOAD.
1494 What this measures is how much workload the client generates,
1495 i.e. how fast will the client issue new commands when the previous ones
1496 completed.
1497 i.e. the level of concurrency the client can maintain.
1498 The higher the number, the more and faster is the client issuing new
1499 commands.  When the LOAD goes down, it may be due to client load making
1500 the client slower in issuing new commands (there may be other reasons as
1501 well, maybe the client just doesn't have any commands it wants to issue
1502 right then).
1503
1504 Load is measured in concurrency/number of overlapping i/o and the value
1505 1000 means there is a constant load of one i/o.
1506
1507 In each tick interval the amount of overlap is measured.
1508 See the graph below containing three commands:
1509 Below the graph are the LOAD values for each interval that would be calculated.
1510
1511   |     |     |     |     |     |     |     |     |
1512   |     |     |     |     |     |     |     |     |
1513   |     |  o=====*  |     |     |     |     |     |
1514   |     |     |     |     |     |     |     |     |
1515   |  o========*     | o============*  |     |     |
1516   |     |     |     |     |     |     |     |     |
1517   --------------------------------------------------> Time
1518    500   1500   500  750   1000   500    0     0
1519
1520 =item Statistics:Conversation List
1521
1522 This option will open a new window that displays a list of all
1523 conversations between two endpoints.  The list has one row for each
1524 unique conversation and displays total number of packets/bytes seen as
1525 well as number of packets/bytes in each direction.
1526
1527 By default the list is sorted according to the number of packets but by
1528 clicking on the column header; it is possible to re-sort the list in
1529 ascending or descending order by any column.
1530
1531 By first selecting a conversation by clicking on it and then using the
1532 right mouse button (on those platforms that have a right
1533 mouse button) wireshark will display a popup menu offering several different
1534 filter operations to apply to the capture.
1535
1536 These statistics windows can also be invoked from the Wireshark command
1537 line using the B<-z conv> argument.
1538
1539 =item Statistics:Service Response Time
1540
1541 =over 4
1542
1543 =item *
1544
1545 AFP
1546
1547 =item *
1548
1549 CAMEL
1550
1551 =item *
1552
1553 DCE-RPC
1554
1555 Open a window to display Service Response Time statistics for an
1556 arbitrary DCE-RPC program
1557 interface and display B<Procedure>, B<Number of Calls>, B<Minimum SRT>,
1558 B<Maximum SRT> and B<Average SRT> for all procedures for that
1559 program/version.  These windows opened will update in semi-real time to
1560 reflect changes when doing live captures or when reading new capture
1561 files into B<Wireshark>.
1562
1563 This dialog will also allow an optional filter string to be used.
1564 If an optional filter string is used only such DCE-RPC request/response pairs
1565 that match that filter will be used to calculate the statistics.  If no filter
1566 string is specified all request/response pairs will be used.
1567
1568 =item *
1569
1570 Diameter
1571
1572 =item *
1573
1574 Fibre Channel
1575
1576 Open a window to display Service Response Time statistics for Fibre Channel
1577 and display B<FC Type>, B<Number of Calls>, B<Minimum SRT>,
1578 B<Maximum SRT> and B<Average SRT> for all FC types.
1579 These windows opened will update in semi-real time to
1580 reflect changes when doing live captures or when reading new capture
1581 files into B<Wireshark>.
1582 The Service Response Time is calculated as the time delta between the
1583 First packet of the exchange and the Last packet of the exchange.
1584
1585 This dialog will also allow an optional filter string to be used.
1586 If an optional filter string is used only such FC first/last exchange pairs
1587 that match that filter will be used to calculate the statistics.  If no filter
1588 string is specified all request/response pairs will be used.
1589
1590 =item *
1591
1592 GTP
1593
1594 =item *
1595
1596 H.225 RAS
1597
1598 Collect requests/response SRT (Service Response Time) data for ITU-T H.225 RAS.
1599 Data collected is B<number of calls> for each known ITU-T H.225 RAS Message Type,
1600 B<Minimum SRT>, B<Maximum SRT>, B<Average SRT>, B<Minimum in Packet>, and B<Maximum in Packet>.
1601 You will also get the number of B<Open Requests> (Unresponded Requests),
1602 B<Discarded Responses> (Responses without matching request) and Duplicate Messages.
1603 These windows opened will update in semi-real time to reflect changes when
1604 doing live captures or when reading new capture files into B<Wireshark>.
1605
1606 You can apply an optional filter string in a dialog box, before starting
1607 the calculation.  The statistics will only be calculated
1608 on those calls matching that filter.
1609
1610 =item *
1611
1612 LDAP
1613
1614 =item *
1615
1616 MEGACO
1617
1618 =item *
1619
1620 MGCP
1621
1622 Collect requests/response SRT (Service Response Time) data for MGCP.
1623 Data collected is B<number of calls> for each known MGCP Type,
1624 B<Minimum SRT>, B<Maximum SRT>, B<Average SRT>, B<Minimum in Packet>, and B<Maximum in Packet>.
1625 These windows opened will update in semi-real time to reflect changes when
1626 doing live captures or when reading new capture files into B<Wireshark>.
1627
1628 You can apply an optional filter string in a dialog box, before starting
1629 the calculation.  The statistics will only be calculated
1630 on those calls matching that filter.
1631
1632 =item *
1633
1634 NCP
1635
1636 =item *
1637
1638 ONC-RPC
1639
1640 Open a window to display statistics for an arbitrary ONC-RPC program interface
1641 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.
1642 These windows opened will update in semi-real time to reflect changes when
1643 doing live captures or when reading new capture files into B<Wireshark>.
1644
1645 This dialog will also allow an optional filter string to be used.
1646 If an optional filter string is used only such ONC-RPC request/response pairs
1647 that match that filter will be used to calculate the statistics.  If no filter
1648 string is specified all request/response pairs will be used.
1649
1650 By first selecting a conversation by clicking on it and then using the
1651 right mouse button (on those platforms that have a right
1652 mouse button) wireshark will display a popup menu offering several different
1653 filter operations to apply to the capture.
1654
1655 =item *
1656
1657 RADIUS
1658
1659 =item *
1660
1661 SCSI
1662
1663 =item *
1664
1665 SMB
1666
1667 Collect call/reply SRT (Service Response Time) data for SMB.  Data collected
1668 is the number of calls for each SMB command, MinSRT, MaxSRT and AvgSRT.
1669
1670 The data will be presented as separate tables for all normal SMB commands,
1671 all Transaction2 commands and all NT Transaction commands.
1672 Only those commands that are seen in the capture will have its stats
1673 displayed.
1674 Only the first command in a xAndX command chain will be used in the
1675 calculation.  So for common SessionSetupAndX + TreeConnectAndX chains,
1676 only the SessionSetupAndX call will be used in the statistics.
1677 This is a flaw that might be fixed in the future.
1678
1679 You can apply an optional filter string in a dialog box, before starting
1680 the calculation.  The stats will only be calculated
1681 on those calls matching that filter.
1682
1683 By first selecting a conversation by clicking on it and then using the
1684 right mouse button (on those platforms that have a right
1685 mouse button) wireshark will display a popup menu offering several different
1686 filter operations to apply to the capture.
1687
1688 =item *
1689
1690 SMB2
1691
1692 =back
1693
1694 =item Statistics:BOOTP-DHCP
1695
1696
1697
1698 =item Statistics:Compare
1699
1700 Compare two Capture Files
1701
1702 =item Statistics:Flow Graph
1703
1704 Flow Graph: General/TCP
1705
1706 =item Statistics:HTTP
1707
1708 HTTP Load Distribution, Packet Counter & Requests
1709
1710 =item Statistics:IP Addresses
1711
1712 Count/Rate/Percent by IP Address
1713
1714 =item Statistics:IP Destinations
1715
1716 Count/Rate/Percent by IP Address/protocol/port
1717
1718 =item Statistics:IP Protocol Types
1719
1720 Count/Rate/Percent by IP Protocol Types
1721
1722 =item Statistics:ONC-RPC Programs
1723
1724 This dialog will open a window showing aggregated SRT statistics for all
1725 ONC-RPC Programs/versions that exist in the capture file.
1726
1727 =item Statistics:TCP Stream Graph
1728
1729 Graphs: Round Trip; Throughput; Time-Sequence (Stevens); Time-Sequence (tcptrace)
1730
1731 =item Statistics:UDP Multicast streams
1732
1733 Multicast Streams Counts/Rates/... by Source/Destination Address/Port pairs
1734
1735 =item Statistics:WLAN Traffic
1736
1737 WLAN Traffic Statistics
1738
1739 =item Telephony:ITU-T H.225
1740
1741 Count ITU-T H.225 messages and their reasons.  In the first column you get a
1742 list of H.225 messages and H.225 message reasons, which occur in the current
1743 capture file.  The number of occurrences of each message or reason will be displayed
1744 in the second column.
1745 This window opened will update in semi-real time to reflect changes when
1746 doing live captures or when reading new capture files into B<Wireshark>.
1747
1748 You can apply an optional filter string in a dialog box, before starting
1749 the counter.  The statistics will only be calculated
1750 on those calls matching that filter.
1751
1752 =item Telephony:SIP
1753
1754 Activate a counter for SIP messages.  You will get the number of occurrences of each
1755 SIP Method and of each SIP Status-Code.  Additionally you also get the number of
1756 resent SIP Messages (only for SIP over UDP).
1757
1758 This window opened will update in semi-real time to reflect changes when
1759 doing live captures or when reading new capture files into B<Wireshark>.
1760
1761 You can apply an optional filter string in a dialog box, before starting
1762 the counter.  The statistics will only be calculated
1763 on those calls matching that filter.
1764
1765 =item Tools:Firewall ACL Rules
1766
1767
1768
1769 =item Help:Contents
1770
1771 Some help texts.
1772
1773 =item Help:Supported Protocols
1774
1775 List of supported protocols and display filter protocol fields.
1776
1777 =item Help:Manual Pages
1778
1779 Display locally installed HTML versions of these manual pages in a web browser.
1780
1781 =item Help:Wireshark Online
1782
1783 Various links to online resources to be open in a web browser, like
1784 L<http://www.wireshark.org>.
1785
1786 =item Help:About Wireshark
1787
1788 See various information about Wireshark (see L<About|/item_about> dialog below), like the
1789 version, the folders used, the available plugins, ...
1790
1791 =back
1792
1793 =head2 WINDOWS
1794
1795 =over 4
1796
1797 =item Main Window
1798
1799 The main window contains the usual things like the menu, some toolbars, the
1800 main area and a statusbar.  The main area is split into three panes, you can
1801 resize each pane using a "thumb" at the right end of each divider line.
1802
1803 The main window is much more flexible than before.  The layout of the main
1804 window can be customized by the I<Layout> page in the dialog box popped
1805 up by I<Edit:Preferences>, the following will describe the layout with the
1806 default settings.
1807
1808 =over 6
1809
1810 =item Main Toolbar
1811
1812 Some menu items are available for quick access here.  There is no way to
1813 customize the items in the toolbar, however the toolbar can be hidden by
1814 I<View:Main Toolbar>.
1815
1816 =item Filter Toolbar
1817
1818 A display filter can be entered into the filter toolbar.
1819 A filter for HTTP, HTTPS, and DNS traffic might look like this:
1820
1821   tcp.port == 80 || tcp.port == 443 || tcp.port == 53
1822
1823 Selecting the I<Filter:> button lets you choose from a list of named
1824 filters that you can optionally save.  Pressing the Return or Enter
1825 keys, or selecting the I<Apply> button, will cause the filter to be
1826 applied to the current list of packets.  Selecting the I<Reset> button
1827 clears the display filter so that all packets are displayed (again).
1828
1829 There is no way to customize the items in the toolbar, however the toolbar
1830 can be hidden by I<View:Filter Toolbar>.
1831
1832 =item Packet List Pane
1833
1834 The top pane contains the list of network packets that you can scroll
1835 through and select.  By default, the packet number, packet timestamp,
1836 source and destination addresses, protocol, and description are
1837 displayed for each packet; the I<Columns> page in the dialog box popped
1838 up by I<Edit:Preferences> lets you change this (although, unfortunately,
1839 you currently have to save the preferences, and exit and restart
1840 Wireshark, for those changes to take effect).
1841
1842 If you click on the heading for a column, the display will be sorted by
1843 that column; clicking on the heading again will reverse the sort order
1844 for that column.
1845
1846 An effort is made to display information as high up the protocol stack
1847 as possible, e.g. IP addresses are displayed for IP packets, but the
1848 MAC layer address is displayed for unknown packet types.
1849
1850 The right mouse button can be used to pop up a menu of operations.
1851
1852 The middle mouse button can be used to mark a packet.
1853
1854 =item Packet Details Pane
1855
1856 The middle pane contains a display of the details of the
1857 currently-selected packet.  The display shows each field and its value
1858 in each protocol header in the stack.  The right mouse button can be
1859 used to pop up a menu of operations.
1860
1861 =item Packet Bytes Pane
1862
1863 The lowest pane contains a hex and ASCII dump of the actual packet data.
1864 Selecting a field in the packet details highlights the corresponding
1865 bytes in this section.
1866
1867 The right mouse button can be used to pop up a menu of operations.
1868
1869 =item Statusbar
1870
1871 The statusbar is divided into three parts, on the left some context dependent
1872 things are shown, like information about the loaded file, in the center the
1873 number of packets are displayed, and on the right the current configuration
1874 profile.
1875
1876 The statusbar can be hidden by I<View:Statusbar>.
1877
1878 =back
1879
1880 =item Preferences
1881
1882 The I<Preferences> dialog lets you control various personal preferences
1883 for the behavior of B<Wireshark>.
1884
1885 =over 6
1886
1887 =item User Interface Preferences
1888
1889 The I<User Interface> page is used to modify small aspects of the GUI to
1890 your own personal taste:
1891
1892 =over 6
1893
1894 =item Selection Bars
1895
1896 The selection bar in the packet list and packet details can have either
1897 a "browse" or "select" behavior.  If the selection bar has a "browse"
1898 behavior, the arrow keys will move an outline of the selection bar,
1899 allowing you to browse the rest of the list or details without changing
1900 the selection until you press the space bar.  If the selection bar has a
1901 "select" behavior, the arrow keys will move the selection bar and change
1902 the selection to the new item in the packet list or packet details.
1903
1904 =item Save Window Position
1905
1906 If this item is selected, the position of the main Wireshark window will
1907 be saved when Wireshark exits, and used when Wireshark is started again.
1908
1909 =item Save Window Size
1910
1911 If this item is selected, the size of the main Wireshark window will
1912 be saved when Wireshark exits, and used when Wireshark is started again.
1913
1914 =item Save Window Maximized state
1915
1916 If this item is selected the maximize state of the main Wireshark window
1917 will be saved when Wireshark exists, and used when Wireshark is started again.
1918
1919 =item File Open Dialog Behavior
1920
1921 This item allows the user to select how Wireshark handles the listing
1922 of the "File Open" Dialog when opening trace files.  "Remember Last
1923 Directory" causes Wireshark to automatically position the dialog in the
1924 directory of the most recently opened file, even between launches of Wireshark.
1925 "Always Open in Directory" allows the user to define a persistent directory
1926 that the dialog will always default to.
1927
1928 =item Directory
1929
1930 Allows the user to specify a persistent File Open directory.  Trailing
1931 slashes or backslashes will automatically be added.
1932
1933 =item File Open Preview timeout
1934
1935 This items allows the user to define how much time is spend reading the
1936 capture file to present preview data in the File Open dialog.
1937
1938 =item Open Recent maximum list entries
1939
1940 The File menu supports a recent file list.  This items allows the user to
1941 specify how many files are kept track of in this list.
1942
1943 =item Ask for unsaved capture files
1944
1945 When closing a capture file or Wireshark itself if the file isn't saved yet
1946 the user is presented the option to save the file when this item is set.
1947
1948 =item Wrap during find
1949
1950 This items determines the behavior when reaching the beginning or the end
1951 of a capture file.  When set the search wraps around and continues, otherwise
1952 it stops.
1953
1954 =item Settings dialogs show a save button
1955
1956 This item determines if the various dialogs sport an explicit Save button
1957 or that save is implicit in OK / Apply.
1958
1959 =item Web browser command
1960
1961 This entry specifies the command line to launch a web browser.  It is used
1962 to access online content, like the Wiki and user guide.  Use '%s' to place
1963 the request URL in the command line.
1964
1965 =item Display LEDs in the Expert Infos dialog tab labels
1966
1967 This item determines if LED-like colored images are displayed in the
1968 Expert Infos dialog tab labels.
1969
1970 =back
1971
1972 =item Layout Preferences
1973
1974 The I<Layout> page lets you specify the general layout of the main window.
1975 You can choose from six different layouts and fill the three panes with the
1976 contents you like.
1977
1978 =over 6
1979
1980 =item Scrollbars
1981
1982 The vertical scrollbars in the three panes can be set to be either on
1983 the left or the right.
1984
1985 =item Alternating row colors
1986
1987 =item Hex Display
1988
1989 The highlight method in the hex dump display for the selected protocol
1990 item can be set to use either inverse video, or bold characters.
1991
1992 =item Toolbar style
1993
1994 =item Filter toolbar placement
1995
1996 =item Custom window title
1997
1998 =back
1999
2000 =item Column Preferences
2001
2002 The I<Columns> page lets you specify the number, title, and format
2003 of each column in the packet list.
2004
2005 The I<Column title> entry is used to specify the title of the column
2006 displayed at the top of the packet list.  The type of data that the column
2007 displays can be specified using the I<Column format> option menu.
2008 The row of buttons on the left perform the following actions:
2009
2010 =over 6
2011
2012 =item New
2013
2014 Adds a new column to the list.
2015
2016 =item Delete
2017
2018 Deletes the currently selected list item.
2019
2020 =item Up / Down
2021
2022 Moves the selected list item up or down one position.
2023
2024 =back
2025
2026 =item Font Preferences
2027
2028 The I<Font> page lets you select the font to be used for most text.
2029
2030 =item Color Preferences
2031
2032 The I<Colors> page can be used to change the color of the text
2033 displayed in the TCP stream window and for marked packets.  To change a color,
2034 simply select an attribute from the "Set:" menu and use the color selector to
2035 get the desired color.  The new text colors are displayed as a sample text.
2036
2037 =item Capture Preferences
2038
2039 The I<Capture> page lets you specify various parameters for capturing
2040 live packet data; these are used the first time a capture is started.
2041
2042 The I<Interface:> combo box lets you specify the interface from which to
2043 capture packet data, or the name of a FIFO from which to get the packet
2044 data.
2045
2046 The I<Data link type:> option menu lets you, for some interfaces, select
2047 the data link header you want to see on the packets you capture.  For
2048 example, in some OSes and with some versions of libpcap, you can choose,
2049 on an 802.11 interface, whether the packets should appear as Ethernet
2050 packets (with a fake Ethernet header) or as 802.11 packets.
2051
2052 The I<Limit each packet to ... bytes> check box lets you set the
2053 snapshot length to use when capturing live data; turn on the check box,
2054 and then set the number of bytes to use as the snapshot length.
2055
2056 The I<Filter:> text entry lets you set a capture filter expression to be
2057 used when capturing.
2058
2059 If any of the environment variables SSH_CONNECTION, SSH_CLIENT,
2060 REMOTEHOST, DISPLAY, or SESSIONNAME are set, Wireshark will create a
2061 default capture filter that excludes traffic from the hosts and ports
2062 defined in those variables.
2063
2064 The I<Capture packets in promiscuous mode> check box lets you specify
2065 whether to put the interface in promiscuous mode when capturing.
2066
2067 The I<Update list of packets in real time> check box lets you specify
2068 that the display should be updated as packets are seen.
2069
2070 The I<Automatic scrolling in live capture> check box lets you specify
2071 whether, in an "Update list of packets in real time" capture, the packet
2072 list pane should automatically scroll to show the most recently captured
2073 packets.
2074
2075 =item Printing Preferences
2076
2077 The radio buttons at the top of the I<Printing> page allow you choose
2078 between printing packets with the I<File:Print Packet> menu item as text
2079 or PostScript, and sending the output directly to a command or saving it
2080 to a file.  The I<Command:> text entry box, on UNIX-compatible systems,
2081 is the command to send files to (usually B<lpr>), and the I<File:> entry
2082 box lets you enter the name of the file you wish to save to.
2083 Additionally, you can select the I<File:> button to browse the file
2084 system for a particular save file.
2085
2086 =item Name Resolution Preferences
2087
2088 The I<Enable MAC name resolution>, I<Enable network name resolution> and
2089 I<Enable transport name resolution> check boxes let you specify whether
2090 MAC addresses, network addresses, and transport-layer port numbers
2091 should be translated to names.
2092
2093 The I<Enable concurrent DNS name resolution> allows Wireshark to send out
2094 multiple name resolution requests and not wait for the result before
2095 continuing dissection.  This speeds up dissection with network name
2096 resolution but initially may miss resolutions.  The number of concurrent
2097 requests can be set here as well.
2098
2099 I<SMI paths>
2100
2101 I<SMI modules>
2102
2103 =item RTP Player Preferences
2104
2105 This page allows you to select the number of channels visible in the
2106 RTP player window.  It determines the height of the window, more channels
2107 are possible and visible by means of a scroll bar.
2108
2109 =item Protocol Preferences
2110
2111 There are also pages for various protocols that Wireshark dissects,
2112 controlling the way Wireshark handles those protocols.
2113
2114 =back
2115
2116 =item Edit Capture Filter List
2117
2118 =item Edit Display Filter List
2119
2120 =item Capture Filter
2121
2122 =item Display Filter
2123
2124 =item Read Filter
2125
2126 =item Search Filter
2127
2128 The I<Edit Capture Filter List> dialog lets you create, modify, and
2129 delete capture filters, and the I<Edit Display Filter List> dialog lets
2130 you create, modify, and delete display filters.
2131
2132 The I<Capture Filter> dialog lets you do all of the editing operations
2133 listed, and also lets you choose or construct a filter to be used when
2134 capturing packets.
2135
2136 The I<Display Filter> dialog lets you do all of the editing operations
2137 listed, and also lets you choose or construct a filter to be used to
2138 filter the current capture being viewed.
2139
2140 The I<Read Filter> dialog lets you do all of the editing operations
2141 listed, and also lets you choose or construct a filter to be used to
2142 as a read filter for a capture file you open.
2143
2144 The I<Search Filter> dialog lets you do all of the editing operations
2145 listed, and also lets you choose or construct a filter expression to be
2146 used in a find operation.
2147
2148 In all of those dialogs, the I<Filter name> entry specifies a
2149 descriptive name for a filter, e.g.  B<Web and DNS traffic>.  The
2150 I<Filter string> entry is the text that actually describes the filtering
2151 action to take, as described above.The dialog buttons perform the
2152 following actions:
2153
2154 =over 6
2155
2156 =item New
2157
2158 If there is text in the two entry boxes, creates a new associated list
2159 item.
2160
2161 =item Edit
2162
2163 Modifies the currently selected list item to match what's in the entry
2164 boxes.
2165
2166 =item Delete
2167
2168 Deletes the currently selected list item.
2169
2170 =item Add Expression...
2171
2172 For display filter expressions, pops up a dialog box to allow you to
2173 construct a filter expression to test a particular field; it offers
2174 lists of field names, and, when appropriate, lists from which to select
2175 tests to perform on the field and values with which to compare it.  In
2176 that dialog box, the OK button will cause the filter expression you
2177 constructed to be entered into the I<Filter string> entry at the current
2178 cursor position.
2179
2180 =item OK
2181
2182 In the I<Capture Filter> dialog, closes the dialog box and makes the
2183 filter in the I<Filter string> entry the filter in the I<Capture
2184 Preferences> dialog.  In the I<Display Filter> dialog, closes the dialog
2185 box and makes the filter in the I<Filter string> entry the current
2186 display filter, and applies it to the current capture.  In the I<Read
2187 Filter> dialog, closes the dialog box and makes the filter in the
2188 I<Filter string> entry the filter in the I<Open Capture File> dialog.
2189 In the I<Search Filter> dialog, closes the dialog box and makes the
2190 filter in the I<Filter string> entry the filter in the I<Find Packet>
2191 dialog.
2192
2193 =item Apply
2194
2195 Makes the filter in the I<Filter string> entry the current display
2196 filter, and applies it to the current capture.
2197
2198 =item Save
2199
2200 If the list of filters being edited is the list of
2201 capture filters, saves the current filter list to the personal capture
2202 filters file, and if the list of filters being edited is the list of
2203 display filters, saves the current filter list to the personal display
2204 filters file.
2205
2206 =item Close
2207
2208 Closes the dialog without doing anything with the filter in the I<Filter
2209 string> entry.
2210
2211 =back
2212
2213 =item The Color Filters Dialog
2214
2215 This dialog displays a list of color filters and allows it to be
2216 modified.
2217
2218 =over
2219
2220 =item THE FILTER LIST
2221
2222 Single rows may be selected by clicking.  Multiple rows may be selected
2223 by using the ctrl and shift keys in combination with the mouse button.
2224
2225 =item NEW
2226
2227 Adds a new filter at the bottom of the list and opens the Edit Color
2228 Filter dialog box.  You will have to alter the filter expression at
2229 least before the filter will be accepted.  The format of color filter
2230 expressions is identical to that of display filters.  The new filter is
2231 selected, so it may immediately be moved up and down, deleted or edited.
2232 To avoid confusion all filters are unselected before the new filter is
2233 created.
2234
2235 =item EDIT
2236
2237 Opens the Edit Color Filter dialog box for the selected filter. (If this
2238 button is disabled you may have more than one filter selected, making it
2239 ambiguous which is to be edited.)
2240
2241 =item ENABLE
2242
2243 Enables the selected color filter(s).
2244
2245 =item DISABLE
2246
2247 Disables the selected color filter(s).
2248
2249 =item DELETE
2250
2251 Deletes the selected color filter(s).
2252
2253 =item EXPORT
2254
2255 Allows you to choose a file in which to save the current list of color
2256 filters.  You may also choose to save only the selected filters.  A
2257 button is provided to save the filters in the global color filters file
2258 (you must have sufficient permissions to write this file, of course).
2259
2260 =item IMPORT
2261
2262 Allows you to choose a file containing color filters which are then
2263 added to the bottom of the current list.  All the added filters are
2264 selected, so they may be moved to the correct position in the list as a
2265 group.  To avoid confusion, all filters are unselected before the new
2266 filters are imported.  A button is provided to load the filters from the
2267 global color filters file.
2268
2269 =item CLEAR
2270
2271 Deletes your personal color filters file, reloads the global
2272 color filters file, if any, and closes the dialog.
2273
2274 =item UP
2275
2276 Moves the selected filter(s) up the list, making it more likely that
2277 they will be used to color packets.
2278
2279 =item DOWN
2280
2281 Moves the selected filter(s) down the list, making it less likely that
2282 they will be used to color packets.
2283
2284 =item OK
2285
2286 Closes the dialog and uses the color filters as they stand.
2287
2288 =item APPLY
2289
2290 Colors the packets according to the current list of color filters, but
2291 does not close the dialog.
2292
2293 =item SAVE
2294
2295 Saves the current list of color filters in your personal color filters
2296 file.  Unless you do this they will not be used the next time you start
2297 Wireshark.
2298
2299 =item CLOSE
2300
2301 Closes the dialog without changing the coloration of the packets.  Note
2302 that changes you have made to the current list of color filters are not
2303 undone.
2304
2305 =back
2306
2307 =item Capture Options
2308
2309 The I<Capture Options> dialog lets you specify various parameters for
2310 capturing live packet data.
2311
2312 The I<Interface:> field lets you specify the interface from which to
2313 capture packet data or a command from which to get the packet data via a
2314 pipe.
2315
2316 The I<Link layer header type:> field lets you specify the interfaces link
2317 layer header type.  This field is usually disabled, as most interface have
2318 only one header type.
2319
2320 The I<Capture packets in promiscuous mode> check box lets you specify
2321 whether the interface should be put into promiscuous mode when
2322 capturing.
2323
2324 The I<Limit each packet to ... bytes> check box and field lets you
2325 specify a maximum number of bytes per packet to capture and save; if the
2326 check box is not checked, the limit will be 65535 bytes.
2327
2328 The I<Capture Filter:> entry lets you specify the capture filter using a
2329 tcpdump-style filter string as described above.
2330
2331 The I<File:> entry lets you specify the file into which captured packets
2332 should be saved, as in the I<Printer Options> dialog above.  If not
2333 specified, the captured packets will be saved in a temporary file; you
2334 can save those packets to a file with the I<File:Save As> menu item.
2335
2336 The I<Use multiple files> check box lets you specify that the capture
2337 should be done in "multiple files" mode.  This option is disabled, if the
2338 I<Update list of packets in real time> option is checked.
2339
2340 The I<Next file every ...  megabyte(s)> check box and fields lets
2341 you specify that a switch to a next file should be done
2342 if the specified filesize is reached.  You can also select the appropriate
2343 unit, but beware that the filesize has a maximum of 2 GB.
2344 The check box is forced to be checked, as "multiple files" mode requires a
2345 file size to be specified.
2346
2347 The I<Next file every ... minute(s)> check box and fields lets
2348 you specify that the switch to a next file should be done after the specified
2349 time has elapsed, even if the specified capture size is not reached.
2350
2351 The I<Ring buffer with ... files> field lets you specify the number
2352 of files of a ring buffer.  This feature will capture into to the first file
2353 again, after the specified amount of files were used.
2354
2355 The I<Stop capture after ... files> field lets you specify the number
2356 of capture files used, until the capture is stopped.
2357
2358 The I<Stop capture after ... packet(s)> check box and field let
2359 you specify that Wireshark should stop capturing after having captured
2360 some number of packets; if the check box is not checked, Wireshark will
2361 not stop capturing at some fixed number of captured packets.
2362
2363 The I<Stop capture after ... megabyte(s)> check box and field lets
2364 you specify that Wireshark should stop capturing after the file to which
2365 captured packets are being saved grows as large as or larger than some
2366 specified number of megabytes.  If the check box is not checked, Wireshark
2367 will not stop capturing at some capture file size (although the operating
2368 system on which Wireshark is running, or the available disk space, may still
2369 limit the maximum size of a capture file).  This option is disabled, if
2370 "multiple files" mode is used,
2371
2372 The I<Stop capture after ...  second(s)> check box and field let you
2373 specify that Wireshark should stop capturing after it has been capturing
2374 for some number of seconds; if the check box is not checked, Wireshark
2375 will not stop capturing after some fixed time has elapsed.
2376
2377 The I<Update list of packets in real time> check box lets you specify
2378 whether the display should be updated as packets are captured and, if
2379 you specify that, the I<Automatic scrolling in live capture> check box
2380 lets you specify the packet list pane should automatically scroll to
2381 show the most recently captured packets as new packets arrive.
2382
2383 The I<Enable MAC name resolution>, I<Enable network name resolution> and
2384 I<Enable transport name resolution> check boxes let you specify whether
2385 MAC addresses, network addresses, and transport-layer port numbers
2386 should be translated to names.
2387
2388 =item About
2389
2390 The I<About> dialog lets you view various information about Wireshark.
2391
2392 =item About:Wireshark
2393
2394 The I<Wireshark> page lets you view general information about Wireshark,
2395 like the installed version, licensing information and such.
2396
2397 =item About:Authors
2398
2399 The I<Authors> page shows the author and all contributors.
2400
2401 =item About:Folders
2402
2403 The I<Folders> page lets you view the directory names where Wireshark is
2404 searching it's various configuration and other files.
2405
2406 =item About:Plugins
2407
2408 The I<Plugins> page lets you view the dissector plugin modules
2409 available on your system.
2410
2411 The I<Plugins List> shows the name and version of each dissector plugin
2412 module found on your system.
2413
2414 On Unix-compatible systems, the plugins are looked for in the following
2415 directories: the F<lib/wireshark/plugins/$VERSION> directory under the
2416 main installation directory (for example,
2417 F</usr/local/lib/wireshark/plugins/$VERSION>), and then
2418 F<$HOME/.wireshark/plugins>.
2419
2420 On Windows systems, the plugins are looked for in the following
2421 directories: F<plugins\$VERSION> directory under the main installation
2422 directory (for example, F<C:\Program Files\Wireshark\plugins\$VERSION>),
2423 and then F<%APPDATA%\Wireshark\plugins\$VERSION> (or, if %APPDATA% isn't
2424 defined, F<%USERPROFILE%\Application Data\Wireshark\plugins\$VERSION>).
2425
2426 $VERSION is the version number of the plugin interface, which
2427 is typically the version number of Wireshark.  Note that a dissector
2428 plugin module may support more than one protocol; there is not
2429 necessarily a one-to-one correspondence between dissector plugin modules
2430 and protocols.  Protocols supported by a dissector plugin module are
2431 enabled and disabled using the I<Edit:Protocols> dialog box, just as
2432 protocols built into Wireshark are.
2433
2434 =back
2435
2436 =head1 CAPTURE FILTER SYNTAX
2437
2438 See the manual page of pcap-filter(4) or, if that doesn't exist, tcpdump(8),
2439 or, if that doesn't exist, L<http://wiki.wireshark.org/CaptureFilters>.
2440
2441 =head1 DISPLAY FILTER SYNTAX
2442
2443 For a complete table of protocol and protocol fields that are filterable
2444 in B<Wireshark> see the wireshark-filter(4) manual page.
2445
2446 =head1 FILES
2447
2448 These files contains various B<Wireshark> configuration settings.
2449
2450 =over 4
2451
2452 =item Preferences
2453
2454 The F<preferences> files contain global (system-wide) and personal
2455 preference settings.  If the system-wide preference file exists, it is
2456 read first, overriding the default settings.  If the personal preferences
2457 file exists, it is read next, overriding any previous values.  Note: If
2458 the command line flag B<-o> is used (possibly more than once), it will
2459 in turn override values from the preferences files.
2460
2461 The preferences settings are in the form I<prefname>B<:>I<value>,
2462 one per line,
2463 where I<prefname> is the name of the preference
2464 and I<value> is the value to
2465 which it should be set; white space is allowed between B<:> and
2466 I<value>.  A preference setting can be continued on subsequent lines by
2467 indenting the continuation lines with white space.  A B<#> character
2468 starts a comment that runs to the end of the line:
2469
2470   # Vertical scrollbars should be on right side?
2471   # TRUE or FALSE (case-insensitive).
2472   gui.scrollbar_on_right: TRUE
2473
2474 The global preferences file is looked for in the F<wireshark> directory
2475 under the F<share> subdirectory of the main installation directory (for
2476 example, F</usr/local/share/wireshark/preferences>) on UNIX-compatible
2477 systems, and in the main installation directory (for example,
2478 F<C:\Program Files\Wireshark\preferences>) on Windows systems.
2479
2480 The personal preferences file is looked for in F<$HOME/.wireshark/preferences> on
2481 UNIX-compatible systems and F<%APPDATA%\Wireshark\preferences> (or, if
2482 %APPDATA% isn't defined, F<%USERPROFILE%\Application
2483 Data\Wireshark\preferences>) on Windows systems.
2484
2485 Note: Whenever the preferences are saved by using the I<Save> button
2486 in the I<Edit:Preferences> dialog box, your personal preferences file
2487 will be overwritten with the new settings, destroying any comments and
2488 unknown/obsolete settings that were in the file.
2489
2490 =item Recent
2491
2492 The F<recent> file contains personal settings (mostly GUI related) such
2493 as the current B<Wireshark> window size.  The file is saved at program exit and
2494 read in at program start automatically.  Note: The command line flag B<-o>
2495 may be used to override settings from this file.
2496
2497 The settings in this file have the same format as in the F<preferences>
2498 files, and the same directory as for the personal preferences file is
2499 used.
2500
2501 Note: Whenever Wireshark is closed, your recent file
2502 will be overwritten with the new settings, destroying any comments and
2503 unknown/obsolete settings that were in the file.
2504
2505 =item Disabled (Enabled) Protocols
2506
2507 The F<disabled_protos> files contain system-wide and personal lists of
2508 protocols that have been disabled, so that their dissectors are never
2509 called.  The files contain protocol names, one per line, where the
2510 protocol name is the same name that would be used in a display filter
2511 for the protocol:
2512
2513   http
2514   tcp     # a comment
2515
2516 If a protocol is listed in the global F<disabled_protos> file, it is not
2517 displayed in the I<Analyze:Enabled Protocols> dialog box, and so cannot
2518 be enabled by the user.
2519
2520 The global F<disabled_protos> file uses the same directory as the global
2521 preferences file.
2522
2523 The personal F<disabled_protos> file uses the same directory as the
2524 personal preferences file.
2525
2526 Note: Whenever the disabled protocols list is saved by using the I<Save>
2527 button in the I<Analyze:Enabled Protocols> dialog box, your personal
2528 disabled protocols file will be overwritten with the new settings,
2529 destroying any comments that were in the file.
2530
2531 =item Name Resolution (hosts)
2532
2533 If the personal F<hosts> file exists, it is
2534 used to resolve IPv4 and IPv6 addresses before any other
2535 attempts are made to resolve them.  The file has the standard F<hosts>
2536 file syntax; each line contains one IP address and name, separated by
2537 whitespace.  The same directory as for the personal preferences file is used.
2538
2539 Capture filter name resolution is handled by libpcap on UNIX-compatible
2540 systems and WinPCAP on Windows.  As such the Wireshark personal F<hosts> file
2541 will not be consulted for capture filter name resolution.
2542
2543 =item Name Resolution (ethers)
2544
2545 The F<ethers> files are consulted to correlate 6-byte hardware addresses to
2546 names.  First the personal F<ethers> file is tried and if an address is not
2547 found there the global F<ethers> file is tried next.
2548
2549 Each line contains one hardware address and name, separated by
2550 whitespace.  The digits of the hardware address are separated by colons
2551 (:), dashes (-) or periods (.).  The same separator character must be
2552 used consistently in an address.  The following three lines are valid
2553 lines of an F<ethers> file:
2554
2555   ff:ff:ff:ff:ff:ff          Broadcast
2556   c0-00-ff-ff-ff-ff          TR_broadcast
2557   00.00.00.00.00.00          Zero_broadcast
2558
2559 The global F<ethers> file is looked for in the F</etc> directory on
2560 UNIX-compatible systems, and in the main installation directory (for
2561 example, F<C:\Program Files\Wireshark>) on Windows systems.
2562
2563 The personal F<ethers> file is looked for in the same directory as the personal
2564 preferences file.
2565
2566 Capture filter name resolution is handled by libpcap on UNIX-compatible
2567 systems and WinPCAP on Windows.  As such the Wireshark personal F<ethers> file
2568 will not be consulted for capture filter name resolution.
2569
2570 =item Name Resolution (manuf)
2571
2572 The F<manuf> file is used to match the 3-byte vendor portion of a 6-byte
2573 hardware address with the manufacturer's name; it can also contain well-known
2574 MAC addresses and address ranges specified with a netmask.  The format of the
2575 file is the same as the F<ethers> files, except that entries such as:
2576
2577   00:00:0C      Cisco
2578
2579 can be provided, with the 3-byte OUI and the name for a vendor, and
2580 entries such as:
2581
2582   00-00-0C-07-AC/40     All-HSRP-routers
2583
2584 can be specified, with a MAC address and a mask indicating how many bits
2585 of the address must match.  The above entry, for example, has 40
2586 significant bits, or 5 bytes, and would match addresses from
2587 00-00-0C-07-AC-00 through 00-00-0C-07-AC-FF.  The mask need not be a
2588 multiple of 8.
2589
2590 The F<manuf> file is looked for in the same directory as the global
2591 preferences file.
2592
2593 =item Name Resolution (ipxnets)
2594
2595 The F<ipxnets> files are used to correlate 4-byte IPX network numbers to
2596 names.  First the global F<ipxnets> file is tried and if that address is not
2597 found there the personal one is tried next.
2598
2599 The format is the same as the F<ethers>
2600 file, except that each address is four bytes instead of six.
2601 Additionally, the address can be represented as a single hexadecimal
2602 number, as is more common in the IPX world, rather than four hex octets.
2603 For example, these four lines are valid lines of an F<ipxnets> file:
2604
2605   C0.A8.2C.00              HR
2606   c0-a8-1c-00              CEO
2607   00:00:BE:EF              IT_Server1
2608   110f                     FileServer3
2609
2610 The global F<ipxnets> file is looked for in the F</etc> directory on
2611 UNIX-compatible systems, and in the main installation directory (for
2612 example, F<C:\Program Files\Wireshark>) on Windows systems.
2613
2614 The personal F<ipxnets> file is looked for in the same directory as the
2615 personal preferences file.
2616
2617 =item Capture Filters
2618
2619 The F<cfilters> files contain system-wide and personal capture filters.
2620 Each line contains one filter, starting with the string displayed in the
2621 dialog box in quotation marks, followed by the filter string itself:
2622
2623   "HTTP" port 80
2624   "DCERPC" port 135
2625
2626 The global F<cfilters> file uses the same directory as the
2627 global preferences file.
2628
2629 The personal F<cfilters> file uses the same directory as the personal
2630 preferences file.  It is written through the Capture:Capture Filters
2631 dialog.
2632
2633 If the global F<cfilters> file exists, it is used only if the personal
2634 F<cfilters> file does not exist; global and personal capture filters are
2635 not merged.
2636
2637 =item Display Filters
2638
2639 The F<dfilters> files contain system-wide and personal display filters.
2640 Each line contains one filter, starting with the string displayed in the
2641 dialog box in quotation marks, followed by the filter string itself:
2642
2643   "HTTP" http
2644   "DCERPC" dcerpc
2645
2646 The global F<dfilters> file uses the same directory as the
2647 global preferences file.
2648
2649 The personal F<dfilters> file uses the same directory as the
2650 personal preferences file.  It is written through the Analyze:Display
2651 Filters dialog.
2652
2653 If the global F<dfilters> file exists, it is used only if the personal
2654 F<dfilters> file does not exist; global and personal display filters are
2655 not merged.
2656
2657 =item Color Filters (Coloring Rules)
2658
2659 The F<colorfilters> files contain system-wide and personal color filters.
2660 Each line contains one filter, starting with the string displayed in the
2661 dialog box, followed by the corresponding display filter.  Then the
2662 background and foreground colors are appended:
2663
2664   # a comment
2665   @tcp@tcp@[59345,58980,65534][0,0,0]
2666   @udp@udp@[28834,57427,65533][0,0,0]
2667
2668 The global F<colorfilters> file uses the same directory as the
2669 global preferences file.
2670
2671 The personal F<colorfilters> file uses the same directory as the
2672 personal preferences file.  It is written through the View:Coloring Rules
2673 dialog.
2674
2675 If the global F<colorfilters> file exists, it is used only if the personal
2676 F<colorfilters> file does not exist; global and personal color filters are
2677 not merged.
2678
2679 =item GTK rc files
2680
2681 The F<gtkrc> files contain system-wide and personal GTK theme settings.
2682
2683 The global F<gtkrc> file uses the same directory as the
2684 global preferences file.
2685
2686 The personal F<gtkrc> file uses the same directory as the personal
2687 preferences file.
2688
2689 =item Plugins
2690
2691 See above in the description of the About:Plugins page.
2692
2693 =back
2694
2695 =head1 ENVIRONMENT VARIABLES
2696
2697 =over 4
2698
2699 =item WIRESHARK_DEBUG_EP_NO_CHUNKS
2700
2701 Normally per-packet memory is allocated in large "chunks."  This behavior
2702 doesn't work well with debugging tools such as Valgrind or ElectricFence.
2703 Export this environment variable to force individual allocations.
2704 Note: disabling chunks also disables canaries (see below).
2705
2706 =item WIRESHARK_DEBUG_SE_NO_CHUNKS
2707
2708 Normally per-file memory is allocated in large "chunks."  This behavior
2709 doesn't work well with debugging tools such as Valgrind or ElectricFence.
2710 Export this environment variable to force individual allocations.
2711 Note: disabling chunks also disables canaries (see below).
2712
2713 =item WIRESHARK_DEBUG_EP_NO_CANARY
2714
2715 Normally per-packet memory allocations are separated by "canaries" which
2716 allow detection of memory overruns.  This comes at the expense of some extra
2717 memory usage.  Exporting this environment variable disables these canaries.
2718
2719 =item WIRESHARK_DEBUG_SE_USE_CANARY
2720
2721 Exporting this environment variable causes per-file memory allocations to be
2722 protected with "canaries" which allow for detection of memory overruns.
2723 This comes at the expense of significant extra memory usage.
2724
2725 =item WIRESHARK_DEBUG_SCRUB_MEMORY
2726
2727 If this environment variable is exported, the contents of per-packet and
2728 per-file memory is initialized to 0xBADDCAFE when the memory is allocated
2729 and is reset to 0xDEADBEEF when the memory is freed.  This functionality is
2730 useful mainly to developers looking for bugs in the way memory is handled.
2731
2732 =item WIRESHARK_RUN_FROM_BUILD_DIRECTORY
2733
2734 This environment variable causes the plugins and other data files to be loaded
2735 from the build directory (where the program was compiled) rather than from the
2736 standard locations.  It has no effect when the program in question is running
2737 with root (or setuid) permissions on *NIX.
2738
2739 =item WIRESHARK_DATA_DIR
2740
2741 This environment variable causes the various data files to be loaded from
2742 a directory other than the standard locations.  It has no effect when the
2743 program in question is running with root (or setuid) permissions on *NIX.
2744
2745 =item WIRESHARK_PYTHON_DIR
2746
2747 This environment variable points to an alternate location for Python.
2748 It has no effect when the program in question is running with root (or setuid)
2749 permissions on *NIX.
2750
2751 =item ERF_RECORDS_TO_CHECK
2752
2753 This environment variable controls the number of ERF records checked when
2754 deciding if a file really is in the ERF format.  Setting this environment
2755 variable a number higher than the default (20) would make false positives
2756 less likely.
2757
2758 =item IPFIX_RECORDS_TO_CHECK
2759
2760 This environment variable controls the number of IPFIX records checked when
2761 deciding if a file really is in the IPFIX format.  Setting this environment
2762 variable a number higher than the default (20) would make false positives
2763 less likely.
2764
2765 =item WIRESHARK_ABORT_ON_DISSECTOR_BUG
2766
2767 If this environment variable is set, B<Wireshark> will call abort(3)
2768 when a dissector bug is encountered.  abort(3) will cause the program to
2769 exit abnormally; if you are running B<Wireshark> in a debugger, it
2770 should halt in the debugger and allow inspection of the process, and, if
2771 you are not running it in a debugger, it will, on some OSes, assuming
2772 your environment is configured correctly, generate a core dump file.
2773 This can be useful to developers attempting to troubleshoot a problem
2774 with a protocol dissector.
2775
2776 =item WIRESHARK_EP_VERIFY_POINTERS
2777
2778 This environment variable, if exported, causes certain uses of pointers to be
2779 audited to ensure they do not point to memory that is deallocated after each
2780 packet has been fully dissected.  This can be useful to developers writing or
2781 auditing code.
2782
2783 =item WIRESHARK_SE_VERIFY_POINTERS
2784
2785 This environment variable, if exported, causes certain uses of pointers to be
2786 audited to ensure they do not point to memory that is deallocated after when
2787 a capture file is closed.  This can be useful to developers writing or
2788 auditing code.
2789
2790 =item WIRESHARK_QUIT_AFTER_CAPTURE
2791
2792 Cause B<Wireshark> to exit after the end of the capture session.  This
2793 doesn't automatically start a capture; you must still use B<-k> to do
2794 that.  You must also specify an autostop condition, e.g.  B<-c> or B<-a
2795 duration:...>.  This means that you will not be able to see the results
2796 of the capture after it stops; it's primarily useful for testing.
2797
2798 =back
2799
2800 =head1 SEE ALSO
2801
2802 wireshark-filter(4), tshark(1), editcap(1), pcap-filter(4), tcpdump(8),
2803 pcap(3), dumpcap(1), mergecap(1), text2pcap(1)
2804
2805 =head1 NOTES
2806
2807 The latest version of B<Wireshark> can be found at
2808 L<http://www.wireshark.org>.
2809
2810 HTML versions of the Wireshark project man pages are available at:
2811 L<http://www.wireshark.org/docs/man-pages>.
2812
2813 =head1 AUTHORS