-------------------------------------------------------------------------------

Debug Malloc Library
********************

   Version 3.3.1 - January 1998

   The debug memory allocation or "dmalloc" library has been designed
as a drop in replacement for the system's `malloc', `realloc',
`calloc', `free' and other memory management routines while providing
powerful debugging facilities configurable at runtime.  These
facilities include such things as memory-leak tracking, fence-post write
detection, file/line number reporting, and general logging of
statistics.

   The library is reasonably portable having been run successfully on at
least the following operating systems: AIX, BSDI, DG/UX, FreeBSD, HPUX,
Irix, Linux, MS-DOG, NeXT, OSF, SCO, Solaris, SunOS, Ultrix, Unixware,
and even Unicos on a Cray Y-MP.

   The package includes the library, configuration scripts, debug
utility application, test program, and extensive documentation
(formats: text, texi, info, and ps).  Documentation is available online
at URL `http://www.letters.com/dmalloc/'.

   The library is available via ftp from `ftp.letters.com' in the
`/src/dmalloc' directory.  *Note How To Get::.  I can be reached via my
web page `http://www.letters.com/~gray/' with any questions or
feedback.  Please include the version number of the library that you are
using as well as your machine and operating system types.

   Gray Watson.

-------------------------------------------------------------------------------

How to get the library.
=======================

Standard Repository:
     The newest versions of the dmalloc library are available via
     anonymous ftp from `ftp.letters.com' in the `/src/dmalloc'
     directory.

     To use anonymous ftp, you ftp to the site and when the system
     prompts you for a login-id or username you enter `anonymous'.
     When it prompts you for a password you enter your email address.
     You then can change-directory (cd) into `/src/dmalloc' and get the
     `README' and `dmalloc.tar.gz' files.

     The versions in this repository include such stuff as a postscript
     version of the manual and other large files which may not have been
     included in the distribution you received.

Other Repositories:
     You can also get a recent version from anonymous ftp via
     `gatekeeper.dec.com' in the `/pub/misc/dmalloc' directory.  This
     repository has been made available through the generosity of the
     Digital Equipment Corporation with special help from Dave Hill and
     the gatekeepers.

     Thanks much to them all.


-------------------------------------------------------------------------------

See the INSTALL file for building, installation, and quick-start notes.

-------------------------------------------------------------------------------

DOCUMENTATION:

Examine the dmalloc.info file.  Is is a gnu-info file having the
user-documentation for the dmalloc subsystem.  It can be installed in
the emacs info directory and read with emacs/info or the info program
available from the texinfo package at GNU archive sites.  It is also
suitable for reading as text.

It can be reproduced from the dmalloc.texi texinfo file which also can
generate TeX hardcopy output with the help of the texinfo.tex file.
It is available online at URL: http://www.letters.com/~gray/dmalloc.

A dmalloc.ps postscript file may also have been included for you
TeX-less folks.  

-------------------------------------------------------------------------------

ARGV LIBRARY:

My argv library should have been included with this package
(argv.[ch], argv_loc.h).  I use it with all my binaries.  It functions
similar to the getopt routines in that it provides a standardized way
of processing arguments.  However, that is where the similarity ends.
You have to write no C code to do the actual processing, it handles
short -l and long --logfile style options, gives standard short and
long usage messages, and many other features while trying to comply
with POSIX specs.

For copies of the library, ftp to ftp.letters.com and look in the
/src/argv directory.

-------------------------------------------------------------------------------

THANKS:

Many net folk contributed to the library and my thanks goes out to
them all.

However, special thanks must go to my core contributors/testers: Scott
Michel, Greg Sylvain, Bali Jatinder, Marc Evans, Dave Hill, Manfred
Hauswirth, Richard Birnbaum, Francois Pinard, Irv Lustig, Marty
Leisner, and Rik Faith.

-------------------------------------------------------------------------------

AUTHOR:

If you have any questions, comments, or problems feel free to send me
mail.

gray.watson@letters.com

-------------------------------------------------------------------------------
$Id: README.1,v 1.51 1995/05/16 00:26:42 gray Exp $
-------------------------------------------------------------------------------
