#
# $Id: README,v 1.4 2005/04/19 04:11:51 evertonm Exp $
#

INTRODUCTION

	nepim stands for network pipemeter, a tool for measuring
	available bandwidth between hosts. nepim is also useful to
	generate network traffic for testing purposes.

	nepim operates in client/server mode, is able to handle
	multiple parallel traffic streams, reports periodic partial
	statistics along the testing, and supports IPv6.

LICENSE

	nepim - network pipemeter
	Copyright (C) 2005 Everton da Silva Marques

        nepim is free software; you can redistribute it and/or modify
        it under the terms of the GNU General Public License as
        published by the Free Software Foundation; either version 2,
        or (at your option) any later version.

        nepim is distributed in the hope that it will be useful, but
        WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        GNU General Public License for more details.

        You should have received a copy of the GNU General Public
        License along with nepim; see the file COPYING.  If not, write
        to the Free Software Foundation, Inc., 59 Temple Place - Suite
        330, Boston, MA 02111-1307, USA.

HOME SITE

	nepim lives at Savannah:

	http://www.nongnu.org/nepim/

REQUIREMENTS

        nepim depends on Liboop (1.0 or higher), available at:

        http://liboop.org/

BUILDING

	Before compiling nepim, install Liboop on your system.

	Then type:

	$ cd src
	$ make

	If you have Liboop installed on a special location, pass it to
	the make, as in the following example:

	$ cd src
	$ make OOP_BASE=/usr/local/oop

	Afterwards copy the 'nepim' binary to your system's proper
        filesystem location. For instance:

	$ cp nepim /usr/local/bin

	If you face trouble compiling, try tweaking the
	Makefile. Otherwise, post your problem at nepim support site.

USAGE

	Starting the server:

	$ nepim

	Starting the client:

	$ nepim -c 10.10.10.10 -d

	Display brief help about command line options:

	$ nepim -h

EXAMPLE

	Running nepim in server mode at the server host:

	server$ nepim
	running TCP listener socket on 0.0.0.0,1234
	could not create TCP listener socket on ::,1234
	FIXME: server.c spawn_udp_listener: 0.0.0.0
	FIXME: server.c spawn_udp_listener: ::

	Running nepim in client mode at the client host:

	client$ nepim -c 10.10.10.10 -d
	TCP socket solving 10.10.10.10,1234
	TCP socket trying 10.10.10.10,1234
	3: TCP socket connected to 10.10.10.10,1234
	3: greetings sent to 10.10.10.10,1234
	3: partial 2/10 kbps_recv=2780.85 kbps_sent=2505.92
	3: partial 4/10 kbps_recv=3465.14 kbps_sent=2162.69
	3: partial 6/10 kbps_recv=2454.27 kbps_sent=2818.05
	3: partial 8/10 kbps_recv=2653.17 kbps_sent=3407.87
	3: total 10/10 kbps_recv=2827.94 kbps_sent=2663.87
	client$

			      -- END --

