Sync usage with man page.
[netbsd-mini2440.git] / dist / ntp / ElectricFence / README
blob8223850fa46026cb621030bb01755090489b92ed
1 This is Electric Fence 2.0.5
3 Electric Fence is a different kind of malloc() debugger. It uses the virtual
4 memory hardware of your system to detect when software overruns the boundaries
5 of a malloc() buffer. It will also detect any accesses of memory that has
6 been released by free(). Because it uses the VM hardware for detection,
7 Electric Fence stops your program on the first instruction that causes
8 a bounds violation. It's then trivial to use a debugger to display the
9 offending statement.
11 This version will run on:
12         Linux kernel version 1.1.83 and above. Earlier kernels have problems
13         with the memory protection implementation.
15         All System V Revision 4 platforms (and possibly earlier revisions)
16         including:
17                 Every 386 System V I've heard of.
18                 Solaris 2.x
19                 SGI IRIX 5.0 (but not 4.x)
21         IBM AIX on the RS/6000.
23         SunOS 4.X (using an ANSI C compiler and probably static linking).
25         HP/UX 9.01, and possibly earlier versions.
27         OSF 1.3 (and possibly earlier versions) on a DECalpha.
29 On some of these platforms, you'll have to uncomment lines in the Makefile
30 that apply to your particular system.
32 If you test Electric Fence on a platform not mentioned here, please send me a
33 report.
35 It will probably port to any ANSI/POSIX system that provides mmap(), and
36 mprotect(), as long as mprotect() has the capability to turn off all access
37 to a memory page, and mmap() can use /dev/zero or the MAP_ANONYMOUS flag
38 to create virtual memory pages.
40 Complete information on the use of Electric Fence is in the manual page
41 libefence.3 .
43         Thanks
45         Bruce Perens
46         Bruce@Pixar.com