[heaptrack] 04/07: Fix manpage install.

[Anton Gladky]

This is an automated email from the git hooks/post-receive script.

gladk pushed a commit to branch master
in repository heaptrack.

commit eb94d16b6509adb236a7161c2d6c8ae65ff2c51e
Author: Anton Gladky <gladk at debian.org>
Date:   Mon Mar 27 22:44:43 2017 +0200

    Fix manpage install.
---
 debian/heaptrack-gui.manpages |  1 +
 debian/heaptrack.manpages     |  2 +
 debian/mans/heaptrack.1       | 58 +++++++++++++++++++++++++
 debian/mans/heaptrack_gui.1   | 45 ++++++++++++++++++++
 debian/mans/heaptrack_print.1 | 99 +++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 205 insertions(+)

diff --git a/debian/heaptrack-gui.manpages b/debian/heaptrack-gui.manpages
new file mode 100644
index 0000000..ea96076
--- /dev/null
+++ b/debian/heaptrack-gui.manpages
@@ -0,0 +1 @@
+debian/mans/heaptrack_gui.1
diff --git a/debian/heaptrack.manpages b/debian/heaptrack.manpages
new file mode 100644
index 0000000..466e811
--- /dev/null
+++ b/debian/heaptrack.manpages
@@ -0,0 +1,2 @@
+debian/mans/heaptrack.1
+debian/mans/heaptrack_print.1
diff --git a/debian/mans/heaptrack.1 b/debian/mans/heaptrack.1
new file mode 100644
index 0000000..30bba53
--- /dev/null
+++ b/debian/mans/heaptrack.1
@@ -0,0 +1,58 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
+.TH HEAPTRACK "1" "March 2017" "heaptrack 1.0.0" "User Commands"
+.SH NAME
+heaptrack \- manual page for heaptrack 1.0.0
+.SH SYNOPSIS
+.B heaptrack
+[\fI\,--debug|-d\/\fR] \fI\,DEBUGGEE \/\fR[\fI\,ARGUMENT\/\fR]...
+.br
+.B heaptrack
+[\fI\,--debug|-d\/\fR] \fI\,-p PID\/\fR
+.SH DESCRIPTION
+A heap memory usage profiler. It uses LD_PRELOAD to track all
+calls to the core memory allocation functions and logs these
+occurrances. Additionally, backtraces are obtained and logged.
+Combined this can give interesting answers to questions such as:
+.IP
+* How much heap memory is my application using?
+* Where is heap memory being allocated, and how often?
+* How much space are heap individual allocations requesting?
+.PP
+To evaluate the generated heaptrack data, use heaptrack_print or heaptrack_gui.
+.SS "Mandatory arguments to heaptrack:"
+.TP
+DEBUGGEE
+The name or path to the application that should
+be run with heaptrack analyzation enabled.
+.SS "Alternatively, to attach to a running process:"
+.TP
+\fB\-p\fR, \fB\-\-pid\fR PID
+The process ID of a running process into which
+heaptrack will be injected. This only works with
+applications that already link against libdl.
+.SS "Optional arguments to heaptrack:"
+.TP
+\fB\-d\fR, \fB\-\-debug\fR
+Run the debuggee in GDB and heaptrack.
+.TP
+ARGUMENT
+Any number of arguments that will be passed verbatim
+to the debuggee.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Show this help message and exit.
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+Displays version information.
+.SH "SEE ALSO"
+The full documentation for
+.B heaptrack
+is maintained as a Texinfo manual.  If the
+.B info
+and
+.B heaptrack
+programs are properly installed at your site, the command
+.IP
+.B info heaptrack
+.PP
+should give you access to the complete manual.
diff --git a/debian/mans/heaptrack_gui.1 b/debian/mans/heaptrack_gui.1
new file mode 100644
index 0000000..a124bd7
--- /dev/null
+++ b/debian/mans/heaptrack_gui.1
@@ -0,0 +1,45 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
+.TH HEAPTRACK_GUI "1" "March 2017" "heaptrack_gui 0.1" "User Commands"
+.SH NAME
+heaptrack_gui \- manual page for heaptrack_gui 0.1
+.SH SYNOPSIS
+.B heaptrack_gui
+[\fI\,options\/\fR] [\fI\,FILE\/\fR...]
+.SH DESCRIPTION
+A visualizer for heaptrack data files.
+.SH OPTIONS
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+Displays version information.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Displays this help.
+.TP
+\fB\-\-author\fR
+Show author information.
+.TP
+\fB\-\-license\fR
+Show license information.
+.TP
+\fB\-\-desktopfile\fR <file name>
+The base file name of the desktop entry for this
+application.
+.TP
+\fB\-d\fR, \fB\-\-diff\fR <<file>>
+Base profile data to compare other files to.
+.SS "Arguments:"
+.TP
+files
+Files to load
+.SH "SEE ALSO"
+The full documentation for
+.B heaptrack_gui
+is maintained as a Texinfo manual.  If the
+.B info
+and
+.B heaptrack_gui
+programs are properly installed at your site, the command
+.IP
+.B info heaptrack_gui
+.PP
+should give you access to the complete manual.
diff --git a/debian/mans/heaptrack_print.1 b/debian/mans/heaptrack_print.1
new file mode 100644
index 0000000..a85c786
--- /dev/null
+++ b/debian/mans/heaptrack_print.1
@@ -0,0 +1,99 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
+.TH HEAPTRACK_PRINT "1" "March 2017" "heaptrack_print 1.0.0" "User Commands"
+.SH NAME
+heaptrack_print \- manual page for heaptrack_print 1.0.0
+.SH DESCRIPTION
+heaptrack_print \- analyze heaptrack data files.
+.PP
+heaptrack is a heap memory profiler which records information
+about calls to heap allocation functions such as malloc, operator new etc. pp.
+This print utility can then be used to analyze the generated data files.
+.SH OPTIONS
+.TP
+\fB\-f\fR [ \fB\-\-file\fR ] arg
+The heaptrack data file to print.
+.TP
+\fB\-d\fR [ \fB\-\-diff\fR ] arg
+Find the differences to this file.
+.TP
+\fB\-t\fR [ \fB\-\-shorten\-templates\fR ] [=arg(=1)] (=1)
+Shorten template identifiers.
+.TP
+\fB\-m\fR [ \fB\-\-merge\-backtraces\fR ] [=arg(=1)] (=1)
+Merge backtraces.
+NOTE: the merged peak consumption is not correct.
+.TP
+\fB\-p\fR [ \fB\-\-print\-peaks\fR ] [=arg(=1)] (=1)
+Print backtraces to top allocators, sorted by peak consumption.
+.TP
+\fB\-a\fR [ \fB\-\-print\-allocators\fR ] [=arg(=1)] (=1)
+Print backtraces to top allocators, sorted by number of calls to
+allocation functions.
+.TP
+\fB\-T\fR [ \fB\-\-print\-temporary\fR ] [=arg(=1)] (=1)
+Print backtraces to top allocators, sorted by number of temporary
+allocations.
+.TP
+\fB\-l\fR [ \fB\-\-print\-leaks\fR ] [=arg(=1)] (=0)
+Print backtraces to leaked memory allocations.
+.HP
+\fB\-o\fR [ \fB\-\-print\-overall\-allocated\fR ] [=arg(=1)] (=0) Print top overall allocators, ignoring memory frees.
+.TP
+\fB\-n\fR [ \fB\-\-peak\-limit\fR ] [=arg(=10)] (=10)
+Limit the number of reported peaks.
+.TP
+\fB\-s\fR [ \fB\-\-sub\-peak\-limit\fR ] [=arg(=5)] (=5)
+Limit the number of reported backtraces of merged peak locations.
+.TP
+\fB\-H\fR [ \fB\-\-print\-histogram\fR ] arg
+Path to output file where an allocation size histogram will be
+written to.
+.TP
+\fB\-F\fR [ \fB\-\-print\-flamegraph\fR ] arg
+Path to output file where a flame\-graph compatible stack file will
+be written to.
+To visualize the resulting file, use flamegraph.pl from
+https://github.com/brendangregg/FlameGraph:
+.TP
+heaptrack_print heaptrack.someapp.PID.gz \fB\-F\fR stacks.txt
+# optionally pass \fB\-\-reverse\fR to flamegraph.pl
+flamegraph.pl \fB\-\-title\fR "heaptrack: allocations" \fB\-\-colors\fR mem \e
+.TP
+\fB\-\-countname\fR allocations < stacks.txt > heaptrack.someapp.PID.svg
+[firefox|chromium] heaptrack.someapp.PID.svg
+.TP
+\fB\-M\fR [ \fB\-\-print\-massif\fR ] arg
+Path to output file where a massif compatible data file will be
+written to.
+.TP
+\fB\-\-massif\-threshold\fR arg (=1)
+Percentage of current memory usage, below which allocations are
+aggregated into a 'below threshold' entry.
+This is only used in the massif output file so far.
+.TP
+\fB\-\-massif\-detailed\-freq\fR arg (=2)
+Frequency of detailed snapshots in the massif output file. Increase
+this to reduce the file size.
+You can set the value to zero to disable detailed snapshots.
+.TP
+\fB\-\-filter\-bt\-function\fR arg
+Only print allocations where the backtrace contains the given
+function.
+.TP
+\fB\-h\fR [ \fB\-\-help\fR ]
+Show this help message.
+.TP
+\fB\-v\fR [ \fB\-\-version\fR ]
+Displays version information.
+.SH "SEE ALSO"
+The full documentation for
+.B heaptrack_print
+is maintained as a Texinfo manual.  If the
+.B info
+and
+.B heaptrack_print
+programs are properly installed at your site, the command
+.IP
+.B info heaptrack_print
+.PP
+should give you access to the complete manual.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/heaptrack.git