Blame SOURCES/memstomp-man.patch

383a11
--- a/Makefile.am	2013-03-11 21:53:40.934186094 -0600
383a11
+++ b/Makefile.am	2013-03-11 21:57:44.795212526 -0600
383a11
@@ -34,6 +34,8 @@ lib_LTLIBRARIES = \
383a11
 bin_SCRIPTS = \
383a11
 	memstomp
383a11
 
383a11
+man1_MANS = memstomp.man
383a11
+
383a11
 CLEANFILES = \
383a11
 	memstomp
383a11
 
383a11
diff -Nrup a/memstomp.man b/memstomp.man
383a11
--- a/memstomp.man	1969-12-31 17:00:00.000000000 -0700
383a11
+++ b/memstomp.man	2013-05-10 17:53:37.767722170 -0600
383a11
@@ -0,0 +1,69 @@
383a11
+.\" This is a comment
383a11
+.\" Contact Owen@thelinuxblog.com
383a11
+.TH MEMSTOMP 1 "09 April 2013" "0.1.4"
383a11
+.SH NAME
383a11
+memstomp \- detect function calls with overlapping memory regions
383a11
+.SH SYNOPSIS
383a11
+.B  memstomp
383a11
+.RB [ \-dk ]
383a11
+.I  application
383a11
+.RI [ argument ...]
383a11
+.PP
383a11
+.B  memstomp
383a11
+.B  \-h
383a11
+.SH DESCRIPTION
383a11
+The
383a11
+.B memstomp
383a11
+utility identifies function calls that use overlapping memory regions in situations when such an overlap is not allowed by various standards. When a problem is detected, memstomp displays a backtrace to help you debug the problem, and if executed with the
383a11
+.B \-\-debug\-info
383a11
+command line option, it even uses the available debugging information. Since the backtrace code is not thread safe, memstomp also allows you to use the
383a11
+.B \-\-kill
383a11
+option to immediately terminate the analyzed program when an invalid function call is detected.
383a11
+.PP
383a11
+This version of memstomp inspects the following function calls:
383a11
+.BR memcpy (),
383a11
+.BR memccpy (),
383a11
+.BR mempcpy (),
383a11
+.BR strcpy (),
383a11
+.BR stpcpy (),
383a11
+.BR strncpy (),
383a11
+.BR stpncpy (),
383a11
+.BR strcat (),
383a11
+.BR strncat (),
383a11
+.BR wmemcpy (),
383a11
+.BR wmempcpy (),
383a11
+.BR wcscpy (),
383a11
+.BR wcsncpy (),
383a11
+.BR wcscat (),
383a11
+and
383a11
+.BR wcsncat ().
383a11
+.SH OPTIONS
383a11
+.TP
383a11
+.BR \-d ", " \-\-debug\-info
383a11
+Make use of debugging information to produce more detailed stack traces.
383a11
+.TP
383a11
+.BR \-k ", " \-\-kill
383a11
+Kill the analyzed application when a problem is detected.
383a11
+.TP
383a11
+.BR \-h ", " \-\-help
383a11
+Display usage information and exit.
383a11
+.SH SEE ALSO
383a11
+.BR memcpy (3),
383a11
+.BR memccpy (3),
383a11
+.BR mempcpy (3),
383a11
+.BR strcpy (3),
383a11
+.BR stpcpy (3),
383a11
+.BR strncpy (3),
383a11
+.BR stpncpy (3),
383a11
+.BR strcat (3),
383a11
+.BR strncat (3),
383a11
+.BR wmemcpy (3),
383a11
+.BR wmempcpy (3),
383a11
+.BR wcscpy (3),
383a11
+.BR wcsncpy (3),
383a11
+.BR wcscat (3),
383a11
+.BR wcsncat (3)
383a11
+.SH AUTHORS
383a11
+Lennart Poettering <lennart@poettering.net>
383a11
+.br
383a11
+William Cohen <wcohen@redhat.com>