INSTALL

   1 Currently only operating systems running on Linux kernels with
   2 CONFIG_PACKET_MMAP enabled. This feature can be found even back to the days of
   3 2.4 kernels. Most operating systems ship pre-compiled kernels that have this
   4 config option enabled and even the latest kernel versions got rid of this
   5 option and have this functionality already built-in. However, we recommend a
   6 kernel >= 2.6.31, because the TX_RING is officially integrated since then.
   7
   8 netsniff-ng has been successfully tested on x86 and x86_64. Please drop
   9 us a short mail, if it runs successfully on hardware other than that.
  10
  11 What libraries / tools are required?
  12
  13  - libc (all)
  14  - cmake (all)
  15  - libpthread (curvetun, netsniff-ng, flowtop)
  16  - libncurses (ifpps, flowtop)
  17  - libGeoIP and its database (ashunt, flowtop)
  18  - flex, bison (bpfc)
  19  - libnacl (curvetun)
  20  - libnetfilter-conntrack (flowtop)
  21  - liburcu (flowtop)
  22
  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.
  25
  26 For downloading the latest GeoIP database, you can use the script that
  27 is located at scripts/geoip-database-update.
  28
  29 The installation process done by cmake is fairly simple:
  30
  31   $ cd netsniff-ng/src/
  32   $ mkdir build
  33   $ cd build
  34   $ cmake ..
  35   $ make
  36   # make install
  37
  38 Man pages are generated out of the corresponding source files by cmake.
  39 They are written in POD format as a C header comment within those files.
  40
  41 To uninstall, simply remove all files refered in install_manifest.txt
  42
  43 For bpfc, we also have a Vim syntax highlighting file. Have a look at
  44 scripts/bpf.vim for installation instructions.
  45
  46 In order to build curvetun, libnacl must be built first. A helper script
  47 called build_nacl.sh is there to facilitate this process. If you want to
  48 build NaCl in the directory ~/nacl, the script should be called this way:
  49
  50   $ cd src/curvetun
  51   $ ./build_nacl.sh ~/nacl
  52
  53 If NaCl already has been built on the target, it is quicker to use nacl_path.sh
  54 this way:
  55
  56   $ cd src/curvetun
  57   $ ./nacl_path.sh ~/nacl/build/include/x86 ~/nacl/build/lib/x86
  58
  59 When done, netsniff-ng build infrastructure will read nacl_path.cmake to get
  60 the needed paths to NaCl.
  61
  62 For using TUN/TAP devices as a user, copy the file src/50-tuntap.rules into
  63 /etc/udev/rules.d/ and restart the udev daemon.
  64