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