diff options
| author | Denis Ovsienko <denis@ovsienko.info> | 2021-02-05 14:25:11 +0000 |
|---|---|---|
| committer | Denis Ovsienko <denis@ovsienko.info> | 2021-02-05 14:25:11 +0000 |
| commit | 50c0ec867c9fb34707060a3048a5dd2ae398da6a (patch) | |
| tree | f40fce3d001b8b83a3f664934bac8c61e3b77022 /README.md | |
| parent | 9e651c514c58898c781639ec56f9ee4fa6a66b23 (diff) | |
| download | tcpdump-50c0ec867c9fb34707060a3048a5dd2ae398da6a.tar.gz | |
Refine Markdown in README.md. [skip appveyor]
Move "by TTG" to the main header and eliminate a few duplicate "by"
sentences. Update a CI badge to use the travis-ci.com URLs. Make the
security note bold to help more people actually get it. Change the git
URL to github.com to be consistent with libpcap. Add and refine a few
headers. Add and improve hyperlink formatting in a few places. Lose a
few excess generic sentences. Fixup some minor editorial issues. Fence
the "from LBL" boilerplate, move it to the bottom of the dedicated
section and eliminate a few duplicate "from" sentences.
Skip only some CI on this occasion, so Travis CI can transfer the build
history from travis-ci.org to travus-ci.com and complete the migration.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 77 |
1 files changed, 30 insertions, 47 deletions
@@ -1,80 +1,63 @@ -# tcpdump - -[](https://travis-ci.org/the-tcpdump-group/tcpdump) +# TCPDUMP 4.x.y by [The Tcpdump Group](https://www.tcpdump.org/) +[](https://travis-ci.com/github/the-tcpdump-group/tcpdump) [](https://ci.appveyor.com/project/guyharris/tcpdump) -To report a security issue please send an e-mail to security@tcpdump.org. +**To report a security issue please send an e-mail to security@tcpdump.org.** To report bugs and other problems, contribute patches, request a -feature, provide generic feedback etc please see the file -CONTRIBUTING in the tcpdump source tree root. - -TCPDUMP 4.x.y -Now maintained by "The Tcpdump Group" -See https://www.tcpdump.org - -Anonymous Git is available via: +feature, provide generic feedback etc please see the +[guidelines for contributing](CONTRIBUTING) in the tcpdump source tree root. - git clone git://bpf.tcpdump.org/tcpdump +Anonymous Git is available via -formerly from Lawrence Berkeley National Laboratory - Network Research Group <tcpdump@ee.lbl.gov> - 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 -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, https://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. + +### Dependency on libpcap 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 https://www.tcpdump.org/. +build libpcap. 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 -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. +```text +formerly from Lawrence Berkeley National Laboratory + Network Research Group <tcpdump@ee.lbl.gov> + 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. Some tools for viewing and analyzing tcpdump trace files are available -from the Internet Traffic Archive: - -* http://ita.ee.lbl.gov/ - -Another tool that tcpdump users might find useful is tcpslice: - -* https://github.com/the-tcpdump-group/tcpslice +from the [Internet Traffic Archive](http://ita.ee.lbl.gov/). +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 -trace files. See the above distribution for further details and -documentation. - -Current versions can be found at https://www.tcpdump.org. - - - The TCPdump group - -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 |