build_geoip: copy headers
[netsniff-ng.git] / README
blob2d9032a900b4a4c20321dc22d80da5695c74d0b4
1 //////////////////////////////////////////////////////////////////////////////
3                     netsniff-ng - the packet sniffing beast
5 \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
6                                          .      .
7 netsniff-ng is a free, performant       /(      )\
8 Linux network analyzer and            .' {______} '.
9 networking toolkit. If you will,       \ ^,    ,^ /
10 the Swiss army knife for network        |'O\  /O'|   _.<0101011>--
11 packets.                                > `'  '` <  /
12                                         ) ,.==., (  |
13 Release: 2012-06-29                  .-(|/--~~--\|)-'
14                                     (      ___
15 Web: http://netsniff-ng.org          \__.=|___E 
17 The gain of performance is reached by zero-copy mechanisms, so that on packet
18 reception and transmission the kernel does not need to copy packets from kernel
19 space to user space and vice versa.
21 The netsniff-ng toolkit can be used for network development and analysis,
22 debugging, auditing or network reconnaissance. It currently consists of the
23 following utilities:
25   * netsniff-ng: a zero-copy packet analyzer, pcap capturing/replaying tool
26   * trafgen: a zero-copy network packet generator
27   * mausezahn: packet generator and analyzer for HW/SW appliances with Cisco-CLI
28   * ifpps: a top-like kernel networking and system statistics tool
29   * curvetun: a lightweight curve25519-based multiuser IP tunnel
30   * astraceroute: an autonomous system trace route and DPI testing utility
31   * flowtop: a top-like netfilter connection tracking tool
32   * bpfc: a tiny Berkeley Packet Filter compiler with Linux extensions
34 Have a look at the Documentation/ folder for further information, also at known
35 issues under Documentation/KnownIssues. Carefully read the INSTALL document for
36 the next steps in building netsniff-ng.
38 The netsniff-ng toolkit is an Open Source project covered by the GNU General 
39 Public License. For any questions or feedback about netsniff-ng you are welcome
40 to leave us a message to <workgroup@netsniff-ng.org> or to our mailing list
41 at <netsniff-ng@googlegroups.com> (Note: you have to register first).
42 netsniff-ng is purely non-profit and provided in the hope, that it is found
43 useful. The current project status can be considered as "working". In general,
44 all tools have been tested by us to a great extend including their command-line
45 options. In fact, many of our tools are used in production systems. However, we
46 give no guarantee that our tools are free of bugs! If you spot some issues,
47 contact us as described in REPORTING-BUGS. Also, have a look at our FAQ [2] for
48 answering your questions. This project has received support from institutions
49 listed in Documentation/Sponsors.
51 Happy packet hacking!
53 [1] http://netsniff-ng.org/
54 [2] http://netsniff-ng.org/faq.html