Merge branch 'vendor/TCPDUMP'
[dragonfly.git] / contrib / tcpdump / INSTALL.txt
1 @(#) $Header: /tcpdump/master/tcpdump/INSTALL.txt,v 1.2 2008-02-06 10:47:53 guy Exp $ (LBL)
2
3 If you have not built libpcap, and your system does not have libpcap
4 installed, install libpcap first.  Your system might provide a version
5 of libpcap that can be installed; if so, to compile tcpdump you might
6 need to install a "developer" version of libpcap as well as the
7 "run-time" version.  You can also install tcpdump.org's version of
8 libpcap; see the README file in this directory for the ftp location.
9
10 You will need an ANSI C compiler to build tcpdump. The configure script
11 will abort if your compiler is not ANSI compliant. If this happens, use
12 the GNU C compiler, available via anonymous ftp:
13
14         ftp://ftp.gnu.org/pub/gnu/gcc/
15
16 After libpcap has been built (either install it with "make install" or
17 make sure both the libpcap and tcpdump source trees are in the same
18 directory), run ./configure (a shell script).  "configure" will
19 determine your system attributes and generate an appropriate Makefile
20 from Makefile.in.  Now build tcpdump by running "make".
21
22 If everything builds ok, su and type "make install".  This will install
23 tcpdump and the manual entry.  Any user will be able to use tcpdump to
24 read saved captures.  Whether a user will be able to capture traffic
25 depends on the OS and the configuration of the system; see the tcpdump
26 man page for details.  DO NOT give untrusted users the ability to
27 capture traffic.  If a user can capture traffic, he or she could use
28 utilities such as tcpdump to capture any traffic on your net, including
29 passwords.
30
31 Note that most systems ship tcpdump, but usually an older version.
32 Remember to remove or rename the installed binary when upgrading.
33
34 If your system is not one which we have tested tcpdump on, you may have
35 to modify the configure script and Makefile.in. Please send us patches
36 for any modifications you need to make.
37
38 Please see "PLATFORMS" for notes about tested platforms.
39
40
41 FILES
42 -----
43 CHANGES         - description of differences between releases
44 CREDITS         - people that have helped tcpdump along
45 FILES           - list of files exported as part of the distribution
46 INSTALL.txt     - this file
47 LICENSE         - the license under which tcpdump is distributed
48 Makefile.in     - compilation rules (input to the configure script)
49 README          - description of distribution
50 Readme.Win32    - notes on building tcpdump on Win32 systems (with WinPcap)
51 VERSION         - version of this release
52 acconfig.h      - autoconf input
53 aclocal.m4      - autoconf macros
54 addrtoname.c    - address to hostname routines
55 addrtoname.h    - address to hostname definitions
56 ah.h            - IPSEC Authentication Header definitions
57 aodv.h          - AODV definitions
58 appletalk.h     - AppleTalk definitions
59 arcnet.h        - ARCNET definitions
60 atime.awk       - TCP ack awk script
61 atm.h           - ATM traffic type definitions
62 atmuni31.h      - ATM Q.2931 definitions
63 bgp.h           - BGP declarations
64 bootp.h         - BOOTP definitions
65 bpf_dump.c      - BPF program printing routines, in case libpcap doesn't
66                   have them
67 chdlc.h         - Cisco HDLC definitions
68 cpack.c         - functions to extract packed data
69 cpack.h         - declarations of functions to extract packed data
70 config.guess    - autoconf support
71 config.h.in     - autoconf input
72 config.sub      - autoconf support
73 configure       - configure script (run this first)
74 configure.in    - configure script source
75 dccp.h          - DCCP definitions
76 decnet.h        - DECnet definitions
77 decode_prefix.h - Declarations of "decode_prefix{4,6}()"
78 enc.h           - OpenBSD IPsec encapsulation BPF layer definitions
79 esp.h           - IPSEC Encapsulating Security Payload definitions
80 ether.h         - Ethernet definitions
81 ethertype.h     - Ethernet type value definitions
82 extract.h       - alignment definitions
83 fddi.h          - Fiber Distributed Data Interface definitions
84 gmpls.c         - GMPLS definitions
85 gmpls.h         - GMPLS declarations
86 gmt2local.c     - time conversion routines
87 gmt2local.h     - time conversion prototypes
88 icmp6.h         - ICMPv6 definitiions
89 ieee802_11.h    - IEEE 802.11 definitions
90 ieee802_11_radio.h - radiotap header definitions
91 igrp.h          - Interior Gateway Routing Protocol definitions
92 install-sh      - BSD style install script
93 interface.h     - globals, prototypes and definitions
94 ip.h            - IP definitions
95 ip6.h           - IPv6 definitions
96 ipfc.h          - IP-over-Fibre Channel definitions
97 ipproto.c       - IP protocol type value-to-name table
98 ipproto.h       - IP protocol type value definitions
99 ipsec_doi.h     - ISAKMP packet definitions - RFC2407
100 ipx.h           - IPX definitions
101 isakmp.h        - ISAKMP packet definitions - RFC2408
102 l2vpn.c         - L2VPN encapsulation value-to-name table
103 l2vpn.h         - L2VPN encapsulation definitions
104 l2tp.h          - Layer Two Tunneling Protocol definitions
105 lane.h          - ATM LANE definitions
106 lbl/os-*.h      - OS-dependent defines and prototypes
107 llc.h           - LLC definitions
108 machdep.c       - machine dependent routines
109 machdep.h       - machine dependent definitions
110 makemib         - mib to header script
111 mib.h           - mib definitions
112 missing/*       - replacements for missing library functions
113 mkdep           - construct Makefile dependency list
114 mpls.h          - MPLS definitions
115 nameser.h       - DNS definitions
116 netbios.h       - NETBIOS definitions
117 netdissect.h    - definitions and declarations for tcpdump-as-library
118                   (under development)
119 nfs.h           - Network File System V2 definitions
120 nfsfh.h         - Network File System file handle definitions
121 nlpid.c         - OSI NLPID value-to-name table
122 nlpid.h         - OSI NLPID definitions
123 ntp.h           - Network Time Protocol definitions
124 oakley.h        - ISAKMP packet definitions - RFC2409
125 ospf.h          - Open Shortest Path First definitions
126 ospf6.h         - IPv6 Open Shortest Path First definitions
127 packetdat.awk   - TCP chunk summary awk script
128 parsenfsfh.c    - Network File System file parser routines
129 pcap_dump_ftell.c - pcap_dump_ftell() implementation, in case libpcap
130                 doesn't have it
131 pcap-missing.h  - declarations of functions possibly missing from libpcap
132 pmap_prot.h     - definitions for ONC RPC portmapper protocol
133 ppp.h           - Point to Point Protocol definitions
134 print-802_11.c  - IEEE 802.11 printer routines
135 print-ap1394.c  - Apple IP-over-IEEE 1394 printer routines
136 print-ah.c      - IPSEC Authentication Header printer routines
137 print-aodv.c    - AODV printer routines
138 print-arcnet.c  - ARCNET printer routines
139 print-arp.c     - Address Resolution Protocol printer routines
140 print-ascii.c   - ASCII packet dump routines
141 print-atalk.c   - AppleTalk printer routines
142 print-atm.c     - ATM printer routines
143 print-beep.c    - BEEP printer routines
144 print-bgp.c     - Border Gateway Protocol printer routines
145 print-bootp.c   - BOOTP and IPv4 DHCP printer routines
146 print-bt.c      - Bluetooth printer routines
147 print-cdp.c     - Cisco Discovery Protocol printer routines
148 print-chdlc.c   - Cisco HDLC printer routines
149 print-cip.c     - Classical-IP over ATM routines
150 print-cnfp.c    - Cisco NetFlow printer routines
151 print-dccp.c    - DCCP printer routines
152 print-decnet.c  - DECnet printer routines
153 print-dhcp6.c   - IPv6 DHCP printer routines
154 print-domain.c  - Domain Name System printer routines
155 print-dvmrp.c   - Distance Vector Multicast Routing Protocol printer routines
156 print-eap.c     - EAP printer routines
157 print-enc.c     - OpenBSD IPsec encapsulation BPF layer printer routines
158 print-egp.c     - External Gateway Protocol printer routines
159 print-esp.c     - IPSEC Encapsulating Security Payload printer routines
160 print-ether.c   - Ethernet printer routines
161 print-fddi.c    - Fiber Distributed Data Interface printer routines
162 print-fr.c      - Frame Relay printer routines
163 print-frag6.c   - IPv6 fragmentation header printer routines
164 print-gre.c     - Generic Routing Encapsulation printer routines
165 print-hsrp.c    - Cisco Hot Standby Router Protocol printer routines
166 print-icmp.c    - Internet Control Message Protocol printer routines
167 print-icmp6.c   - IPv6 Internet Control Message Protocol printer routines
168 print-igmp.c    - Internet Group Management Protocol printer routines
169 print-igrp.c    - Interior Gateway Routing Protocol printer routines
170 print-ip.c      - IP printer routines
171 print-ip6.c     - IPv6 printer routines
172 print-ip6opts.c - IPv6 header option printer routines
173 print-ipcomp.c  - IP Payload Compression Protocol printer routines
174 print-ipx.c     - IPX printer routines
175 print-isakmp.c  - Internet Security Association and Key Management Protocol
176 print-isoclns.c - ISO CLNS, ESIS, and ISIS printer routines
177 print-krb.c     - Kerberos printer routines
178 print-l2tp.c    - Layer Two Tunneling Protocol printer routines
179 print-lane.c    - ATM LANE printer routines
180 print-llc.c     - IEEE 802.2 LLC printer routines
181 print-lspping.c - LSPPING printer routines
182 print-lwres.c   - Lightweight Resolver protocol printer routines
183 print-mobile.c  - IPv4 mobility printer routines
184 print-mobility.c - IPv6 mobility printer routines
185 print-mpls.c    - Multi-Protocol Label Switching printer routines
186 print-msdp.c    - Multicast Source Discovery Protocol printer routines
187 print-netbios.c - NetBIOS frame protocol printer routines
188 print-nfs.c     - Network File System printer routines
189 print-ntp.c     - Network Time Protocol printer routines
190 print-null.c    - BSD loopback device printer routines
191 print-ospf.c    - Open Shortest Path First printer routines
192 print-ospf6.c   - IPv6 Open Shortest Path First printer routines
193 print-pflog.c   - OpenBSD packet filter log file printer routines
194 print-pgm.c     - Pragmatic General Multicast printer routines
195 print-pim.c     - Protocol Independent Multicast printer routines
196 print-ppp.c     - Point to Point Protocol printer routines
197 print-pppoe.c   - PPP-over-Ethernet printer routines
198 print-pptp.c    - Point-to-Point Tunnelling Protocol printer routines
199 print-radius.c  - Radius protocol printer routines
200 print-raw.c     - Raw IP printer routines
201 print-rip.c     - Routing Information Protocol printer routines
202 print-ripng.c   - IPv6 Routing Information Protocol printer routines
203 print-rrcp.c    - Realtek Remote Control Protocol routines
204 print-rsvp.c    - Resource reSerVation Protocol (RSVP) printer routines
205 print-rt6.c     - IPv6 routing header printer routines
206 print-rx.c      - AFS RX printer routines
207 print-sctp.c    - Stream Control Transmission Protocol printer routines
208 print-sip.c     - SIP printer routines
209 print-sl.c      - Compressed Serial Line Internet Protocol printer routines
210 print-sll.c     - Linux "cooked" capture printer routines
211 print-slow.c    - IEEE "slow protocol" (802.3ad) printer routines
212 print-smb.c     - SMB/CIFS printer routines
213 print-snmp.c    - Simple Network Management Protocol printer routines
214 print-stp.c     - IEEE 802.1d spanning tree protocol printer routines
215 print-sunatm.c  - SunATM DLPI capture printer routines
216 print-sunrpc.c  - Sun Remote Procedure Call printer routines
217 print-symantec.c - Symantec Enterprise Firewall printer routines
218 print-tcp.c     - TCP printer routines
219 print-telnet.c  - Telnet option printer routines
220 print-tftp.c    - Trivial File Transfer Protocol printer routines
221 print-timed.c   - BSD time daemon protocol printer routines
222 print-token.c   - Token Ring printer routines
223 print-udp.c     - UDP printer routines
224 print-usb.c     - USB printer routines
225 print-vjc.c     - PPP Van Jacobson compression (RFC1144) printer routines
226 print-vrrp.c    - Virtual Router Redundancy Protocol
227 print-wb.c      - White Board printer routines
228 print-zephyr.c  - Zephyr printer routines
229 route6d.h       - packet definition for IPv6 Routing Information Protocol
230 rpc_auth.h      - definitions for ONC RPC authentication
231 rpc_msg.h       - definitions for ONC RPC messages
232 rx.h            - AFS RX definitions
233 sctpConstants.h - Stream Control Transmission Protocol constant definitions
234 sctpHeader.h    - Stream Control Transmission Protocol packet definitions
235 send-ack.awk    - unidirectional tcp send/ack awk script
236 setsignal.c     - OS-independent signal routines
237 setsignal.h     - OS-independent signal prototypes
238 slcompress.h    - SLIP/PPP Van Jacobson compression (RFC1144) definitions
239 slip.h          - SLIP definitions
240 sll.h           - Linux "cooked" capture definitions
241 smb.h           - SMB/CIFS definitions
242 smbutil.c       - SMB/CIFS utility routines
243 stime.awk       - TCP send awk script
244 strcasecmp.c    - missing routine
245 tcp.h           - TCP definitions
246 tcpdump.1       - manual entry
247 tcpdump.c       - main program
248 telnet.h        - Telnet definitions
249 tftp.h          - TFTP definitions
250 timed.h         - BSD time daemon protocol definitions
251 token.h         - Token Ring definitions
252 udp.h           - UDP definitions
253 util.c          - utility routines
254 vfprintf.c      - emulation routine
255 win32           - headers and routines for building on Win32 systems