summaryrefslogtreecommitdiffstats
path: root/doc/man/tdecachegrind/tdecachegrind.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/tdecachegrind/tdecachegrind.1')
-rw-r--r--doc/man/tdecachegrind/tdecachegrind.167
1 files changed, 67 insertions, 0 deletions
diff --git a/doc/man/tdecachegrind/tdecachegrind.1 b/doc/man/tdecachegrind/tdecachegrind.1
new file mode 100644
index 00000000..d5f3ea06
--- /dev/null
+++ b/doc/man/tdecachegrind/tdecachegrind.1
@@ -0,0 +1,67 @@
+.\" 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 TDECACHEGRIND 1 "March 25, 2005"
+.\" 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 <n> insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+tdecachegrind \- a visualisation tool for valgrind profiling output
+.SH SYNOPSIS
+.B tdecachegrind
+.RI "[ " generic-options " ]"
+[ \fB\-r\fP \fIexec\fP ] [ \fItrace-file\fP ]
+.SH DESCRIPTION
+\fBKCachegrind\fP is a visualisation tool for the profiling data generated
+by \fBcalltree\fP, a profiling skin for \fBvalgrind\fP. Applications can be
+profiled using calltree without being recompiled, and shared libraries
+and plugin architectures are supported.
+.PP
+For visualising the output from other profiling tools, several converters
+are available. On Debian systems these can be found in the
+\fItdecachegrind-converters\fP package.
+.PP
+This application is part of the TDE Software Development Kit.
+.SH OPTIONS
+Below are the tdecachegrind-specific options.
+For a full summary of options, run \fItdecachegrind \-\-help\fP.
+.TP
+\fB\-r\fP \fIexec\fP
+Run the program \fIexec\fP under cachegrind.
+.TP
+\fItrace-file\fP
+Visualise data from the given trace.
+.SH SEE ALSO
+.BR calltree (1),
+.BR dprof2calltree (1),
+.BR hotshot2calltree (1),
+.BR memprof2calltree (1),
+.BR op2calltree (1),
+.BR pprof2calltree (1),
+.BR valgrind (1).
+.PP
+Full user documentation is available through the TDE Help Centre.
+You can also enter the URL
+\fIhelp:/tdecachegrind/\fP
+directly into konqueror or you can run
+`\fIkhelpcenter help:/tdecachegrind/\fP'
+from the command-line.
+.PP
+If the TDE Help Centre is not installed then you can install the package
+\fItdesdk-doc-html\fP and read this documentation in HTML format from
+\fI/usr/share/doc/tde/HTML/en/tdecachegrind/\fP.
+.SH AUTHOR
+KCachegrind was written by Josef Weidendorfer <Josef.Weidendorfer@gmx.de>.
+.br
+This manual page was prepared by Ben Burton <bab@debian.org>
+for the Debian GNU/Linux system (but may be used by others).