LIBSMI -- A LIBRARY FOR SMI MANAGEMENT INFORMATION
==================================================

Copyright (c) 1999-2001 Frank Strauss, Technical University of Braunschweig.

See the file "COPYING" for information on usage and redistribution
of this file, and for a DISCLAIMER OF ALL WARRANTIES.

@(#) $Id: README,v 1.24 2001/03/06 11:41:58 strauss Exp $

This project has been started as part of Frank Strauss' master's
thesis at the Technical University of Braunschweig, Germany.


MANIFEST
========

README					this file
COPYING					the libsmi lincense terms
ChangeLog				a rough history of changes
TODO					incomplete list of things to be done
configure				configure script
lib/					library source code
tools/					tools source code
doc/draft-irtf-nmrg-sming-02.txt	old SMIng specification
mibs/					MIB modules to be installed
test/					some test patterns
win/					Win32 port source code


INSTALLATION
============

Requirements: gcc, flex, bison, and other things most UNIX systems
have on board. The compiler has to support `long long' types.

To configure libsmi, first check

	./configure --help

output to see, what options are available. Then run

	./configure [options]

with the options of your choice. Choose mibdir and smipath values
appripriate for your environment so that users can live without an
SMIPATH environment variable and without configuration files.

On HP-UX platforms the build process is reported to require gcc
and the --disable-shared configure option.

To build libsmi and the tools, run

	make

This should build the library libsmi in lib/ and the tools, namely
tools/smilint, tools/smidump, tools/smiquery, and the shell script
tools/smistrip.

Now, you may run some checks by

	make check

Note that some tests of this test suite may fail, if GNU diff was not
found.

If you wish to install the library, the MIB modules, the tools
and the man pages, run

	make install

To use libsmi applications you might want to configure its behaviour.
Detailed library options, including per-application options, can
be configured through a global and a user level configuration file.
Additionally the SMIPATH environment variable can be used to configure
paths of module locations. See the smi_config(3) man page.


DEBUGGING
=========

If you encounter any crashes or feel for any other reasons the need to
debug the libsmi tools, you should link the tools statically. This is
the easiest way to get around the problems when your debugger claims to
be unable to read the libsmi binary files, since they are built using
libtool. You can build the libsmi tools statically by

	make clean
	./configure --enable-static --disable-shared
	make


FURTHER READING
===============

Read the man pages for library concepts and usage and for the tools.
Please note that SMIng is currently in a quite inconsistent and outdated
state. It does not reflect what is being discussed in the IETF SMING WG
as of spring 2001. See the old specs in doc/draft-irtf-nmrg-sming-02.txt
for details on SMIng as it is implemented so far. 

You may find further information online, along with the subscription
information on the libsmi mailing list at

	http://www.ibr.cs.tu-bs.de/projects/libsmi/.



	Frank Strauss <strauss@ibr.cs.tu-bs.de>