Blame SOURCES/memstomp-man.patch
Branch: 1437a8a54965094ec53c85998cb052cabaf3f52f
1437a8
--- a/Makefile.am 2013-03-11 21:53:40.934186094 -0600
1437a8
+++ b/Makefile.am 2013-03-11 21:57:44.795212526 -0600
1437a8
@@ -34,6 +34,8 @@ lib_LTLIBRARIES = \
1437a8
bin_SCRIPTS = \
1437a8
memstomp
1437a8
1437a8
+man1_MANS = memstomp.man
1437a8
+
1437a8
CLEANFILES = \
1437a8
memstomp
1437a8
1437a8
diff -Nrup a/memstomp.man b/memstomp.man
1437a8
--- a/memstomp.man 1969-12-31 17:00:00.000000000 -0700
1437a8
+++ b/memstomp.man 2013-05-10 17:53:37.767722170 -0600
1437a8
@@ -0,0 +1,69 @@
1437a8
+.\" This is a comment
1437a8
+.\" Contact Owen@thelinuxblog.com
1437a8
+.TH MEMSTOMP 1 "09 April 2013" "0.1.4"
1437a8
+.SH NAME
1437a8
+memstomp \- detect function calls with overlapping memory regions
1437a8
+.SH SYNOPSIS
1437a8
+.B memstomp
1437a8
+.RB [ \-dk ]
1437a8
+.I application
1437a8
+.RI [ argument ...]
1437a8
+.PP
1437a8
+.B memstomp
1437a8
+.B \-h
1437a8
+.SH DESCRIPTION
1437a8
+The
1437a8
+.B memstomp
1437a8
+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
1437a8
+.B \-\-debug\-info
1437a8
+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
1437a8
+.B \-\-kill
1437a8
+option to immediately terminate the analyzed program when an invalid function call is detected.
1437a8
+.PP
1437a8
+This version of memstomp inspects the following function calls:
1437a8
+.BR memcpy (),
1437a8
+.BR memccpy (),
1437a8
+.BR mempcpy (),
1437a8
+.BR strcpy (),
1437a8
+.BR stpcpy (),
1437a8
+.BR strncpy (),
1437a8
+.BR stpncpy (),
1437a8
+.BR strcat (),
1437a8
+.BR strncat (),
1437a8
+.BR wmemcpy (),
1437a8
+.BR wmempcpy (),
1437a8
+.BR wcscpy (),
1437a8
+.BR wcsncpy (),
1437a8
+.BR wcscat (),
1437a8
+and
1437a8
+.BR wcsncat ().
1437a8
+.SH OPTIONS
1437a8
+.TP
1437a8
+.BR \-d ", " \-\-debug\-info
1437a8
+Make use of debugging information to produce more detailed stack traces.
1437a8
+.TP
1437a8
+.BR \-k ", " \-\-kill
1437a8
+Kill the analyzed application when a problem is detected.
1437a8
+.TP
1437a8
+.BR \-h ", " \-\-help
1437a8
+Display usage information and exit.
1437a8
+.SH SEE ALSO
1437a8
+.BR memcpy (3),
1437a8
+.BR memccpy (3),
1437a8
+.BR mempcpy (3),
1437a8
+.BR strcpy (3),
1437a8
+.BR stpcpy (3),
1437a8
+.BR strncpy (3),
1437a8
+.BR stpncpy (3),
1437a8
+.BR strcat (3),
1437a8
+.BR strncat (3),
1437a8
+.BR wmemcpy (3),
1437a8
+.BR wmempcpy (3),
1437a8
+.BR wcscpy (3),
1437a8
+.BR wcsncpy (3),
1437a8
+.BR wcscat (3),
1437a8
+.BR wcsncat (3)
1437a8
+.SH AUTHORS
1437a8
+Lennart Poettering <lennart@poettering.net>
1437a8
+.br
1437a8
+William Cohen <wcohen@redhat.com>