From d8521af7be8cafc64525755758d25f0b70072ea5 Mon Sep 17 00:00:00 2001 From: Michele Calgaro Date: Mon, 13 Jun 2022 13:47:50 +0900 Subject: Add man pages for TDE applications Signed-off-by: Michele Calgaro --- doc/man/kmtrace/CMakeLists.txt | 7 ++++ doc/man/kmtrace/demangle.1 | 57 +++++++++++++++++++++++++++++++++ doc/man/kmtrace/kminspector.1 | 50 +++++++++++++++++++++++++++++ doc/man/kmtrace/kmmatch.1 | 52 ++++++++++++++++++++++++++++++ doc/man/kmtrace/kmtrace.1 | 72 ++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 238 insertions(+) create mode 100644 doc/man/kmtrace/CMakeLists.txt create mode 100644 doc/man/kmtrace/demangle.1 create mode 100644 doc/man/kmtrace/kminspector.1 create mode 100644 doc/man/kmtrace/kmmatch.1 create mode 100644 doc/man/kmtrace/kmtrace.1 (limited to 'doc/man/kmtrace') diff --git a/doc/man/kmtrace/CMakeLists.txt b/doc/man/kmtrace/CMakeLists.txt new file mode 100644 index 00000000..24ccd704 --- /dev/null +++ b/doc/man/kmtrace/CMakeLists.txt @@ -0,0 +1,7 @@ +file( GLOB _man_files RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.1 ) + +INSTALL( + FILES ${_man_files} + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kmtrace/demangle.1 b/doc/man/kmtrace/demangle.1 new file mode 100644 index 00000000..8f4f3922 --- /dev/null +++ b/doc/man/kmtrace/demangle.1 @@ -0,0 +1,57 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH DEMANGLE 1 "February 25, 2003" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +demangle \- undo C++ name mangling for symbols +.SH SYNOPSIS +.B demangle +.SH DESCRIPTION +\fBDemangle\fP reads a list of C++ mangled symbol names from standard +input and converts these names to human-readable form on standard +output. +.PP +This utility is part of the TDE Software Development Kit. +.SH EXAMPLE +Create a file called \fInames\fP containing the following mangled symbol +names: +.PP +.RS +_ZNK6Object10metaObjectEv +.br +_ZN8QPtrListI5ArrowE5clearEv +.br +_ZTC4Kolf0_11TDEMainWindow +.RE +.PP +These names can then be demangled as follows: +.PP +.RS +\fIexample$\fP demangle < names +.br +Object::metaObject() const +.br +QPtrList::clear() +.br +construction vtable for TDEMainWindow-in-Kolf +.RE +.SH SEE ALSO +.BR kminspector (1), +.BR kmmatch (1), +.BR kmtrace (1). +.SH AUTHOR +This manual page was prepared by Ben Burton +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kmtrace/kminspector.1 b/doc/man/kmtrace/kminspector.1 new file mode 100644 index 00000000..29cb70e5 --- /dev/null +++ b/doc/man/kmtrace/kminspector.1 @@ -0,0 +1,50 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH KMINSPECTOR 1 "February 25, 2003" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +kminspector \- run a program with the TDE memory leak tracer +.SH SYNOPSIS +.B kminspector +\fIprogram\fP [ \fIprogram-args\fP ] +.SH DESCRIPTION +\fBKMinspector\fP runs the given program, examines its memory +allocation behaviour using \fIlibktrace\fP and pipes the resulting +allocation tree through \fIless\fP. +.PP +The given program does not need to be specially compiled. +.PP +This utility is provided with KMtrace, +a TDE tool to assist with malloc debugging using +glibc's "mtrace" functionality. Unfortunately the mtrace that is part of +current (9/9/2000) glibc versions only logs the return-address of the +malloc/free call. The library included with KMtrace +logs a complete backtrace upon malloc/free. +.PP +This utility is part of the TDE Software Development Kit. +.SH SEE ALSO +.BR demangle (1), +.BR kmmatch (1), +.BR kmtrace (1). +.PP +Much more extensive documentation for KMtrace can be found in +\fI/usr/share/doc/kmtrace/README\fP. +.SH AUTHOR +KMtrace was written by Waldo Bastian , +Mike Haertel and Andi Kleen . +.br +This manual page was prepared by Ben Burton +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kmtrace/kmmatch.1 b/doc/man/kmtrace/kmmatch.1 new file mode 100644 index 00000000..d80c1554 --- /dev/null +++ b/doc/man/kmtrace/kmmatch.1 @@ -0,0 +1,52 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH KMMATCH 1 "February 26, 2003" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +kmmatch \- search for symbols in a map file +.SH SYNOPSIS +.B kmmatch +.I map-file call-file +.SH DESCRIPTION +\fBKMMatch\fP determines which symbols from a given set (\fIcall-file\fP) are +present in a given map file. +.PP +The \fImap-file\fP should contain output from \fInm\fP (which extracts +information from object files). It must \fBnot\fP contain any blank +lines or header information (such as the name of the object file); this +means you may need to strip the first few lines of \fInm\fP output from +the \fImap-file\fP. +.PP +The \fIcall-file\fP should contain a list of symbols (such as function +calls made by a program), one per line. +.PP +This utility will find which of the symbols in \fIcall-file\fP are +present in \fImap-file\fP and write them to standard error, one per +line, in the order in which they appear in \fIcall-file\fP. +.PP +Note that this utility is called \fBmatch\fP in the original TDE +distribution; it has been renamed to \fBkmmatch\fP in Debian to +avoid conflicts with unrelated packages. +.PP +This utility is part of the TDE Software Development Kit. +.SH SEE ALSO +.BR demangle (1), +.BR kminspector (1), +.BR kmtrace (1), +.BR nm (1). +.SH AUTHOR +This manual page was prepared by Ben Burton +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kmtrace/kmtrace.1 b/doc/man/kmtrace/kmtrace.1 new file mode 100644 index 00000000..14f5f9fc --- /dev/null +++ b/doc/man/kmtrace/kmtrace.1 @@ -0,0 +1,72 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH KMTRACE 1 "February 25, 2003" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +kmtrace \- a TDE memory leak tracer +.SH SYNOPSIS +.B kmtrace +[ \fIgeneric-options\fP ] +[ \fB\-x, \-\-exclude\fP \fIfile\fP ] +[ \fB\-e, \-\-exe\fP \fIfile\fP ] +[ \fB\-t, \-\-tree\fP \fIfile\fP +[ \fB\-\-th, \-\-treethreshold\fP \fIvalue\fP ] +[ \fB\-\-td, \-\-treedepth\fP \fIvalue\fP ]] +[ \fItrace-log\fP ] +.SH DESCRIPTION +\fBKMtrace\fP is a TDE tool to assist with malloc debugging using +glibc's "mtrace" functionality. Unfortunately the mtrace that is part of +current (9/9/2000) glibc versions only logs the return-address of the +malloc/free call. The library included with KMtrace +logs a complete backtrace upon malloc/free. +.PP +KMtrace will investigate the trace log specified on the command line, +or \fIktrace.out\fP if no trace log is specified. +.PP +This utility is part of the TDE Software Development Kit. +.SH OPTIONS +Below are the kmtrace-specific options. +For a full summary of options, run \fIkmtrace \-\-help\fP. +.TP +\fB\-x, \-\-exclude\fP \fIfile\fP +File containing symbols to exclude from output. +.TP +\fB\-e, \-\-exe\fP \fIfile\fP +Executable to use for looking up unknown symbols. +.TP +\fB\-t, \-\-tree\fP \fIfile\fP +Write a tree of the allocations to the given file. +.TP +\fB\-\-th, \-\-treethreshold\fP \fIvalue\fP +When writing the allocations tree, hide subtrees allocating less than the +given memory amount. +.TP +\fB\-\-td, \-\-treedepth\fP \fIvalue\fP +When writing the allocations tree, hide subtrees that are deeper than the +specified depth. +.SH SEE ALSO +.BR demangle (1), +.BR kminspector (1), +.BR kmmatch (1). +.PP +Much more extensive documentation can be found in +\fI/usr/share/doc/kmtrace/README\fP. +.SH AUTHOR +KMtrace was written by Waldo Bastian , +Mike Haertel and Andi Kleen . +.br +This manual page was prepared by Ben Burton +for the Debian GNU/Linux system (but may be used by others). -- cgit v1.2.1