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