.\"                                      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 CALLGRIND_ANNOTATE 1 "Mai 13, 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 <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
callgrind_annotate \- produces human readable ASCII output from profile
information in
.B cachegrind.out
files
.SH SYNOPSIS
.B callgrind_annotate
.RI [ options ]
.RI [ source-files ]
.br
.SH DESCRIPTION
This manual page documents briefly the
.B callgrind_annotate
command.
This manual page was written for the Debian distribution
because the original program does not have a manual page.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
.\" respectively.
.SH OPTIONS
This program follows the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.
.TP
.B \-h, \-\-help
Show summary of options.
.TP
.B \-\-version
Show version of callgrind_annotate.
.TP
.B \-\-show=A,B,C
only show figures for events A,B,C [all]
.TP
.B \-\-sort=A,B,C
sort columns by events A,B,C [event column order]
.TP
.B \-\-threshold=<0--100>
percentage of counts (of primary sort event) we are interested in [99%]
.TP
.B \-\-auto=yes|no
annotate all source files containing functions that helped reach the
event count threshold [no]
.TP
.B \-\-context=N
print N lines of context before and after annotated lines [8]
.TP
.B \-\-cumulative=yes|no
add subroutine costs to functions calls [no]
.TP
.B \-\-tree=none|caller|calling|both
print for each function their callers, the called functions or both [none]
.TP
.B \-I, \-\-include=<dir>
add <dir> to list of directories to search for source files
.SH SEE ALSO
.BR /usr/share/doc/valgrind-callgrind/html/ct_main.html,
.br
.SH AUTHOR
This manual page was written by Philipp Frauenfelder <pfrauenf@debian.org>,
for the Debian GNU/Linux system (but may be used by others).