README for Cflow
----------------

   intro
   -----

   Cflow is a perl module providing an API for reading and analyzing
   raw flow files written by freely-available software packages such as
   CAIDA's cflowd, OSU flow-tools and lfapd which collect IP flow
   export information from routers.

   prerequisites
   -------------

   - perl version 5

   - one or more of the following collectors:
   
     * CAIDA's cflowd 2.x by Daniel McRobb (with Cisco's NetFlow v5):

        http://www.caida.org/tools/measurement/cflowd/
        http://net.doit.wisc.edu/~plonka/cflowd/

     * OSU flow-tools by Mark Fullmer (with Cisco's NetFlow v1, v5, v6, or v7):

        ftp://ftp.net.ohio-state.edu/users/maf/cisco/

     * lfapd by Steve Premeau (with Riverstone's LFAPv4):

        http://www.nmops.org/

   installation
   ------------

      If building for compatibility with OSU flow-tools-0.53,
      first do the following:

	 Build and install flow-tools normally (if you haven't):

            $ cd flow-tools-0.53
            $ ./configure
            $ make
            # make install

	 Extract Cflow in "contrib" under flow-tools build directory:

            $ mkdir -p contrib
            $ cd contrib
            $ gunzip -c Cflow-1.xxx.tar.gz | tar xf -
            $ cd Cflow-1.xxx

      Regardless of which collector you use, do this:

         $ perl Makefile.PL
         $ make
         # make install

   documentation
   -------------

      $ perldoc Cflow

      $ perldoc flowdumper

      $ flowdumper -h

--
$Id: README,v 1.8 2001/06/15 09:14:56 dplonka Exp $
Dave Plonka <plonka@doit.wisc.edu>
