$Id: README,v 1.4 2004/05/02 23:56:42 jeffm Exp $

vflow is an attempt at a ruby replacement for the perl Cflow or python pyflowtool
modules. This is beta and should be safe for limited use it passes testing by the
vftest.rb script.

Installation
============
To install do the following

ruby extconf.rb
make
make install

The following methods are defined as part of vflow
new()
 Creates and returns a vflow object	
open()
 Open file of filename which has been created by flow-tools for reading.
close()
 Close the current file
currentfile()
 return the name of the current file being read from.
next()
 Returns a vflowrec object containing the values of the next entry in the file.
each()
 This loops over all entries from the current position calling the associated
 block. See the example below.


Example
========
require 'Vflow'
vf = Vflow.new()
vf.open('aflowfile')
vf.each() { |r|
	# do something
}
vf.close()


To Do
=====
modify open() to take an array of filenames and automatically interate from
the end of one to the start of annother.
modify open() to take directory names and interacte over each file in the given
directory.
add method to extract header info
add method to get flow version