nefu Installation
=================

1.  Requirements

    To build nefu, you will need:
	-C compiler

2.  Creating nefu's user account
    
    nefu requires a user account to run.  By default nefu's user directory
    is /usr/local/nefu, but other directories can be substituted using
    the --prefix configure option.

3.  Configuring the source tree

    The `configure' shell script attempts to guess correct values for various
    system-dependent variables used during compilation.  It uses those values
    to create a `Makefile' in each directory of the package.  It will also
    create one or more `.h' files containing system-dependent definitions.
    Finally, it creates a shell script `config.status' that you can run in
    the future to recreate the current configuration, and a file `config.log'
    containing compiler output (useful mainly for debugging `configure').

    The autoconf program uses the file `configure.ac' used to create
    `configure'.  You only autoconf if you want to change `configure.ac' or
    regenerate `configure' using a newer version of `autoconf'.

    nefu's optional ldap test is built if configure finds ldap libraries,
    or if their path is specified.  If the ldap libraries require kerberos
    support, build nefu with --with-libkrb, or --without-ldap.

    configure options:
	--prefix=/path/to/nefu
	    Path to nefu's user directory.  Default is /usr/local/nefu.

	--exec-prefix=/path/to/nefu
	    Path to nefu's exec directory.  Default is /usr/local/nefu.

	--bindir
	    Directory for nefu's binary. Defaults to exec-prefix/bin.

	--mandir
	    Directory for /man1/files and /man4/files.  Defaults to
	    prefix/man.

	--with-shelltests=/path/to/shelltests/ --disable-shelltests
	    Directory for nefu shelltests.  Defaults to
	    exec-prefix/shelltests.

	--with-sendmail=/path/to/sendmail/
	    nefu requires the directory of the sendmail binary.  Use this
	    option if sendmail isn't in /usr/lib/ or /usr/sbin/.

	--with-ldap=/path/to/ldap --disable-ldap
	    By default, configure tries to find ldap libraries to build the
	    optional ldap test.  Give configure the path if the libraries are
	    installed and configure does not find them.

	--with-libkrb[=/path/to/libkrb/]
	    Configure does not build nefu with kerberos libraries by
	    default.  Kerberos libraries are needed if nefu is being built
	    with ldap libraries that require them. Give configure the
	    directory of the libraries if configure does not find them.

	--with-html=/path/to/html --disable-html
	    Build nefu with an specified html directory, or without html
	    support.  nefu will not create html directories or output
	    html files if --disable-html is invoked.  Defaults to
	    prefix/public_html.

4.  Building nefu

    At this point, simply run the command
	
	$ make

5.  Installing nefu

    Install the software in nefu's user account as nefu.

	$ su nefu
	$ make install

    Optionally configure your web server to publish ~nefu/public_html/

6.  Checking nefu's installation

    A simple way to see that nefu's installation is functioning properly is
    to monitor ping on a remote machine, then unplug the remote machine from
    the network.  nefu should notice, generate email, and update it's status
    pages.
