]> The Tcpdump Group git mirrors - tcpdump/blobdiff - README.md
projects / tcpdump / blobdiff
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
bgp: Parse BGP extended message support capability
[tcpdump] / README.md
diff --git a/README.md b/README.md
index e9fd5a8485d6788adbda906efa64ade18c7e54a2..07ce3639b6bbca61c2ca2efb155b09d5d058e2ef 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,97 +1,79 @@
-# tcpdump
+# TCPDUMP 4.x.y by [The Tcpdump Group](https://www.tcpdump.org/)
 
 
-[![Build
-Status](https://travis-ci.org/the-tcpdump-group/tcpdump.png)](https://travis-ci.org/the-tcpdump-group/tcpdump)
+**To report a security issue please send an e-mail to [email protected].**
 
 
-TCPDUMP 4.x.y  
-Now maintained by "The Tcpdump Group"  
-See            www.tcpdump.org  
+To report bugs and other problems, contribute patches, request a
+feature, provide generic feedback etc please see the
+[guidelines for contributing](CONTRIBUTING) in the tcpdump source tree root.
 
 
-Please send inquiries/comments/reports to:
+Anonymous Git is available via
 
 
-* [email protected]
-
-Anonymous Git is available via:
-
-       git clone git://bpf.tcpdump.org/tcpdump
-
-Please submit patches by forking the branch on GitHub at:
-
-*      http://github.com/the-tcpdump-group/tcpdump/tree/master
-
-and issuing a pull request.
-
-formerly from  Lawrence Berkeley National Laboratory  
-               Network Research Group <[email protected]>  
-               ftp://ftp.ee.lbl.gov/old/tcpdump.tar.Z (3.4)
+       https://github.com/the-tcpdump-group/tcpdump.git
 
 This directory contains source code for tcpdump, a tool for network
 
 This directory contains source code for tcpdump, a tool for network
-monitoring and data acquisition.  This software was originally
-developed by the Network Research Group at the Lawrence Berkeley
-National Laboratory.  The original distribution is available via
-anonymous ftp to `ftp.ee.lbl.gov`, in `tcpdump.tar.Z`.  More recent
-development is performed at tcpdump.org, http://www.tcpdump.org/
+monitoring and data acquisition.
 
 
+Over the past few years, tcpdump has been steadily improved by the
+excellent contributions from the Internet community (just browse
+through the [change log](CHANGES)).  We are grateful for all the input.
+
+### Supported platforms
+In many operating systems tcpdump is available as a native package or port,
+which simplifies installation of updates and long-term maintenance. However,
+the native packages are sometimes a few versions behind and to try a more
+recent snapshot it will take to compile tcpdump from the source code.
+
+tcpdump compiles and works on at least the following platforms:
+
+* AIX
+* DragonFly BSD
+* FreeBSD
+* Haiku
+* HP-UX 11i
+* GNU/Linux
+* {Mac} OS X / macOS
+* NetBSD
+* OpenBSD
+* OpenIndiana
+* OpenWrt
+* Solaris
+* Windows (requires WinPcap or Npcap, and Visual Studio with CMake)
+
+### Dependency on libpcap
 Tcpdump uses libpcap, a system-independent interface for user-level
 packet capture.  Before building tcpdump, you must first retrieve and
 Tcpdump uses libpcap, a system-independent interface for user-level
 packet capture.  Before building tcpdump, you must first retrieve and
-build libpcap, also originally from LBL and now being maintained by
-tcpdump.org; see http://www.tcpdump.org/ .
+build libpcap.
 
 Once libpcap is built (either install it or make sure it's in
 
 Once libpcap is built (either install it or make sure it's in
-`../libpcap`), you can build tcpdump using the procedure in the `INSTALL.txt`
-file.
+`../libpcap`), you can build tcpdump using the procedure in the
+[installation guide](INSTALL.txt).
 
 
+### Origins of tcpdump
 The program is loosely based on SMI's "etherfind" although none of the
 etherfind code remains.  It was originally written by Van Jacobson as
 The program is loosely based on SMI's "etherfind" although none of the
 etherfind code remains.  It was originally written by Van Jacobson as
-part of an ongoing research project to investigate and improve tcp and
-internet gateway performance.  The parts of the program originally
+part of an ongoing research project to investigate and improve TCP and
+Internet gateway performance.  The parts of the program originally
 taken from Sun's etherfind were later re-written by Steven McCanne of
 LBL.  To insure that there would be no vestige of proprietary code in
 tcpdump, Steve wrote these pieces from the specification given by the
 manual entry, with no access to the source of tcpdump or etherfind.
 taken from Sun's etherfind were later re-written by Steven McCanne of
 LBL.  To insure that there would be no vestige of proprietary code in
 tcpdump, Steve wrote these pieces from the specification given by the
 manual entry, with no access to the source of tcpdump or etherfind.
+```text
+formerly from  Lawrence Berkeley National Laboratory
+               Network Research Group <[email protected]>
+               ftp://ftp.ee.lbl.gov/old/tcpdump.tar.Z (3.4)
+```
 
 
-Over the past few years, tcpdump has been steadily improved by the
-excellent contributions from the Internet community (just browse
-through the `CHANGES` file).  We are grateful for all the input.
-
+### See also
 Richard Stevens gives an excellent treatment of the Internet protocols
 in his book *"TCP/IP Illustrated, Volume 1"*. If you want to learn more
 about tcpdump and how to interpret its output, pick up this book.
 
 Richard Stevens gives an excellent treatment of the Internet protocols
 in his book *"TCP/IP Illustrated, Volume 1"*. If you want to learn more
 about tcpdump and how to interpret its output, pick up this book.
 
-Some tools for viewing and analyzing tcpdump trace files are available
-from the Internet Traffic Archive:
-
-* http://www.acm.org/sigcomm/ITA/
-
-Another tool that tcpdump users might find useful is tcpslice:
-
-* https://github.com/the-tcpdump-group/tcpslice
-
+Another tool that tcpdump users might find useful is
+[tcpslice](https://github.com/the-tcpdump-group/tcpslice).
 It is a program that can be used to extract portions of tcpdump binary
 It is a program that can be used to extract portions of tcpdump binary
-trace files. See the above distribution for further details and
-documentation.
-
-Problems, bugs, questions, desirable enhancements, etc. should be sent
-to the address "[email protected]".  Bugs, support
-requests, and feature requests may also be submitted on the GitHub issue
-tracker for tcpdump at:
-
-* https://github.com/the-tcpdump-group/tcpdump/issues
-
-Source code contributions, etc. should be sent to the email address
-above or submitted by forking the branch on GitHub at:
-
-* http://github.com/the-tcpdump-group/tcpdump/tree/master
-
-and issuing a pull request.
-
-Current versions can be found at www.tcpdump.org.
-
- - The TCPdump team
-
-original text by: Steve McCanne, Craig Leres, Van Jacobson
+trace files.
 
 
--------------------------------------
+### The original LBL README by Steve McCanne, Craig Leres and Van Jacobson
 ```
 This directory also contains some short awk programs intended as
 examples of ways to reduce tcpdump data when you're tracking
 ```
 This directory also contains some short awk programs intended as
 examples of ways to reduce tcpdump data when you're tracking
[mirror] the TCPdump network dissector