Updated build documentation.
[netsniff-ng.git] / INSTALL
blobd2b1182f5547188e1d917d30f0d5729a944a4419
1 Currently only operating systems running on Linux kernels with
2 CONFIG_PACKET_MMAP enabled. This feature can be found even back
3 to the days of 2.4 kernels. Most operating systems ship pre-compiled
4 kernels that have this config option enabled and even the latest
5 kernel versions got rid of this option and have this functionality
6 already built-in. However, we recommend a kernel >= 2.6.31, because
7 the TX_RING is officially integrated since then.
9 netsniff-ng has been successfully tested on x86 and x86_64. Please drop
10 us a short mail, if it runs successfully on hardware other than that.
11 We assume, it will run, but unfortunately, we don't have other hardware
12 than that.
14 What libraries / tools are required?
16  - libc (all)
17  - libpthread (curvetun, netsniff-ng)
18  - libncurses (ifpps)
19  - libGeoIP (ashunt)
20  - flex, bison (bpfc)
21  - libnacl (curvetun, fetched and built automatically on make)
23 It is common, that these libraries are shipped as distribution packages
24 for an easy installation. We try to keep this as minimal as possible.
26 The installation process is fairly simple:
28   $ cd netsniff-ng/src/
29   $ mkdir build
30   $ cd build
31   $ cmake ..
32   $ make
33   # make install
35 The uninstallation process is analogous:
37   $ cd netsniff-ng/src/build
38   # make uninstall