NOTE: this document applies to the IceScan source releases.  

Installation
============

These are installation instructions for Unix and Unix-like systems
that can run the "configure" script in this same directory. These
are not the installation instructions for Windows systems; see
README.win32 for those instructions.

0. This is beta software. Beware.

1. If you wish to build IceScan, make sure you have libpcap
   installed.  The latest "official" version can be found at

        http://www.tcpdump.org .

   If you installed libpcap from a binary package, you may have to
   install a "development" package; for example, there's
   apparently a "libpcap0" Debian package, but it just includes a
   shared library, a copyright notice, changelog files, and a
   README file - you also need to install a "libpcap-dev" package
   to get header files, a non-shared library, and the man page.
   Similarly, Red Hat ES/Fedora users will need to install a 
   "libpcap-devel" .rpm to go along with the "libpcap" .rpm.

2. To run IceScan you also need libpcre. The latest "official" version 
   can be found at
        http://www.pcre.org
   If you installed libpcre from a binary package, you may have to
   install a "development" package: e.g. libpcre-dev or something
   simular.

3. For advanced functionality of IceScan it's recommened to install
   Dug Song's excellent libdnet. You can get "official" version at
        http://libdnet.sourceforge.net/
   If you installed libdnet from a binary package, you may have to
   install a "development" package: e.g. libdnet-dev (or libdumbnet-dev in
   Ubuntu) or something simular.

4. If you want to use IceScan scripting engine, you should install Lua. 
   It can be found at 
        http://www.lua.org

5. Run './configure' in the IceScan distribution directory.
   Running './configure --help' displays a list of options.
   The file 'INSTALL.configure' contains general instructions for
   using 'configure' and 'make'. IceScan has some non-generic configure 
   options:

    --sysconfdir=DIR
        IceScan installs a support file (manuf) in ${PREFIX}/etc by
        default, where ${PREFIX} comes from --prefix=DIR. If you do not
        specify any --prefix option, ${PREFIX} is "/usr/local".
        You can change the location of the manuf file with the --sysconfdir
        option.

    --disable-usr-local
        By default 'configure' will look in /usr/local/{include,lib} for
        additional header files and libraries. Using this switch keeps
        'configure' from looking there

    --with-pcap=DIR
        Use this to tell IceScan where you have libpcap installed, if
        it is installed in a non-standard location.

6. After running './configure', you will see a summary of some
   of the options you chose. Ensure that the summary reflects
   what you want. If it doesn't, re-run './configure' with new options.

7. Run 'make'.  Hopefully, you won't run into any problems.

8. Run './icescan' and make sure things are working.
   You must have root privileges in order to capture live data.

9. Run 'make install'. 

If you have trouble with the build or installation process, you can
find assistance on the icescan-users an icescan-dev mailing lists.
See http://sourceforge.net/mail/?group_id=185109 for details.