$Id: README,v 1.6 2001/06/06 22:50:59 pcharles Exp $

                               jpcap README


  General Information

    jpcap is a set of Java classes which provide an interface and system 
    for network packet capture. A protocol library and tool for visualizing 
    network traffic is included. 

    jpcap hides the low-level details of network packet capture by 
    abstracting many network packet types and protocols into Java classes. 
    Internally, jpcap implements bindings to the libpcap system library 
    through JNI (the Java Native Interface). 

    jpcap utilizes libpcap, a widely deployed shared-library for capturing 
    user-level packets. libpcap must be installed on your system in order 
    to use jpcap.

    jpcap consists of a small shared-library which wraps libpcap plus a 
    collection of Java classes. The shared-library component provides event 
    hooks, communication and data conversion between a running Java VM and 
    libpcap. The Java class components provide a abstractions for 
    many network packet types and protocols.


  Running

    If you have installed from RPM and are looking to run the capture tool,
    try /usr/bin/jpcap.

    If you installed from .gz, try ./jpcap.


  Development Documentation

    If you downloaded a jpcap distribution from sourceforge and are looking
    for information on installing/running jpcap binaries, see docs/INSTALL.

    If you checked out jpcap from the CVS repository and are looking 
    for information on building jpcap in this tree, see docs/BUILD.

    Specific documentation on the jpcap java packages can be found in 
    src/java/net/sourceforge/jpcap/README


    Additional information can be found on sourceforge.net, where 
    development is hosted.

      jpcap -- http://www.sf.net/projects/jpcap

