callgrind/docs/callgrind_annotate-manpage.xml

   1 <?xml version="1.0"?> <!-- -*- sgml -*- -->
   2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3           "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
   4 [ <!ENTITY % vg-entities SYSTEM "../../docs/xml/vg-entities.xml"> %vg-entities; ]>
   5
   6
   7 <refentry id="callgrind-annotate">
   8
   9 <refmeta>
  10   <refentrytitle>Callgrind Annotate</refentrytitle>
  11   <manvolnum>1</manvolnum>
  12   <refmiscinfo class="version">Release &rel-version;</refmiscinfo>
  13 </refmeta>
  14
  15 <refnamediv id="a-name">
  16   <refname>callgrind_annotate</refname>
  17   <refpurpose>post-processing tool for the Callgrind</refpurpose>
  18 </refnamediv>
  19
  20 <refsynopsisdiv id="a-synopsis">
  21   <cmdsynopsis>
  22     <command>callgrind_annotate</command>
  23     <arg choice="opt"><replaceable>options</replaceable></arg>
  24     <!-- note the deliberate <arg> nesting here -->
  25     <arg choice="opt"><replaceable>callgrind-out-file</replaceable>
  26     <arg choice="opt" rep="repeat"><replaceable>source-files</replaceable></arg></arg>
  27   </cmdsynopsis>
  28 </refsynopsisdiv>
  29
  30
  31 <refsect1 id="a-description">
  32 <title>Description</title>
  33
  34 <para><command>callgrind_annotate</command> takes an output file produced by
  35 the Valgrind tool Callgrind and prints the information in an easy-to-read form.
  36 </para>
  37
  38 </refsect1>
  39
  40
  41 <refsect1 id="a-options">
  42 <title>Options</title>
  43
  44 <xi:include href="cl-manual.xml" xpointer="callgrind_annotate.opts.list"
  45             xmlns:xi="http://www.w3.org/2001/XInclude" />
  46
  47 </refsect1>
  48
  49
  50 <refsect1 id="a-see_also">
  51 <title>See Also</title>
  52
  53 <para>
  54 valgrind(1),
  55 <filename>&vg-docs-path;</filename> or
  56 <filename>&vg-docs-url;</filename>.
  57 </para>
  58
  59
  60 </refsect1>
  61
  62
  63 <refsect1 id="a-author">
  64 <title>Author</title>
  65
  66 <para>Josef Weidendorfer &lt;&cl-email;&gt;.</para>
  67
  68 <para>This manual page was written by
  69 Philipp Frauenfelder &lt;pfrauenf@debian.org&gt;.</para>
  70 </refsect1>
  71
  72
  73 </refentry>