        netup / xnetup  --  the Poor Man's Network Management System
        ------------------------------------------------------------

VERSION

This version is $Id: README,v 1.4 1994/11/08 14:35:09 wolf Exp $.
See the file HISTORY.


NOTE TO FRENCH LANGUAGE READERS

Une documentation HTML en ligne est disponible.
URL: http://www.pasteur.fr/units/sis/netup/


INTRODUCTION

Netup / xnetup is a set of tools which monitor the availability of
a set of IP connected equipements. Netup does all network activity (with
the help of fping) and logging whereas Xnetup is a convenient user interface
which uses the output from Netup.

Netup will check regularly (say every 2 minutes) if the indicated hosts
are responsing to ping requests or not and will log the state changes
and state summary to files or to any generic and configurable action
(for example an external program such as Mail).

Xnetup uses the summary file generated by Netup and eases reading of
the reports and history. The output can be sorted and filtered with
several criterias to meet the users' wishes. It can also be configured to
display only the names of the hosts which are down. A double click in
the name of a host does a direct telnet to it.


PREREQUISITES

In order to run Netup you need Perl and Fping on your system.
Perl can be obtained for your nearest GNU archive, Fping is made
available in the same directory as this package for your
convenience.

In order to run Xnetup you need to have Netup up and running and
your system must have a running Tcl 7.3 / Tk 3.6. The authors have
no idea wether this package will work with older versions of Tk/Tcl.

Tcl/Tk can be obtained from your nearest Tcl/Tk archive site.


AVAILABILITY

This package is available with respect of the terms listed in the
COPYRIGHT file. You can retrieve it by anonymous ftp in the
directory:

ftp://ftp.pasteur.fr/pub/Network/Netup/


AUTHORS

The authors can be joined electronically as Pierre David <pda@prism.uvsq.fr>
and Christophe Wolfhugel <wolf@pasteur.fr>. You are encouraged to report any 
bugs or extensions to us.

Bugs reports, questions and suggestions should be reported to the
address <netup@pasteur.fr> rather than to the author's personnal
email addresses.


INSTALLATION

Create a directory where the log files will reside.

Next, change the following files:
    netup:
	change the first line:
	    #! ...
	to point to your Perl binary

	change the line:
	    $conf = "/..."
	to point to the actual netup.conf file

    xnetup:
	change the first line:
	    #! ...
	to point to your wish binary (wish comes with Tcl/Tk)

	change the line:
	    set conf(conf)	/...
	to point to the actual netup.conf file

    netup.conf:
	change the "fping", "action", and "host" lines, according to the
	manual page netup.conf(5).

Next, run netup:

	$ netup

    As netup is ran as a daemon, you get the shell prompt back quickly.
    You should receive a mail indicating that netup detected the initial
    state change (from ?? to alive) for all hosts listed in your netup.conf
    file.
    Once netup has started, it will last as long as the system runs or as
    it is killed. You may want to start it up in the /etc/rc.local script.

At last, if you have an X11 display at hand, run xnetup:

	$ xnetup

    And you should see the main window. You can start and stop xnetup
    without fear. It is not interfering with the netup program.
    More than one xnetup program may run exploiting only one set of
    netup files.

Enjoy!
