Instead of saying the "manuf" file is in "/usr/local/etc/manuf", say
[obnox/wireshark/wip.git] / doc / ethereal.pod.template
index f015b9d73de135256f4b9415cea9875e37970a6a..4a6e88d5bf81cc8e1110d526740b81b03175d2c2 100644 (file)
@@ -1,7 +1,7 @@
 
 =head1 NAME
 
-Ethereal - Interactively browse network traffic
+ethereal - Interactively browse network traffic
 
 =head1 SYNOPSYS
 
@@ -15,6 +15,7 @@ S<[ B<-k> ]>
 S<[ B<-l> ]>
 S<[ B<-m> font ]>
 S<[ B<-n> ]>
+S<[ B<-N> resolving flags ] ...>
 S<[ B<-o> preference setting ] ...>
 S<[ B<-p> ]>
 S<[ B<-P> packet list height ]>
@@ -127,6 +128,14 @@ protocol tree pane from the name of the main text font.
 Disables network object name resolution (such as hostname, TCP and UDP port
 names).
 
+=item -N
+
+Turns on name resolving for particular types of addresses and port
+numbers; the argument is a string that may contain the letters B<m> to
+enable MAC address resolution, B<n> to enable network address
+resolution, and B<t> to enable transport-layer port number resolution. 
+This overrides B<-n> if both B<-N> and B<-n> are present.
+
 =item -o
 
 Sets a preference value, overriding the default value and any value read
@@ -714,8 +723,9 @@ the I<Update list of packets in real time> check box, can specify
 whether in such a capture the packet list pane should scroll to show the
 most recently captured packets with the I<Automatic scrolling in live
 capture> check box, and can specify whether addresses should be
-translated to names in the display with the I<Enable name resolution>
-check box.
+translated to names in the display with the I<Enable MAC name resolution>,
+I<Enable network name resolution> and I<Enable transport name resolution>
+check boxes.
 
 =item Display Options
 
@@ -726,8 +736,9 @@ date, "Seconds since beginning of capture" for relative time stamps, or
 "Seconds since previous frame" for delta time stamps.  You can also
 specify whether, when the display is updated as packets are captured,
 the list should automatically scroll to show the most recently captured
-packets or not and whether addresses should be translated to names in
-the display.
+packets or not and whether addresses or port numbers should be
+translated to names in the display on a MAC, network and transport layer
+basis.
 
 =item Plugins
 
@@ -822,11 +833,28 @@ by using the hostname:
     ip.dst eq www.mit.edu
     ip.src == 192.168.1.1
 
-IPv4 address can be compared with the same logical relations as numbers:
+IPv4 addresses can be compared with the same logical relations as numbers:
 eq, ne, gt, ge, lt, and le.  The IPv4 address is stored in host order,
 so you do not have to worry about how the endianness of an IPv4 address
 when using it in a display filter.
 
+Classless InterDomain Routing (CIDR) notation can be used to test if an
+IPv4 address is in a certain subnet.  For example, this display filter
+will find all packets in the 129.111 Class-B network:
+
+    ip.addr == 129.111.0.0/16
+
+Remember, the number after the slash represents the number of bits used
+to represent the network.  CIDR notation can also be used with
+hostnames, in this example of finding IP addresses on the same Class C
+network as 'sneezy':
+
+    ip.addr eq sneezy/24
+
+The CIDR notation can only be used on IP addresses or hostnames, not in
+variable names.  So, a display filter like "ip.src/24 == ip.dst/24" is
+not valid.  (yet)
+
 IPX networks are represented by unsigned 32-bit integers.  Most likely
 you will be using hexadecimal when testing for IPX network values:
 
@@ -853,7 +881,6 @@ you to look at the nth byte of a packet regardless of its frame type
     ipx[0:2] == ff:ff
     llc[3:1] eq 0xaa
 
-
 The following syntax governs slices:
 
        [i:j]   i = start_offset, j = length
@@ -862,20 +889,20 @@ The following syntax governs slices:
        [:j]    start_offset = 0, length = j
        [i:]    start_offset = i, end_offset = end_of_field
 
