$Id: README,v 1.2 2001/06/25 01:38:59 todd Exp $

tclpcap v0.1

This is a Tcl extension that allows access to the libpcap library.  It was
written and is actively maintained by Todd J Martin <todd.martin@acm.org>.
The official tclpcap site is tclpcap.sourceforge.net.

For more information about the libpcap library, go to http://www.tcpdump.org.

This extension is not merely a one-to-one mapping of Tcl commands to libpcap
functions (although in a few cases it is).  I looked at that and it just
wasn't right for Tcl.  Instead, this provides a new channel type for reading
and accessing the captured packets.  This allows much more flexibility and an
easier interface for the Tcl user.  The tclpcap man page describes the
commands provided by this extension.

This is the first release and should be considered alpha/beta.  It seems
stable to me, but hasn't been exposed to too many platforms.  I'm especially
interested to hear about compilation issues on the myriad of unix systems out
there.  This package should be portable to any system that can run Tcl and
libpcap.

To compile this:
./configure
make && make install

Configure provides many options.  Run ./configure --help to see a list.  On
BSD systems, be sure to run the GNU make, usually called gmake.

The script example.tcl is provided which is used for testing and provides an
example of how to use the features provided by tclpcap.
