home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 2 / crawlyvol2.bin / program / c / memdebug / readme < prev    next >
Encoding:
Text File  |  1994-03-08  |  3.6 KB  |  158 lines
  1. MEMDEBUG version 1.5
  2.  
  3. Author: Rene Schmit
  4. Email : rene.schmit@crpht.lu
  5.  
  6. ************************************************************************
  7.  
  8. Copyright (C) 1992-1994
  9. Centre de Recherche Public Henri Tudor
  10. 6, rue Coudenhove-Kalergi
  11. L1359 Luxembourg-Kirchberg
  12.  
  13. This software may be copied, distributed, ported and modified in source or
  14. object format as long as :
  15.  
  16. 1) No distribution for commercial purposes is made.
  17. 2) No third-party copyrights (such as runtime licenses) are involved
  18. 3) This copyright notice is not removed or changed.
  19.  
  20. No responsibility is assumed for any damages that may result
  21. from any defect in this software.
  22.  
  23. *************************************************************************
  24.  
  25.  
  26.                          Package Description:
  27.  
  28.  
  29. FEATURES:
  30. ---------
  31.   MEMDEBUG is a free utility for C programmers that provides,
  32. among others, the following features:
  33.  
  34. * Memory management error detection:
  35.         Memory leaks
  36.         free()'s of unallocated memory blocks
  37.         ...
  38.         
  39. * Memory usage error detection
  40.         Accesses to previously free()'ed memory
  41.         Off-by-one errors in memory blocks
  42.         ...
  43.  
  44. * Memory usage profiling
  45.         All kind of memory usage statistics
  46.         Trace of memory function calls
  47.         ...
  48.  
  49. * Error simulation
  50.         Low memory simulation
  51.         ...
  52.  
  53.  
  54. USAGE:
  55. ------
  56. Using MEMDEBUG is very simple:
  57.  
  58. Compile the package once.
  59.  
  60. Add the following line to each of your sources:
  61. #include "memdebug.h"
  62.  
  63. Recompile and link your program.
  64.  
  65. MEMDEBUG is activated by defining the MEMDEBUG
  66. pre-processor symbol at compilation time
  67.  
  68.  
  69. PLATFORMS:
  70. ----------
  71. MEMDEBUG is written in ANSI C and should be completely portable.
  72. It has been tested on the following platforms: ((?) == as far as I know)
  73.  
  74. MACINTOSH       MPW C
  75.                 GNU C
  76.                 Think/Symantec C
  77.  
  78. PC              Borland C
  79.                 Microsoft C 7
  80.  
  81. HP Workstations (both 680x0 and RISC stations)
  82.                 HP C
  83.                 GNU C
  84.  
  85. DEC             VAXC (feature subset, as VAXC not an ANSI compiler)
  86.                 GNU C (?)
  87.                 
  88. SUN Sparc        GNU C
  89.  
  90.  
  91. DISTRIBUTION:
  92. -------------
  93. The distribution kit contains all necessary sources and 
  94. documentation (PostScript file). NO object files are provided.
  95.  
  96. There is a simple test program. BEWARE: this program might crash
  97. on your machine, as it does some really nasty stuff. Use it primarily
  98. to check which features are supported on your machine! (comment out
  99. source until it doesn't crash any longer).
  100.  
  101. A sample makefile for UNIX users is included (provided by 
  102. Wilfred Mollenvanger and John Borst)
  103.  
  104. memalpha.c
  105. memalpha.h
  106. memdebug.c
  107. memdebug.h
  108. memfree.c
  109. memfree.h
  110. memtypes.i
  111. test.c
  112. README
  113. Quickstarter_Guide.txt
  114. Memdebug.ps
  115. makefile
  116.  
  117. MEMDEBUG is free! It is available by ftp on the following server:
  118.  
  119. +-------------------------------------------------+
  120. | ftp.crpht.lu in directory /pub/sources/memdebug |
  121. +-------------------------------------------------+
  122.  
  123. This server is brand new, so there might still be some
  124. problems, and the directory structure might change in the near
  125. future.
  126.  
  127. People in the US might also try:
  128.  
  129. ftp.netcom.com in directory /pub/gurgle/memdebug
  130.  
  131. Feel free to make MEMDEBUG available on other ftp sites!
  132.  
  133. Support:
  134. --------
  135.  
  136. There exist two mailing lists related to MEMDEBUG. For more
  137. information, send an email to
  138.  
  139. majordomo@dorado.crpht.lu
  140.  
  141. with the following body
  142.  
  143. help
  144. info memdebug
  145. info memdebug-announce
  146. end
  147.  
  148.  
  149. You may also contact me by email if you
  150.     * have any problems
  151.     * detect any bugs
  152.     * have suggestions for improvements
  153.     * ported MEMDEBUG to a platform or compiler not mentionned above
  154.     
  155. And above all, email me if you
  156.  
  157.     * like :-) (or dislike :-( ) MEMDEBUG
  158.