-
-Offsets and lengths can be negative, in which case they indicate the offset from the
-*end* of the field.  Here's how to check the last 4 bytes of a frame:
+Offsets and lengths can be negative, in which case they indicate the
+offset from the B<end> of the field.  Here's how to check the last 4
+bytes of a frame:
 
     frame[-4:4] == 0.1.2.3
+
 or
-    frame[-4:] == 0.1.2.3
 
+    frame[-4:] == 0.1.2.3
 
 You can create complex concatenations of slices using the comma operator:
 
        field[1,3-5,9:] == 01:03:04:05:09:0a:0b
 
-
 All the above tests can be combined together with logical expressions. 
 These too are expressable in C-like syntax or with English-like
 abbreviations:
@@ -957,10 +984,14 @@ file:
   c0-00-ff-ff-ff-ff          TR_broadcast
   00.00.00.00.00.00          Zero_broadcast
 
-F</usr/local/etc/manuf> matches the 3-byte vendor portion of a 6-byte
-hardware address with the manufacturer's name.  The format of the file
-is the same as the F</etc/ethers> file, except that each address is
-three bytes instead of six.
+The F<manuf> file, which is installed in the F<etc> directory under the
+main installation directory (for example, F</usr/local/etc>) on
+UNIX-compatible systems, and in the main installation directory (for
+example, F<C:\Program Files\Ethereal> on Windows systems, matches the
+3-byte vendor portion of a 6-byte hardware address with the
+manufacturer's name.  The format of the file is the same as the
+F</etc/ethers> file, except that each address is three bytes instead of
+six.
 
 F</etc/ipxnets> and F<$HOME/.ethereal/ipxnets> correlate 4-byte IPX
 network numbers to names.  The format is the same as the F</etc/ethers>
@@ -987,129 +1018,164 @@ B<http://www.ethereal.com>.
 
   Original Author
   -------- ------
-  Gerald Combs  <gerald@ethereal.com>
+  Gerald Combs  <gerald[AT]ethereal.com>
 
 
   Contributors
   ------------
-  Gilbert Ramirez          <gram@xiexie.org>
-  Hannes R. Boehm          <hannes@boehm.org>
-  Mike Hall                <mlh@io.com>
-  Bobo Rajec               <bobo@bsp-consulting.sk>
-  Laurent Deniel           <deniel@worldnet.fr>
-  Don Lafontaine           <lafont02@cn.ca>
-  Guy Harris               <guy@alum.mit.edu>
-  Simon Wilkinson          <sxw@dcs.ed.ac.uk>
-  Joerg Mayer              <jmayer@loplof.de>
-  Martin Maciaszek         <fastjack@i-s-o.net>
-  Didier Jorand            <Didier.Jorand@alcatel.fr>
-  Jun-ichiro itojun Hagino <itojun@iijlab.net>
-  Richard Sharpe           <sharpe@ns.aus.com>
-  John McDermott           <jjm@jkintl.com> 
-  Jeff Jahr                <jjahr@shastanets.com>
-  Brad Robel-Forrest       <bradr@watchguard.com>
-  Ashok Narayanan          <ashokn@cisco.com>
-  Aaron Hillegass          <aaron@classmax.com>
-  Jason Lango              <jal@netapp.com>
-  Johan Feyaerts           <Johan.Feyaerts@siemens.atea.be>
-  Olivier Abad             <oabad@cybercable.fr>
-  Thierry Andry            <Thierry.Andry@advalvas.be>
-  Jeff Foster              <jjfoste@woodward.com>
-  Peter Torvals            <petertv@xoommail.com>
-  Christophe Tronche       <ch.tronche@computer.org>
-  Nathan Neulinger         <nneul@umr.edu>
-  Tomislav Vujec           <tvujec@carnet.hr>
-  Kojak                    <kojak@bigwig.net>
-  Uwe Girlich              <Uwe.Girlich@philosys.de>
-  Warren Young             <tangent@mail.com>
-  Heikki Vatiainen         <hessu@cs.tut.fi>
-  Greg Hankins             <gregh@twoguys.org>
-  Jerry Talkington         <jerryt@netapp.com>
-  Dave Chapeskie           <dchapes@ddm.on.ca>
-  James Coe                <jammer@cin.net>
-  Bert Driehuis            <driehuis@playbeing.org>
-  Stuart Stanley           <stuarts@mxmail.net>
-  John Thomes              <john@ensemblecom.com>
-  Laurent Cazalet          <laurent.cazalet@mailclub.net>
-  Thomas Parvais           <thomas.parvais@advalvas.be>
-  Gerrit Gehnen            <G.Gehnen@atrie.de>
-  Craig Newell             <craign@cheque.uq.edu.au>
-  Ed Meaney                <emeaney@altiga.com>
-  Dietmar Petras           <DPetras@ELSA.de> 
-  Fred Reimer              <fwr@ga.prestige.net>
-  Florian Lohoff           <flo@rfc822.org>
-  Jochen Friedrich         <jochen+ethereal@scram.de>
-  Paul Welchinski          <paul.welchinski@telusplanet.net>
-  Doug Nazar               <nazard@dragoninc.on.ca>
-  Andreas Sikkema          <andreas.sikkema@philips.com>
-  Mark Muhlestein          <mmm@netapp.com>
-  Graham Bloice            <graham.bloice@trihedral.com>
-  Ralf Schneider           <ralf.schneider@alcatel.se>
-  Yaniv Kaul               <ykaul@netvision.net.il>
-  Paul Ionescu             <ipaul@romsys.ro>
-  Mark Burton              <markb@ordern.com>
-  Stefan Raab              <sraab@cisco.com>
-  Mark Clayton             <clayton@shore.net>
-  Michael Rozhavsky        <mike@tochna.technion.ac.il>
-  Dug Song                 <dugsong@monkey.org>
-  Michael Tuexen           <Michael.Tuexen@icn.siemens.de>
-  Bruce Korb               <bkorb@sco.com>
-  Jose Pedro Oliveira      <jpo@di.uminho.pt>
-  David Frascone           <dave@frascone.com>
-  Peter Kjellerstedt       <pkj@axis.com>
-  Phil Techau              <phil_t@altavista.net>
-  Wes Hardaker             <wjhardaker@ucdavis.edu>
-  Robert Tsai              <rtsai@netapp.com>
-  Craig Metz               <cmetz@inner.net>
-  Per Flock                <per.flock@axis.com>
-  Jack Keane               <jkeane@OpenReach.com>
-  Brian Wellington         <bwelling@xbill.org>
-  Santeri Paavolainen      <santtu@ssh.com>
-  Ulrich Kiermayr          <uk@ap.univie.ac.at>
-  Neil Hunter              <neil.hunter@energis-squared.com>
-  Ralf Holzer              <ralf@well.com>
-  Craig Rodrigues          <rodrigc@mediaone.net>
-  Ed Warnicke              <hagbard@physics.rutgers.edu>
-  Johan Jorgensen          <johan.jorgensen@axis.com>
-  Frank Singleton          <frank.singleton@ericsson.com>
-  Kevin Shi                <techishi@ms22.hinet.net>
-  Mike Frisch              <mfrisch@saturn.tlug.org>
-  Burke Lau                <burke_lau@agilent.com>
-  Martti Kuparinen         <martti.kuparinen@nomadiclab.com>
-  David Hampton            <dhampton@mac.com>
-  Kent Engström            <kent@unit.liu.se>
-  Ronnie Sahlberg          <rsahlber@bigpond.net.au>
-  Alexandre P. Ferreira    <alexandref@spliceip.com.br>
-  Simharajan Srishylam     <Simharajan.Srishylam@netapp.com>
-  Greg Kilfoyle            <gregk@redback.com>
-  James E. Flemer          <jflemer@acm.jhu.edu>
-  Peter Lei                <peterlei@cisco.com>
-  Thomas Gimpel            <thomas.gimpel@ferrari.de>
-  Albert Chin              <china@thewrittenword.com>
-  Charles Levert           <charles@comm.polymtl.ca>
-  Todd Sabin               <tas@webspan.net>
-  Eduardo Pérez Ureta      <eperez@dei.inf.uc3m.es>
-  Martin Thomas            <martin_a_thomas@yahoo.com>
-  Hartmut Mueller          <hartmut@wendolene.ping.de>
-  Michal Melerowicz        <Michal.Melerowicz@nokia.com>
-  Hannes Gredler           <hannes@juniper.net>
-  Inoue                    <inoue@ainet.or.jp>
-  Olivier Biot             <Olivier.Biot@siemens.atea.be>
-  Patrick Wolfe            <pjw@zocalo.cellular.ameritech.com>
-  Martin Held              <Martin.Held@icn.siemens.de>
-  Riaan Swart              <rswart@cs.sun.ac.za>
-  Christian Lacunza        <celacunza@gmx.net>
-  Michael Rozhavsky        <mike@tochna.technion.ac.il>
-  Scott Renfro             <scott@renfro.org>
-  Juan Toledo              <toledo@users.sourceforge.net>
-  Jean-Christian Pennetier <jeanchristian.pennetier@rd.francetelecom.fr>
-  Jian Yu                  <bgp4news@yahoo.com>
-  Eran Mann                <emann@opticalaccess.com>
-  Andy Hood                <ahood@westpac.com.au>
-  Randy McEoin             <rmceoin@pe.net>
-
-Alain Magloire <alainm@rcsm.ece.mcgill.ca> was kind enough to give his
+  Gilbert Ramirez          <gram[AT]xiexie.org>
+  Hannes R. Boehm          <hannes[AT]boehm.org>
+  Mike Hall                <mlh[AT]io.com>
+  Bobo Rajec               <bobo[AT]bsp-consulting.sk>
+  Laurent Deniel           <deniel[AT]worldnet.fr>
+  Don Lafontaine           <lafont02[AT]cn.ca>
+  Guy Harris               <guy[AT]alum.mit.edu>
+  Simon Wilkinson          <sxw[AT]dcs.ed.ac.uk>
+  Joerg Mayer              <jmayer[AT]loplof.de>
+  Martin Maciaszek         <fastjack[AT]i-s-o.net>
+  Didier Jorand            <Didier.Jorand[AT]alcatel.fr>
+  Jun-ichiro itojun Hagino <itojun[AT]iijlab.net>
+  Richard Sharpe           <sharpe[AT]ns.aus.com>
+  John McDermott           <jjm[AT]jkintl.com> 
+  Jeff Jahr                <jjahr[AT]shastanets.com>
+  Brad Robel-Forrest       <bradr[AT]watchguard.com>
+  Ashok Narayanan          <ashokn[AT]cisco.com>
+  Aaron Hillegass          <aaron[AT]classmax.com>
+  Jason Lango              <jal[AT]netapp.com>
+  Johan Feyaerts           <Johan.Feyaerts[AT]siemens.atea.be>
+  Olivier Abad             <oabad[AT]cybercable.fr>
+  Thierry Andry            <Thierry.Andry[AT]advalvas.be>
+  Jeff Foster              <jjfoste[AT]woodward.com>
+  Peter Torvals            <petertv[AT]xoommail.com>
+  Christophe Tronche       <ch.tronche[AT]computer.org>
+  Nathan Neulinger         <nneul[AT]umr.edu>
+  Tomislav Vujec           <tvujec[AT]carnet.hr>
+  Kojak                    <kojak[AT]bigwig.net>
+  Uwe Girlich              <Uwe.Girlich[AT]philosys.de>
+  Warren Young             <tangent[AT]mail.com>
+  Heikki Vatiainen         <hessu[AT]cs.tut.fi>
+  Greg Hankins             <gregh[AT]twoguys.org>
+  Jerry Talkington         <jerryt[AT]netapp.com>
+  Dave Chapeskie           <dchapes[AT]ddm.on.ca>
+  James Coe                <jammer[AT]cin.net>
+  Bert Driehuis            <driehuis[AT]playbeing.org>
+  Stuart Stanley           <stuarts[AT]mxmail.net>
+  John Thomes              <john[AT]ensemblecom.com>
+  Laurent Cazalet          <laurent.cazalet[AT]mailclub.net>
+  Thomas Parvais           <thomas.parvais[AT]advalvas.be>
+  Gerrit Gehnen            <G.Gehnen[AT]atrie.de>
+  Craig Newell             <craign[AT]cheque.uq.edu.au>
+  Ed Meaney                <emeaney[AT]altiga.com>
+  Dietmar Petras           <DPetras[AT]ELSA.de> 
+  Fred Reimer              <fwr[AT]ga.prestige.net>
+  Florian Lohoff           <flo[AT]rfc822.org>
+  Jochen Friedrich         <jochen+ethereal[AT]scram.de>
+  Paul Welchinski          <paul.welchinski[AT]telusplanet.net>
+  Doug Nazar               <nazard[AT]dragoninc.on.ca>
+  Andreas Sikkema          <andreas.sikkema[AT]philips.com>
+  Mark Muhlestein          <mmm[AT]netapp.com>
+  Graham Bloice            <graham.bloice[AT]trihedral.com>
+  Ralf Schneider           <ralf.schneider[AT]alcatel.se>
+  Yaniv Kaul               <ykaul[AT]netvision.net.il>
+  Paul Ionescu             <ipaul[AT]romsys.ro>
+  Mark Burton              <markb[AT]ordern.com>
+  Stefan Raab              <sraab[AT]cisco.com>
+  Mark Clayton             <clayton[AT]shore.net>
+  Michael Rozhavsky        <mike[AT]tochna.technion.ac.il>
+  Dug Song                 <dugsong[AT]monkey.org>
+  Michael Tuexen           <Michael.Tuexen[AT]icn.siemens.de>
+  Bruce Korb               <bkorb[AT]sco.com>
+  Jose Pedro Oliveira      <jpo[AT]di.uminho.pt>
+  David Frascone           <dave[AT]frascone.com>
+  Peter Kjellerstedt       <pkj[AT]axis.com>
+  Phil Techau              <phil_t[AT]altavista.net>
+  Wes Hardaker             <wjhardaker[AT]ucdavis.edu>
+  Robert Tsai              <rtsai[AT]netapp.com>
+  Craig Metz               <cmetz[AT]inner.net>
+  Per Flock                <per.flock[AT]axis.com>
+  Jack Keane               <jkeane[AT]OpenReach.com>
+  Brian Wellington         <bwelling[AT]xbill.org>
+  Santeri Paavolainen      <santtu[AT]ssh.com>
+  Ulrich Kiermayr          <uk[AT]ap.univie.ac.at>
+  Neil Hunter              <neil.hunter[AT]energis-squared.com>
+  Ralf Holzer              <ralf[AT]well.com>
+  Craig Rodrigues          <rodrigc[AT]mediaone.net>
+  Ed Warnicke              <hagbard[AT]physics.rutgers.edu>
+  Johan Jorgensen          <johan.jorgensen[AT]axis.com>
+  Frank Singleton          <frank.singleton[AT]ericsson.com>
+  Kevin Shi                <techishi[AT]ms22.hinet.net>
+  Mike Frisch              <mfrisch[AT]saturn.tlug.org>
+  Burke Lau                <burke_lau[AT]agilent.com>
+  Martti Kuparinen         <martti.kuparinen[AT]nomadiclab.com>
+  David Hampton            <dhampton[AT]mac.com>
+  Kent Engström            <kent[AT]unit.liu.se>
+  Ronnie Sahlberg          <rsahlber[AT]bigpond.net.au>
+  Alexandre P. Ferreira    <alexandref[AT]spliceip.com.br>
+  Simharajan Srishylam     <Simharajan.Srishylam[AT]netapp.com>
+  Greg Kilfoyle            <gregk[AT]redback.com>
+  James E. Flemer          <jflemer[AT]acm.jhu.edu>
+  Peter Lei                <peterlei[AT]cisco.com>
+  Thomas Gimpel            <thomas.gimpel[AT]ferrari.de>
+  Albert Chin              <china[AT]thewrittenword.com>
+  Charles Levert           <charles[AT]comm.polymtl.ca>
+  Todd Sabin               <tas[AT]webspan.net>
+  Eduardo Pérez Ureta      <eperez[AT]dei.inf.uc3m.es>
+  Martin Thomas            <martin_a_thomas[AT]yahoo.com>
+  Hartmut Mueller          <hartmut[AT]wendolene.ping.de>
+  Michal Melerowicz        <Michal.Melerowicz[AT]nokia.com>
+  Hannes Gredler           <hannes[AT]juniper.net>
+  Inoue                    <inoue[AT]ainet.or.jp>
+  Olivier Biot             <Olivier.Biot[AT]siemens.atea.be>
+  Patrick Wolfe            <pjw[AT]zocalo.cellular.ameritech.com>
+  Martin Held              <Martin.Held[AT]icn.siemens.de>
+  Riaan Swart              <rswart[AT]cs.sun.ac.za>
+  Christian Lacunza        <celacunza[AT]gmx.net>
+  Michael Rozhavsky        <mike[AT]tochna.technion.ac.il>
+  Scott Renfro             <scott[AT]renfro.org>
+  Juan Toledo              <toledo[AT]users.sourceforge.net>
+  Jean-Christian Pennetier <jeanchristian.pennetier[AT]rd.francetelecom.fr>
+  Jian Yu                  <bgp4news[AT]yahoo.com>
+  Eran Mann                <emann[AT]opticalaccess.com>
+  Andy Hood                <ahood[AT]westpac.com.au>
+  Randy McEoin             <rmceoin[AT]pe.net>
+  Edgar Iglesias           <edgar.iglesias[AT]axis.com>
+  Martina Obermeier        <Martina.Obermeier[AT]icn.siemens.de>
+  Mark Burton              <markb[AT]ordern.com>
+  Javier Achirica          <achirica[AT]ttd.net>
+  B. Johannessen           <bob[AT]havoq.com>
+  Thierry Pelle            <thierry.pelle[AT]rd.francetelecom.fr>
+  Francisco Javier Cabello <fjcabello[AT]vtools.es>
+  Laurent Rabret           <laurent.rabret[AT]rd.francetelecom.fr>
+  nuf si                   <gnippiks[AT]yahoo.com>
+  Jeff Morriss             <jeff.morriss[AT]ulticom.com>
+  Aamer Akhter             <aakhter[AT]cisco.com>
+  Pekka Savola             <pekkas[AT]netcore.fi>
+  David Eisner             <cradle[AT]Glue.umd.edu>
+  Steve Dickson            <steved[AT]talarian.com>
+  Markus Seehofer          <mseehofe[AT]nt.hirschmann.de>
+  Lee Berger               <lberger[AT]roy.org>
+  Motonori Shindo          <mshindo[AT]mshindo.net>
+  Terje Krogdahl           <tekr[AT]nextra.com>
+  Jean-Francois Mule       <jfmule[AT]clarent.com>
+  Thomas Wittwer           <thomas.wittwer[AT]iclip.ch>
+  Palle Lyckegaard         <Palle[AT]lyckegaard.dk>
+  Nicolas Balkota          <balkota[AT]mac.com>
+  Tom Uijldert             <Tom.Uijldert[AT]cmg.nl>
+  Endoh Akira              <endoh[AT]netmarks.co.jp>
+  Graeme Hewson            <graeme.hewson[AT]oracle.com>
+  Pasi Eronen              <pasi.eronen[at]nixu.com>
+  Georg von Zezschwitz     <gvz[AT]2scale.net>
+
+Alain Magloire <alainm[AT]rcsm.ece.mcgill.ca> was kind enough to give his
 permission to use his version of snprintf.c.
 
-Dan Lasley <dlasley@promus.com> gave permission for his dumpit() hex-dump
+Dan Lasley <dlasley[AT]promus.com> gave permission for his dumpit() hex-dump
 routine to be used.
+
+Mattia Cazzola <mattiac[AT]alinet.it> provided a patch to the hex dump
+display routine.
+
+We use the exception module from Kazlib, a C library written by
+Kaz Kylheku <kaz[AT]ashi.footprints.net>. Thanks goes to him for his
+well-written library. The Kazlib home page can be found at
+http://users.footprints.net/~kaz/kazlib.html