From 67ed1f8ea5d056a16f038967b424ce9fd2cd1e99 Mon Sep 17 00:00:00 2001 From: Daniel Borkmann Date: Wed, 28 Nov 2012 12:56:32 +0100 Subject: [PATCH] docs: update install document to new make system Signed-off-by: Daniel Borkmann --- INSTALL | 39 +++++++++++++++++++++++++++++++-------- 1 file changed, 31 insertions(+), 8 deletions(-) diff --git a/INSTALL b/INSTALL index 4b9a7497..c6348767 100644 --- a/INSTALL +++ b/INSTALL @@ -42,15 +42,27 @@ What additional tools are recommended after the build? It is common, that these libraries are shipped as distribution packages for an easy installation. We try to keep this as minimal as possible. -For downloading the latest GeoIP database, you should use the script that -is located at scripts/geoip-database-update. - -The installation process done by make is fairly simple: +After downloading the netsniff-ng toolkit, you should change to 'src': $ cd netsniff-ng/src/ + +The installation (deinstallation) process done by make is fairly simple: + $ make # make install + (# make distclean) + ($ make clean) + (or for both at once: # make mrproper) + +You can also build only a particular tool, e.g.: + + $ make trafgen + # make trafgen_install + + (# make trafgen_distclean) + ($ make trafgen_clean) + In order to build curvetun, libnacl must be built first. A helper script called build_nacl.sh is there to facilitate this process. If you want to build NaCl in the directory ~/nacl, the script should be called this way: @@ -58,6 +70,10 @@ build NaCl in the directory ~/nacl, the script should be called this way: $ cd src/curvetun $ ./build_nacl.sh ~/nacl +There's also an abbreviation for this by simply typing: + + $ make nacl + This gives an initial output such as "Building NaCl for arch amd64 on host fuuubar (grab a coffee, this takes a while) ...". If the automatically detected architecture (such as amd64) is not the one you intend to compile @@ -83,6 +99,17 @@ adapt paths within the script): $ cd src/astraceroute # ./build_geoip.sh +Again, there's also an abbreviation for this by simply typing: + + # make geoip + +For downloading the latest GeoIP database, you should use the script that +is located at scripts/geoip-database-update, or use: + + # make update + +If you're unsure with any make targets, check out: make help + In order to run the toolkit as a normal user, set the following privilege separation after the build/installation: @@ -95,10 +122,6 @@ is distributed with on most Linux systems. For bpfc, we also have a Vim syntax highlighting file. Have a look at scripts/bpf.vim for installation instructions. -To uninstall the toolkit from your system, simply execute: - - # make distclean - netsniff-ng has been successfully tested on x86 and x86_64. It should also run on most other major architectures. However, since we don't have a possibility to test it, please drop us a short mail, if it runs successfully on hardware -- 2.11.4.GIT