ethereal.1

   1 .rn '' }`
   2 ''' $RCSfile: ethereal.1,v $$Revision: 1.4 $$Date: 1998/10/13 02:10:53 $
   3 '''
   4 ''' $Log: ethereal.1,v $
   5 ''' Revision 1.4  1998/10/13 02:10:53  gerald
   6 ''' * Pod page update
   7 ''' * Minor tweaks to the filter prefs
   8 '''
   9 '''
  10 .de Sh
  11 .br
  12 .if t .Sp
  13 .ne 5
  14 .PP
  15 \fB\\$1\fR
  16 .PP
  17 ..
  18 .de Sp
  19 .if t .sp .5v
  20 .if n .sp
  21 ..
  22 .de Ip
  23 .br
  24 .ie \\n(.$>=3 .ne \\$3
  25 .el .ne 3
  26 .IP "\\$1" \\$2
  27 ..
  28 .de Vb
  29 .ft CW
  30 .nf
  31 .ne \\$1
  32 ..
  33 .de Ve
  34 .ft R
  35
  36 .fi
  37 ..
  38 '''
  39 '''
  40 '''     Set up \*(-- to give an unbreakable dash;
  41 '''     string Tr holds user defined translation string.
  42 '''     Bell System Logo is used as a dummy character.
  43 '''
  44 .tr \(*W-|\(bv\*(Tr
  45 .ie n \{\
  46 .ds -- \(*W-
  47 .ds PI pi
  48 .if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  49 .if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
  50 .ds L" ""
  51 .ds R" ""
  52 '''   \*(M", \*(S", \*(N" and \*(T" are the equivalent of
  53 '''   \*(L" and \*(R", except that they are used on ".xx" lines,
  54 '''   such as .IP and .SH, which do another additional levels of
  55 '''   double-quote interpretation
  56 .ds M" """
  57 .ds S" """
  58 .ds N" """""
  59 .ds T" """""
  60 .ds L' '
  61 .ds R' '
  62 .ds M' '
  63 .ds S' '
  64 .ds N' '
  65 .ds T' '
  66 'br\}
  67 .el\{\
  68 .ds -- \(em\|
  69 .tr \*(Tr
  70 .ds L" ``
  71 .ds R" ''
  72 .ds M" ``
  73 .ds S" ''
  74 .ds N" ``
  75 .ds T" ''
  76 .ds L' `
  77 .ds R' '
  78 .ds M' `
  79 .ds S' '
  80 .ds N' `
  81 .ds T' '
  82 .ds PI \(*p
  83 'br\}
  84 .\"     If the F register is turned on, we'll generate
  85 .\"     index entries out stderr for the following things:
  86 .\"             TH      Title
  87 .\"             SH      Header
  88 .\"             Sh      Subsection
  89 .\"             Ip      Item
  90 .\"             X<>     Xref  (embedded
  91 .\"     Of course, you have to process the output yourself
  92 .\"     in some meaninful fashion.
  93 .if \nF \{
  94 .de IX
  95 .tm Index:\\$1\t\\n%\t"\\$2"
  96 ..
  97 .nr % 0
  98 .rr F
  99 .\}
 100 .TH ETHEREAL 1 "0.4.0" "12/Oct/98" "The Ethereal Network Analyzer"
 101 .UC
 102 .if n .hy 0
 103 .if n .na
 104 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 105 .de CQ          \" put $1 in typewriter font
 106 .ft CW
 107 'if n "\c
 108 'if t \\&\\$1\c
 109 'if n \\&\\$1\c
 110 'if n \&"
 111 \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
 112 '.ft R
 113 ..
 114 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
 115 .       \" AM - accent mark definitions
 116 .bd B 3
 117 .       \" fudge factors for nroff and troff
 118 .if n \{\
 119 .       ds #H 0
 120 .       ds #V .8m
 121 .       ds #F .3m
 122 .       ds #[ \f1
 123 .       ds #] \fP
 124 .\}
 125 .if t \{\
 126 .       ds #H ((1u-(\\\\n(.fu%2u))*.13m)
 127 .       ds #V .6m
 128 .       ds #F 0
 129 .       ds #[ \&
 130 .       ds #] \&
 131 .\}
 132 .       \" simple accents for nroff and troff
 133 .if n \{\
 134 .       ds ' \&
 135 .       ds ` \&
 136 .       ds ^ \&
 137 .       ds , \&
 138 .       ds ~ ~
 139 .       ds ? ?
 140 .       ds ! !
 141 .       ds /
 142 .       ds q
 143 .\}
 144 .if t \{\
 145 .       ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 146 .       ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 147 .       ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 148 .       ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 149 .       ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 150 .       ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
 151 .       ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
 152 .       ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 153 .       ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
 154 .\}
 155 .       \" troff and (daisy-wheel) nroff accents
 156 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 157 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 158 .ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
 159 .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
 160 .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
 161 .ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
 162 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 163 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 164 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 165 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 166 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 167 .ds ae a\h'-(\w'a'u*4/10)'e
 168 .ds Ae A\h'-(\w'A'u*4/10)'E
 169 .ds oe o\h'-(\w'o'u*4/10)'e
 170 .ds Oe O\h'-(\w'O'u*4/10)'E
 171 .       \" corrections for vroff
 172 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 173 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 174 .       \" for low resolution devices (crt and lpr)
 175 .if \n(.H>23 .if \n(.V>19 \
 176 \{\
 177 .       ds : e
 178 .       ds 8 ss
 179 .       ds v \h'-1'\o'\(aa\(ga'
 180 .       ds _ \h'-1'^
 181 .       ds . \h'-1'.
 182 .       ds 3 3
 183 .       ds o a
 184 .       ds d- d\h'-1'\(ga
 185 .       ds D- D\h'-1'\(hy
 186 .       ds th \o'bp'
 187 .       ds Th \o'LP'
 188 .       ds ae ae
 189 .       ds Ae AE
 190 .       ds oe oe
 191 .       ds Oe OE
 192 .\}
 193 .rm #[ #] #H #V #F C
 194 .SH "NAME"
 195 Ethereal \- Interactively browse network traffic
 196 .SH "SYNOPSYS"
 197 \fBethereal\fR
 198 [\ \fB\-B\fR\ byte\ view\ height\ ]
 199 [\ \fB\-b\fR\ bold\ font\ ]
 200 [\ \fB\-c\fR\ count\ ]
 201 [\ \fB\-h\fR\ ]
 202 [\ \fB\-i\fR\ interface\ ]
 203 [\ \fB\-m\fR\ font\ ]
 204 [\ \fB\-n\fR\ ]
 205 [\ \fB\-P\fR\ packet\ list\ height\ ]
 206 [\ \fB\-r\fR\ infile\ ]
 207 [\ \fB\-s\fR\ snaplen\ ]
 208 [\ \fB\-T\fR\ tree\ view\ height\ ]
 209 [\ \fB\-t\fR\ time\ stamp\ format\ ]
 210 [\ \fB\-v\fR\ ]
 211 [\ \fB\-w\fR\ savefile]
 212 .SH "DESCRIPTION"
 213 \fBEthereal\fR is a network protocol analyzer based on the \fBGTK+\fR GUI toolkit.  It lets
 214 you interactively browse packet data from a live network or from a \fBpcap\fR
 215 / \fBtcpdump()\fR formatted capture file.
 216 .SH "OPTIONS"
 217 .Ip "-B" 4
 218 Sets the initial height of the byte view (bottom) pane
 219 .Ip "-b" 4
 220 The bold font name used for packet fied display.
 221 .Ip "-c" 4
 222 The default number of packets to read when capturing live data.
 223 .Ip "-h" 4
 224 Prints the version and options and exits.
 225 .Ip "-i" 4
 226 The name of the interface to use for live packet capture.  It should match
 227 one of the names listed in \*(L"\fBnetstat \-i\fR\*(R" or \*(L"\fBifconfig \-a\fR\*(R".
 228 .Ip "-m" 4
 229 The font name used by \fBEthereal\fR.
 230 .Ip "-n" 4
 231 Disable network object name resolution (such as hostname, \s-1TCP\s0 and \s-1UDP\s0 port
 232 names).
 233 .Ip "-P" 4
 234 Sets the initial height of the packet list (top) pane
 235 .Ip "-r" 4
 236 Read packet data from \fIfile\fR.  Currently, \fBEthereal\fR only understands
 237 \fBpcap\fR / \fBtcpdump\fR formatted files.
 238 .Ip "-s" 4
 239 The default snapshot length to use when capturing live data.  No more than
 240 \fIsnaplen\fR bytes of each network packet will be read into memory, or saved
 241 to disk.
 242 .Ip "-T" 4
 243 Sets the initial height of the tree view (top) pane
 244 .Ip "-t" 4
 245 Sets the format of the packet timestamp displayed in the packet list
 246 window.
 247 .Ip "-v" 4
 248 Prints the version and exits.
 249 .Ip "-w" 4
 250 Sets the default capture file name.
 251 .SH "INTERFACE"
 252 .Sh "\s-1MENU\s0 \s-1ITEMS\s0"
 253 .Ip "File:Open, File:Close, File:Reload" 4
 254 Open, close, or reload a capture file.
 255 .Ip "File:Print Packet" 4
 256 Print a description of each protocol header found in the packet, followed
 257 by the packet data itself.  Printing options can be set with the
 258 \fIEdit:Menu Options\fR menu item.
 259 .Ip "File:Quit" 4
 260 Exits the application.
 261 .Ip "Edit:Preferences" 4
 262 Sets the packet printing and filter options (see the section on \fIPreferences\fR below).
 263 .Ip "Tools:Capture" 4
 264 Initiates a live packet capture (see the section on \fICapture Preferences\fR below).
 265 .Ip "Tools:Follow \s-1TCP\s0 Stream" 4
 266 If you have a \s-1TCP\s0 packet selected, it will display the contents of the \s-1TCP\s0
 267 data stream in a separate window.
 268 .Sh "\s-1WINDOWS\s0"
 269 .Ip "Main Window" 4
 270 The main window is split into three panes.  You can resize each pane using
 271 a \*(L"thumb\*(R" at the right end of each divider line.  Below the panes is a
 272 strip that shows the file load progress, current filter, and informational
 273 text.
 274 .Sp
 275 The top pane contains the list of network packets that you can scroll
 276 through and select.  The packet number, packet timestamp, source and
 277 destination addresses, protocol, and description are printed for each
 278 packet.  An effort is made to display information as high up the protocol
 279 stack as possible, e.g. \s-1IP\s0 addresses are displayed for \s-1IP\s0 packets, but the
 280 \s-1MAC\s0 layer address is displayed for unknown packet types.
 281 .Sp
 282 The middle pane contains a \fIprotocol tree\fR for the currently-selected
 283 packet.  The tree displays each field and its value in each protocol header
 284 in the stack.
 285 .Sp
 286 The lowest pane contains a hex dump of the actual packet data.
 287 Selecting a field in the \fIprotocol tree\fR highlights the corresponding
 288 bytes in this section.
 289 .Sp
 290 A display filter can be entered into the strip at the bottom.  It must
 291 have the same format as \fBtcpdump\fR filter strings, since both programs use
 292 the same underlying library.  A filter for \s-1HTTP\s0, \s-1HTTPS\s0, and \s-1DNS\s0 traffic
 293 might look like this:
 294 .Sp
 295 .Vb 1
 296 \&  tcp port 80 or tcp port 443 or port 53
 297 .Ve
 298 Selecting the \fIFilter:\fR button lets you choose from a list of named
 299 filters that you can optionally save.
 300 .Ip "Preferences" 4
 301 The \fIPreferences\fR dialog lets you select the output format of packets
 302 printed using the \fIFile:Print Packet\fR menu item and configure
 303 commonly-used filters.
 304 .Ip "Printing Preferences" 10
 305 The radio buttons at the top of the \fIPrinting\fR page allow you choose
 306 between  printing the packets as text or PostScript, and sending the
 307 output directly to a command or saving it to a file.  The \fICommand:\fR text
 308 entry box is the command to send files to (usually \fBlpr\fR), and the
 309 \fIFile:\fR entry box lets you enter the name of the file you wish to save
 310 to.  Additinally, you can select the \fIFile:\fR button to browse the file
 311 system for a particular save file.
 312 .Ip "Filters" 10
 313 The \fIFilters\fR page lets you create and modify filters, and set the
 314 default filter to use when capturing data or opening a capture file.
 315 .Sp
 316 The \fIFilter name\fR entry specifies a descriptive name for a filter, e.g.
 317 \fBWeb and \s-1DNS\s0 traffic\fR.  The \fIFilter string\fR entry is the text that
 318 actually describes the filtering action to take, as described above.The
 319 dialog buttons perform the following actions:
 320 .Ip "New" 18
 321 If there is text in the two entry boxes, it creates a new associated list
 322 item.
 323 .Ip "Change" 18
 324 Modifies the currently selected list item to match what's in the entry
 325 boxes.
 326 .Ip "Copy" 18
 327 Makes a copy of the currently selected list item.
 328 .Ip "Delete" 18
 329 Deletes the currently selected list item.
 330 .Ip "\s-1OK\s0" 18
 331 Sets the currently selected list item as the active filter.  If  nothing
 332 is selected, turns filtering off.
 333 .Ip "Save" 18
 334 Saves the current filter list in \fI$\s-1HOME\s0/.ethereal/filters\fR.
 335 .Ip "Cancel" 18
 336 Closes the dialog without making any changes.
 337 .Ip "Capture Preferences" 4
 338 The \fICapture Preferences\fR dialog lets you specify various parameters for
 339 capturing live packet data.
 340 .Sp
 341 The \fIInterface:\fR entry box lets you specify the interface from which to
 342 capture packet data.  The \fICount:\fR entry specifies the number of packets
 343 to capture.  Entering 0 will capture packets indefinitely.  The \fIFilter:\fR
 344 entry lets you specify the capture filter using a tcpdump-style filter
 345 string as described above.  The \fIFile:\fR entry specifies the file to save
 346 to, as in the \fIPrinter Options\fR dialog above.  You can choose to open the
 347 file after capture, and you can also specify the maximum number of bytes
 348 to capture per packet with the \fICapture length\fR entry.
 349 .SH "SEE ALSO"
 350 the \fItcpdump(1)\fR manpage, the \fIpcap(3)\fR manpage
 351 .SH "NOTES"
 352 The latest version of \fBethereal\fR can be found at
 353 \fBhttp://ethereal.zing.org\fR.
 354 .SH "AUTHORS"
 355 .PP
 356 .Vb 3
 357 \&  Original Author
 358 \&  -------- ------
 359 \&  Gerald Combs  <gerald@zing.org>
 360 .Ve
 361 .Vb 8
 362 \&  Contributors
 363 \&  ------------
 364 \&  Gilbert Ramirez Jr.  <gram@verdict.uthscsa.edu>
 365 \&  Hannes R. Boehm      <hannes@boehm.org>
 366 \&  Mike Hall            <mlh@io.com>
 367 \&  Bobo Rajec           <bobo@bsp-consulting.sk>
 368 \&  Laurent Deniel       <deniel@worldnet.fr>
 369 \&  Don Lafontaine       <lafont02@cn.ca>
 370 .Ve
 371 Alain Magloire <alainm@rcsm.ece.mcgill.ca> was kind enough to give his
 372 permission to use his version of snprintf.c.
 373 .PP
 374 Dan Lasley <dlasley@promus.com> gave permission for his \fIdumpit()\fR hex-dump
 375 routine to be used.
 376
 377 .rn }` ''
 378 .IX Title "ETHEREAL 1"
 379 .IX Name "Ethereal - Interactively browse network traffic"
 380
 381 .IX Header "NAME"
 382
 383 .IX Header "SYNOPSYS"
 384
 385 .IX Header "DESCRIPTION"
 386
 387 .IX Header "OPTIONS"
 388
 389 .IX Item "-B"
 390
 391 .IX Item "-b"
 392
 393 .IX Item "-c"
 394
 395 .IX Item "-h"
 396
 397 .IX Item "-i"
 398
 399 .IX Item "-m"
 400
 401 .IX Item "-n"
 402
 403 .IX Item "-P"
 404
 405 .IX Item "-r"
 406
 407 .IX Item "-s"
 408
 409 .IX Item "-T"
 410
 411 .IX Item "-t"
 412
 413 .IX Item "-v"
 414
 415 .IX Item "-w"
 416
 417 .IX Header "INTERFACE"
 418
 419 .IX Subsection "\s-1MENU\s0 \s-1ITEMS\s0"
 420
 421 .IX Item "File:Open, File:Close, File:Reload"
 422
 423 .IX Item "File:Print Packet"
 424
 425 .IX Item "File:Quit"
 426
 427 .IX Item "Edit:Preferences"
 428
 429 .IX Item "Tools:Capture"
 430
 431 .IX Item "Tools:Follow \s-1TCP\s0 Stream"
 432
 433 .IX Subsection "\s-1WINDOWS\s0"
 434
 435 .IX Item "Main Window"
 436
 437 .IX Item "Preferences"
 438
 439 .IX Item "Printing Preferences"
 440
 441 .IX Item "Filters"
 442
 443 .IX Item "New"
 444
 445 .IX Item "Change"
 446
 447 .IX Item "Copy"
 448
 449 .IX Item "Delete"
 450
 451 .IX Item "\s-1OK\s0"
 452
 453 .IX Item "Save"
 454
 455 .IX Item "Cancel"
 456
 457 .IX Item "Capture Preferences"
 458
 459 .IX Header "SEE ALSO"
 460
 461 .IX Header "NOTES"
 462
 463 .IX Header "AUTHORS"
 464