nulib2/nufxlib-0
2002-10-01 00:50:07 +00:00
..
samples Reformatted files to use spaces instead of hard tabs. No substantitve changes. 2002-09-21 00:59:25 +00:00
Archive.c Reduced complaints when opening a non-NuFX archive file. 2002-10-01 00:50:07 +00:00
ArchiveIO.c Fixed minor bugs when trying to open a file that doesn't actually contain 2002-09-23 20:32:26 +00:00
ChangeLog.txt Added support for 12-bit and 16-bit LZC (UNIX "compress") compression format. 2002-09-28 00:56:08 +00:00
Compress.c Looks like "vim" is having some fun with me. 2002-09-28 01:02:03 +00:00
config.guess Updated these to the latest from ftp://ftp.gnu.org/pub/gnu/config/. 2002-09-21 00:34:30 +00:00
config.h.in Imported sources. 2000-05-23 01:55:31 +00:00
config.sub Updated these to the latest from ftp://ftp.gnu.org/pub/gnu/config/. 2002-09-21 00:34:30 +00:00
configure Fixed minor bugs when trying to open a file that doesn't actually contain 2002-09-23 20:32:26 +00:00
configure.in Reformatted files to use spaces instead of hard tabs. No substantitve changes. 2002-09-21 00:49:42 +00:00
COPYING-LIB Imported sources. 2000-05-23 01:55:31 +00:00
Crc16.c Added support for SQueeze compression format (both compress and expand). 2002-09-26 22:11:12 +00:00
Debug.c Reformatted files to use spaces instead of hard tabs. No substantitve changes. 2002-09-21 00:49:42 +00:00
Deferred.c Fixed "assert" vs "Assert", some naming convention lapses, and a 2002-09-28 00:57:36 +00:00
Entry.c Reformatted files to use spaces instead of hard tabs. No substantitve changes. 2002-09-21 00:49:42 +00:00
Expand.c Added support for 12-bit and 16-bit LZC (UNIX "compress") compression format. 2002-09-28 00:56:08 +00:00
FileIO.c Reformatted files to use spaces instead of hard tabs. No substantitve changes. 2002-09-21 00:49:42 +00:00
Funnel.c Fixed "assert" vs "Assert", some naming convention lapses, and a 2002-09-28 00:57:36 +00:00
INSTALL Imported sources. 2000-05-23 01:55:31 +00:00
install-sh Imported sources. 2000-05-23 01:55:31 +00:00
Lzc.c New file with LZC (UNIX compress) code. 2002-09-28 01:06:22 +00:00
Lzw.c Fixed "assert" vs "Assert", some naming convention lapses, and a 2002-09-28 00:57:36 +00:00
Makefile.in Added support for 12-bit and 16-bit LZC (UNIX "compress") compression format. 2002-09-28 00:56:08 +00:00
Makefile.msc Imported sources. 2000-05-23 01:55:31 +00:00
MiscStuff.c Fixed "assert" vs "Assert", some naming convention lapses, and a 2002-09-28 00:57:36 +00:00
MiscStuff.h Fixed minor bugs when trying to open a file that doesn't actually contain 2002-09-23 20:32:26 +00:00
MiscUtils.c Reformatted files to use spaces instead of hard tabs. No substantitve changes. 2002-09-21 00:49:42 +00:00
mkinstalldirs Imported sources. 2000-05-23 01:55:31 +00:00
NOTES.txt Reformatted files to use spaces instead of hard tabs. No substantitve changes. 2002-09-21 01:13:21 +00:00
NufxLib.h Added support for SQueeze compression format (both compress and expand). 2002-09-26 22:11:12 +00:00
NufxLibPriv.h Added support for 12-bit and 16-bit LZC (UNIX "compress") compression format. 2002-09-28 00:56:08 +00:00
README.txt Reformatted files to use spaces instead of hard tabs. No substantitve changes. 2002-09-21 00:59:25 +00:00
Record.c Fixed "assert" vs "Assert", some naming convention lapses, and a 2002-09-28 00:57:36 +00:00
SourceSink.c Reformatted files to use spaces instead of hard tabs. No substantitve changes. 2002-09-21 00:49:42 +00:00
Squeeze.c Looks like "vim" is having some fun with me. 2002-09-28 01:02:03 +00:00
SunOS4.h Reformatted files to use spaces instead of hard tabs. No substantitve changes. 2002-09-21 00:49:42 +00:00
SysDefs.h Reformatted files to use spaces instead of hard tabs. No substantitve changes. 2002-09-21 00:49:42 +00:00
Thread.c Reformatted files to use spaces instead of hard tabs. No substantitve changes. 2002-09-21 00:49:42 +00:00
Value.c Looks like "vim" is having some fun with me. 2002-09-28 01:02:03 +00:00
Version.c.in Added support for SQueeze compression format (both compress and expand). 2002-09-26 22:11:12 +00:00

