Add man pages for TDE applications

Signed-off-by: Michele Calgaro <michele.calgaro@yahoo.it>

7 files changed, 322 insertions, 0 deletions

diff --git a/doc/man/tdecachegrind/CMakeLists.txt b/doc/man/tdecachegrind/CMakeLists.txt
new file mode 100644
index 00000000..24ccd704
--- /dev/null
+++ b/doc/man/tdecachegrind/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/tdecachegrind/dprof2calltree.1 b/doc/man/tdecachegrind/dprof2calltree.1
new file mode 100644
index 00000000..88bcd0b0
--- /dev/null
+++ b/doc/man/tdecachegrind/dprof2calltree.1
@@ -0,0 +1,60 @@
+.\"                                      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 DPROF2CALLTREE 1 "October 15, 2004"
+.\" 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
+dprof2calltree \- convert perl's DProf profiling data to KCachegrind calltree format
+.SH SYNOPSIS
+.B dprof2calltree
+\fB\-f\fP \fIinput\fP
+[ \fB\-o\fP \fIoutput\fP ]
+.SH DESCRIPTION
+\fBdprof2calltree\fP reads the \fItmon.out\fP profiling data output by
+Perl's Devel::DProf profiling package, and converts it into calltree format
+for use by KCachegrind.
+.PP
+This utility is part of the TDE Software Development Kit.
+.SH OPTIONS
+.TP
+\fB\-f\fP \fIinput\fP
+Specifies the DProf \fItmon.out\fP file to convert.
+.TP
+\fB\-o\fP \fIoutput\fP
+Write the calltree output to the given file for use by KCachegrind.
+If omitted, the output will be written to file of the form
+\fIcachgrind.out.<input>\fP.
+.SH EXAMPLE
+If you run a perl script as:
+.PP
+.RS
+perl -d:DProf yourscript.pl
+.RE
+.PP
+then this will write profiling data to \fItmon.out\fP.  You can then
+work with this data in KCachegrind as follows:
+.PP
+.RS
+dprof2calltree -f tmin.out -o cachegrind.out.foo
+.br
+tdecachegrind cachegrind.out.foo
+.RE
+.SH SEE ALSO
+.BR tdecachegrind (1).
+.SH AUTHOR
+This converter was written by George Schlossnagle <george@omniti.com>.
+.br
+This manual page was prepared by Ben Burton <bab@debian.org>
+for the Debian GNU/Linux system (but may be used by others).
diff --git a/doc/man/tdecachegrind/hotshot2calltree.1 b/doc/man/tdecachegrind/hotshot2calltree.1
new file mode 100644
index 00000000..8c4d4441
--- /dev/null
+++ b/doc/man/tdecachegrind/hotshot2calltree.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 HOTSHOT2CALLTREE 1 "October 15, 2004"
+.\" 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
+hotshot2calltree \- convert hotshot profiling data to KCachegrind calltree format
+.SH SYNOPSIS
+.B hotshot2calltree
+[ \fB\-\-file\-limit\fP \fIlimit\fP ]
+\fB\-o\fP \fIoutput\fP \fIinput\fP [ \fIinput\fP ... ]
+.SH DESCRIPTION
+\fBhotshot2calltree\fP reads one or more pstat profiling data files
+as output by the hotshot python profiler, and converts them into
+calltree format for use by KCachegrind.
+.PP
+This utility is part of the TDE Software Development Kit.
+.SH OPTIONS
+.TP
+\fB\-o\fP \fIoutput\fP
+Write the calltree output into the given file for use by KCachegrind.
+This may be \fB\-\fP if you wish to write to standard output.
+.TP
+\fIinput\fP ...
+Read the hotshot profiling data from the given file(s).
+.TP
+\fB\-\-file\-limit\fP \fIlimit\fP
+Stop after the given number of input files.
+.SH EXAMPLE
+Suppose that you have used hotshot to profile a python app, with results
+dumped to the file \fIpythongrind.prof\fP.  You may then work with this
+data in KCachegrind as follows.
+.PP
+.RS
+hotshot2cachegrind \-o cachegrind.out.0 pythongrind.prof
+.br
+tdecachegrind cachegrind.out.0
+.RE
+.SH SEE ALSO
+.BR tdecachegrind (1).
+.SH AUTHOR
+This converter was written by Jorg Beyer <job@webde-ag.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).
diff --git a/doc/man/tdecachegrind/memprof2calltree.1 b/doc/man/tdecachegrind/memprof2calltree.1
new file mode 100644
index 00000000..d4f52ead
--- /dev/null
+++ b/doc/man/tdecachegrind/memprof2calltree.1
@@ -0,0 +1,36 @@
+.\"                                      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 MEMPROF2CALLTREE 1 "October 15, 2004"
+.\" 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
+memprof2calltree \- convert memprof profiling data to KCachegrind calltree format
+.SH SYNOPSIS
+.B memprof2calltree
+.SH DESCRIPTION
+\fBmemprof2calltree\fP reads the memory profiles of memprof and
+converts them into calltree format for use by KCachegrind.
+.PP
+The memprof data must be supplied on standard input, and the
+corresponding calltree data will be written to standard output.
+.PP
+This utility is part of the TDE Software Development Kit.
+.SH SEE ALSO
+.BR tdecachegrind (1).
+.SH AUTHOR
+This converter 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).
diff --git a/doc/man/tdecachegrind/op2calltree.1 b/doc/man/tdecachegrind/op2calltree.1
new file mode 100644
index 00000000..0242e6cd
--- /dev/null
+++ b/doc/man/tdecachegrind/op2calltree.1
@@ -0,0 +1,43 @@
+.\"                                      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 OP2CALLTREE 1 "October 15, 2004"
+.\" 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
+op2calltree \- convert OProfile profiling data to KCachegrind calltree format
+.SH SYNOPSIS
+.B op2calltree
+.SH DESCRIPTION
+\fBop2calltree\fP reads the profiling data output by OProfile v0.8 and
+converts it into calltree format for use by KCachegrind.
+.PP
+The OProfile data must be supplied on standard input, and should be
+obtained by running:
+.PP
+.RS
+opreport \-gdf
+.RE
+.PP
+This converter will then write a separate calltree data file for each
+application, to a file of the form \fIoprof.out.<app>\fP.
+.PP
+This utility is part of the TDE Software Development Kit.
+.SH SEE ALSO
+.BR tdecachegrind (1).
+.SH AUTHOR
+This converter 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).
diff --git a/doc/man/tdecachegrind/pprof2calltree.1 b/doc/man/tdecachegrind/pprof2calltree.1
new file mode 100644
index 00000000..b5cf9082
--- /dev/null
+++ b/doc/man/tdecachegrind/pprof2calltree.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 PPROF2CALLTREE 1 "October 15, 2004"
+.\" 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
+pprof2calltree \- convert APD profiling data to KCachegrind calltree format
+.SH SYNOPSIS
+.B pprof2calltree
+\fB\-f\fP \fIinput\fP
+.SH DESCRIPTION
+\fBpprof2calltree\fP reads the pprof profiling data output by
+APD (http://pecl.php.net/apd/), and converts it into calltree format
+for use by KCachegrind.
+.PP
+This utility is part of the TDE Software Development Kit.
+.SH OPTIONS
+.TP
+\fB\-f\fP \fIinput\fP
+Specifies the APD pprof trace file to convert.  This generally has a
+name of the form \fIpprof.XXXXX.Y\fP.  The calltree output for
+KCachegrind will then be written to the file \fIcachegrind.out.XXXXX.Y\fP.
+.SH EXAMPLE
+Suppose you profile a script with APD and obtain the pprof trace file
+\fIpprof.12345.1\fP.  You can then work with this data in KCachegrind as
+follows.
+.PP
+.RS
+pprof2calltree -f pprof.12345.1
+.br
+tdecachegrind cachegrind.out.12345.1
+.RE
+.PP
+.SH SEE ALSO
+.BR tdecachegrind (1).
+.SH AUTHOR
+This converter was written by George Schlossnagle <george@omniti.com>.
+.br
+This manual page was prepared by Ben Burton <bab@debian.org>
+for the Debian GNU/Linux system (but may be used by others).
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).