mirror of
https://github.com/fadden/nulib2.git
synced 2024-12-29 00:31:43 +00:00
d41016e6c1
Generalized compression method enable/disable. Now any method can be removed. Applications can call NuTestFeature() to figure out what is supported by the copy of NufxLib they're linked against.
113 lines
4.0 KiB
Plaintext
113 lines
4.0 KiB
Plaintext
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.
|
|
|
|
You can disable specific compression methods with "--disable-METHOD"
|
|
(run "sh ./configure --help" to see the possible options). By default,
|
|
all methods are enabled except bzip2.
|
|
|
|
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.)
|
|
|
|
|
|
Legalese
|
|
========
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
|
|
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
|
|
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
|
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
|
|
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
|
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|