N o d e B r a i n   0.6.5

========================================================================

File:        README for nb-0.6.5 release files

Package:     NodeBrain (nb)

Version:     0.6 - Knucklehead

Release:     0.6.5

Date:        April 20, 2006

Reference:   http://www.nodebrain.org
               1) Online documentation
               2) Signatures to verify release file integrity

See NEWS for a list of changes in this release. (NEWS.txt on Windows)

======================================================================== 

Installation Instructions for Unix/Linux Platforms

1) Obtain a release file per instructions at www.nodebrain.org.
   There are three types of release files provided.

     o Documentation
     o Source 
     o Binary (includes source)

   These instructions support an install from either a source
   or binary distribution.

2) Extract the release file as follows.

     $ gunzip -.tar.gz
     $ tar -xf -.tar
     $ cd 

   For example, if you are installing from release file
   nb-0.6.5-source.tar.gz, it would look like this.

     $ gunzip nb-0.6.5-source.tar.gz
     $ tar -xf nb-0.6.5-source.tar
     $ cd nb-0.6.5

   If you have a GNU tar program, you can include the
   gunzip in the tar command.        

     $ tar -xzf nb-0.6.5-source.tar.gz
     $ cd nb-0.6.5

3) If you are installing from a source only distribution,
   or from a binary distribution that failed to work on
   your platform, compile your own binaries using the
   following command.

     $ ./build-nb

   This script simply performs the standard GNU build  
   commands shown below, which you could do yourself as an
   alternative. On some systems build-nb will extend the
   PATH variable before invoking these commands, and may
   substitute gmake for make.
    
     $ ./configure
     $ make
     $ make check

   Use the make command to install after running and checking
   your own build.

     $ make install

4) If you have a binaries distribution and skipped step 3,
   install using the install-nb command.

     $ ./install-nb

   You will normally need root authority to install to the
   standard directories.  If you do not have this authority,
   have a system administrator do the install for you, or
   install it to alternate directories.  Refer to the comments
   at the top of the install-nb script when installing to alternate
   directories.  

   To experiment with nb, you can often skip this step completely
   and just copy nb to a location of your choice.

======================================================================== 
Unix/Linux Platforms

The install instructions above have been tried with success on the
following platforms with this release. (See next section for Windows.)

OS            Hardware
-----------   ----------------------------------------------------
GNU/Linux
  Debian      x86, alpha,
  Fedora      x86
  Suse        amd64,IBM s390
UNIX
  FreeBSD     x86
  NetBSD      x86
  OpenBSD     x86
  Solaris     x86, sparc
  HPUX        hp 9000/700
  Mac OS X    ppc

Previous version of NodeBrain built ok on the following platforms, but
have not been tried with this release. 

OS            Hardware
-----------   ----------------------------------------------------
GNU/Linux         (Most distribtuions versions probably work)
  Mandrake    x86 (Not tested for several versions)
  Redhat      x86 (Compile farm switched to Fedora)
UNIX
  AIX         RS/6000 (skill modules will not work without a patch)
  Teradata    NCR (Not tested for several versions)
  Dynix/ptx   Sequent (End of life - not tested for several versions)
  zOS USS     IBM s390 (Not tested for several versions)
  IRIX        SGI (Compiled many versions ago)

======================================================================== 

Installation Instructions for Windows Platforms

The best way to install on a Windows platform is to obtain a Windows
distribution file.  A binary distribution with a Microsoft Installer (MSI)
file is provided for easy installation, and a source distribution is 
provided with Microsoft Visual Studio 6.0 C++ project workspace.

     nb-0.6.5-win.2k-x86.setup.zip    (binary)
     nb-0.6.5-source.msdsw.zip        (source)

If you are installing from the standard source only distribution on a
Windows platform and want to use Microsoft Visual Studio 6.0 to compile,
use the following settings.

  o  nb  

     Project type:   Win32 Console Application
     Link libraries: ws2_32.lib advapi32.lib librxspencer.lib

     You may obtain librxspencer.lib from gnuwin32.source.net
     download package RegEx-Spencer.  You may substitute a
     compatible RegEx library if you have a preference.
 
  o  nb_mod_console.dll
     nb_mod_netflow.dll
     nb_mod_servant.dll
     nb_mod_simple.dll
     nb_mod_snmptrap.dll
     nb_mod_syslog.dll
     nb_mod_translate.dll
     nb_mod_tree.dll

     Project type:   Win32 Dynamic-Link Library
     Link libraries: nb.lib msvcrt.lib  
     Link options:   /nodefaultlib:"libcmt.lib"

     You will need to build nb before linking skill modules.
     Qualify the nb.lib as necessary so the linker can
     find the one your built.

This release has only been built on Windows XP.

Windows   Status
--------  ---------------------------------------------------
XP        Compiled this release (0.6.5)
2003      Not tested
2000      Not tested
98        No longer supported
95        No longer supported.
======================================================================== 

Copyright (C) 1998-2006 The Boeing Company
                        Ed Trettevik 

NodeBrain 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 of the License, or
(at your option) any later version.

This program 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 this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

Software License:  See COPYING file (also LICENSE.txt on Windows)