NufxLib README, updated 2000/05/18
http://www.nulib.com/

See "COPYING-LIB" for distribution restrictions.


UNIX
====

Run the "configure" script.  Read through "INSTALL" if you haven't used
one of these before, especially if you want to use a specific compiler
or a particular set of compiler flags.

Run "make depend" if you have makedepend, and then type "make".  This will
build the library and all of the programs in the "samples" directory.
There are some useful programs in "samples", described in a README.txt
file there.  In particular, you should run samples/test-basic to verify
that things are more or less working.

If you want to install the library and header file into standard system
locations (usually /usr/local), run "make install".  To learn how to
specify different locations, read the INSTALL document.

There are some flags in "OPT" you may want to use.  The "autoconf" default
for @CFLAGS@ is "-g -O2".

-DNDEBUG
  Disable assert() calls and extra tests.  This will speed things up,
  but errors won't get caught until later on, making the root cause
  harder to locate.

-DDEBUG_MSGS
  Enable debug messages.  This increases the size of the executable,
  but shouldn't affect performance.  When errors occur, more output is
  produced.  The "debug dump" feature is enabled by this flag.

-DDEBUG_VERBOSE
  (Implicitly sets DEBUG_MSGS.)  Spray lots of debugging output.

If you want to do benchmarks, use "-O2 -DNDEBUG".  For pre-v1.0 sources,
setting -DNDEBUG is otherwise discouraged.  The recommended configuration
is "-g -O2 -DDEBUG_MSGS", so that verbose debug output is available when
errors occur.

The flags are stuffed into Version.c, so the application program can
examine and display the flags that were used to build the library.


BeOS
====

This works just like the UNIX version, but certain defaults have been
changed.  Running configure without arguments under BeOS is equivalent to:

    ./configure --prefix=/boot --includedir='${prefix}/develop/headers'
      --libdir='${exec_prefix}/home/config/lib' --mandir='/tmp'
      --bindir='${exec_prefix}/home/config/bin'

If you're using BeOS/PPC, it will also do:

    CC=cc CFLAGS='-proc 603 -opt full'


Win32
=====

If you're using an environment that supports "configure" scripts, such as
DJGPP, follow the UNIX instructions.

NufxLib has been tested with Microsoft Visual C++ 6.0.  To build NufxLib,
start up a DOS shell and run vcvars32.bat to set your environment.  Run:
    nmake -f makefile.msc
to build with debugging info, or
    nmake -f makefile.msc nodebug=1
to build optimized.

Once the library has been built, "cd samples" and run the same command there.
When it finishes, run "test-basic.exe".


Other Notes
===========

All of the source code is now formatted with spaces instead of tabs.

If you want to use the library in a multithreaded application, you should
define "USE_REENTRANT_CALLS" to tell it to use reentrant versions of
certain library calls.  This defines _REENTRANT, which causes Solaris to
add the appropriate goodies.  (Seems to me you'd always want this on, but
for some reason Solaris makes you take an extra step, so I'm not going to
define it by default.)