.\" 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 \- heap memory profiler for linux, command line utility
.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.