cachegrind/docs/cg_annotate-manpage.xml

   1 <?xml version="1.0"?> <!-- -*- sgml -*- -->
   2 <!DOCTYPE refentry 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="cg_annotate">
   8
   9 <refmeta>
  10   <refentrytitle>cg_annotate</refentrytitle>
  11   <manvolnum>1</manvolnum>
  12   <refmiscinfo>Release &rel-version;</refmiscinfo>
  13 </refmeta>
  14
  15 <refnamediv>
  16   <refname>cg_annotate</refname>
  17   <refpurpose>post-processing tool for Cachegrind</refpurpose>
  18 </refnamediv>
  19
  20 <refsynopsisdiv>
  21 <cmdsynopsis>
  22   <command>cg_annotate</command>
  23   <arg><replaceable>options</replaceable></arg>
  24   <arg choice="plain"><replaceable>cachegrind-out-file</replaceable></arg>
  25   <arg choice="opt" rep="repeat"><replaceable>source-files</replaceable></arg>
  26 </cmdsynopsis>
  27 </refsynopsisdiv>
  28
  29
  30 <refsect1 id="description">
  31 <title>Description</title>
  32
  33 <para><command>cg_annotate</command> takes an output file produced by the
  34 Valgrind tool Cachegrind and prints the information in an easy-to-read form.
  35 </para>
  36
  37 </refsect1>
  38
  39
  40
  41 <refsect1 id="options">
  42 <title>Options</title>
  43
  44 <xi:include href="cg-manual.xml" xpointer="cg_annotate.opts.list"
  45             xmlns:xi="http://www.w3.org/2001/XInclude" />
  46
  47 </refsect1>
  48
  49
  50
  51
  52 <refsect1 id="see_also">
  53 <title>See Also</title>
  54
  55 <para>
  56 valgrind(1),
  57 <filename>&vg-docs-path;</filename> or
  58 <filename>&vg-docs-url;</filename>.
  59 </para>
  60
  61 </refsect1>
  62
  63
  64 <refsect1 id="author">
  65 <title>Author</title>
  66
  67 <para>Nicholas Nethercote.</para>
  68
  69 </refsect1>
  70
  71
  72 </refentry>
  73
  74