1<?xml version="1.0"?> <!-- -*- sgml -*- --> 2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" 4[ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]> 5 6 7<refentry id="valgrind"> 8 9<refmeta> 10 <refentrytitle>VALGRIND</refentrytitle> 11 <manvolnum>1</manvolnum> 12 <refmiscinfo>Release &rel-version;</refmiscinfo> 13</refmeta> 14 15<refnamediv> 16 <refname>valgrind</refname> 17 <refpurpose>a suite of tools for debugging and profiling programs</refpurpose> 18</refnamediv> 19 20<refsynopsisdiv> 21<cmdsynopsis> 22 <command>valgrind</command> 23 <arg><replaceable>valgrind-options</replaceable></arg> 24 <arg><command>your-program</command></arg> 25 <arg><replaceable>your-program-options</replaceable></arg> 26</cmdsynopsis> 27</refsynopsisdiv> 28 29 30<refsect1 id="description"> 31<title>Description</title> 32 33<para><command>Valgrind</command> is a flexible program for debugging 34and profiling Linux executables. It consists of a core, which provides 35a synthetic CPU in software, and a series of debugging and profiling tools. 36The architecture is modular, so that new tools can be created easily and 37without disturbing the existing structure.</para> 38 39<para>Some of the options described below work with all Valgrind tools, and 40some only work with a few or one. The section MEMCHECK OPTIONS and those 41below it describe tool-specific options.</para> 42 43<para>This manual page covers only basic usage and options. For more 44comprehensive information, please see the HTML documentation on your 45system: <filename>&vg-docs-path;</filename>, or online: 46<filename>&vg-docs-url;</filename>.</para> 47 48</refsect1> 49 50 51 52<refsect1 id="tool-selection-options"> 53<title>Tool Selection Options</title> 54 55<xi:include href="manual-core.xml" xpointer="tool.opts.para" 56 xmlns:xi="http://www.w3.org/2001/XInclude" /> 57 58<xi:include href="manual-core.xml" xpointer="tool.opts.list" 59 xmlns:xi="http://www.w3.org/2001/XInclude" /> 60 61</refsect1> 62 63 64 65<refsect1 id="basic-options"> 66<title>Basic Options</title> 67 68<xi:include href="manual-core.xml" xpointer="basic.opts.para" 69 xmlns:xi="http://www.w3.org/2001/XInclude" /> 70 71<xi:include href="manual-core.xml" xpointer="basic.opts.list" 72 xmlns:xi="http://www.w3.org/2001/XInclude" /> 73 74</refsect1> 75 76 77 78<refsect1 id="error-related-options"> 79<title>Error-Related Options</title> 80 81<xi:include href="manual-core.xml" xpointer="error-related.opts.para" 82 xmlns:xi="http://www.w3.org/2001/XInclude" /> 83 84<xi:include href="manual-core.xml" xpointer="error-related.opts.list" 85 xmlns:xi="http://www.w3.org/2001/XInclude" /> 86 87</refsect1> 88 89 90 91<refsect1 id="malloc-related-options"> 92<title>malloc()-related Options</title> 93 94<xi:include href="manual-core.xml" xpointer="malloc-related.opts.para" 95 xmlns:xi="http://www.w3.org/2001/XInclude" /> 96 97<xi:include href="manual-core.xml" xpointer="malloc-related.opts.list" 98 xmlns:xi="http://www.w3.org/2001/XInclude" /> 99 100</refsect1> 101 102 103 104<refsect1 id="uncommon-options"> 105<title>Uncommon Options</title> 106 107 108<xi:include href="manual-core.xml" xpointer="uncommon.opts.para" 109 xmlns:xi="http://www.w3.org/2001/XInclude" /> 110 111<xi:include href="manual-core.xml" xpointer="uncommon.opts.list" 112 xmlns:xi="http://www.w3.org/2001/XInclude" /> 113 114</refsect1> 115 116 117 118<refsect1 id="debugging-valgrind-options"> 119<title>Debugging Valgrind Options</title> 120 121<xi:include href="manual-core.xml" xpointer="debug.opts.para" 122 xmlns:xi="http://www.w3.org/2001/XInclude" /> 123 124</refsect1> 125 126 127 128<refsect1 id="memcheck-options"> 129<title>Memcheck Options</title> 130 131<xi:include href="../../memcheck/docs/mc-manual.xml" 132 xpointer="mc.opts.list" 133 xmlns:xi="http://www.w3.org/2001/XInclude" /> 134 135</refsect1> 136 137 138 139<refsect1 id="cachegrind-options"> 140<title>Cachegrind Options</title> 141 142<xi:include href="../../cachegrind/docs/cg-manual.xml" 143 xpointer="cg.opts.list" 144 xmlns:xi="http://www.w3.org/2001/XInclude" /> 145 146</refsect1> 147 148 149 150<refsect1 id="callgrind-options"> 151<title>Callgrind Options</title> 152 153<xi:include href="../../callgrind/docs/cl-manual.xml" 154 xpointer="cl.opts.list.creation" 155 xmlns:xi="http://www.w3.org/2001/XInclude" /> 156<xi:include href="../../callgrind/docs/cl-manual.xml" 157 xpointer="cl.opts.list.activity" 158 xmlns:xi="http://www.w3.org/2001/XInclude" /> 159<xi:include href="../../callgrind/docs/cl-manual.xml" 160 xpointer="cl.opts.list.collection" 161 xmlns:xi="http://www.w3.org/2001/XInclude" /> 162<xi:include href="../../callgrind/docs/cl-manual.xml" 163 xpointer="cl.opts.list.simulation" 164 xmlns:xi="http://www.w3.org/2001/XInclude" /> 165</refsect1> 166 167 168 169<refsect1 id="helgrind-options"> 170<title>Helgrind Options</title> 171 172<xi:include href="../../helgrind/docs/hg-manual.xml" 173 xpointer="hg.opts.list" 174 xmlns:xi="http://www.w3.org/2001/XInclude" /> 175 176</refsect1> 177 178 179 180<refsect1 id="drd-options"> 181<title>DRD Options</title> 182 183<xi:include href="../../drd/docs/drd-manual.xml" 184 xpointer="drd.opts.list" 185 xmlns:xi="http://www.w3.org/2001/XInclude" /> 186<xi:include href="../../drd/docs/drd-manual.xml" 187 xpointer="drd.debugopts.list" 188 xmlns:xi="http://www.w3.org/2001/XInclude" /> 189 190</refsect1> 191 192 193 194<refsect1 id="massif-options"> 195<title>Massif Options</title> 196 197<xi:include href="../../massif/docs/ms-manual.xml" 198 xpointer="ms.opts.list" 199 xmlns:xi="http://www.w3.org/2001/XInclude" /> 200 201</refsect1> 202 203 204 205<refsect1 id="sgcheck-options"> 206<title>SGcheck Options</title> 207 208<xi:include href="../../exp-sgcheck/docs/sg-manual.xml" 209 xpointer="sg.opts.list" 210 xmlns:xi="http://www.w3.org/2001/XInclude" /> 211 212</refsect1> 213 214<refsect1 id="bbv-options"> 215<title>BBV Options</title> 216 217<xi:include href="../../exp-bbv/docs/bbv-manual.xml" 218 xpointer="bbv.opts.list" 219 xmlns:xi="http://www.w3.org/2001/XInclude" /> 220 221</refsect1> 222 223 224<refsect1 id="lackey-options"> 225<title>Lackey Options</title> 226 227<xi:include href="../../lackey/docs/lk-manual.xml" 228 xpointer="lk.opts.list" 229 xmlns:xi="http://www.w3.org/2001/XInclude" /> 230 231</refsect1> 232 233 234<refsect1 id="see_also"> 235<title>See Also</title> 236 237<para> 238cg_annotate(1), 239callgrind_annotate(1), 240callgrind_control(1), 241ms_print(1), 242<filename>&vg-docs-path;</filename> or 243<filename>&vg-docs-url;</filename>, 244<ulink id="&vg-gdbserver-id;" 245 xreflabel="&vg-gdbserver-label;" 246 url="&vg-gdbserver-url;">&vg-gdbserver-label;</ulink> 247<ulink id="&vg-vgdb-id;" 248 xreflabel="&vg-vgdb-label;" 249 url="&vg-vgdb-url;">&vg-vgdb-label;</ulink>, 250<ulink id="&vg-monitor-id;" 251 xreflabel="&vg-monitor-label;" 252 url="&vg-monitor-url;">&vg-monitor-label;</ulink>, 253<ulink id="&vg-comment-id;" 254 xreflabel="&vg-comment-label;" 255 url="&vg-comment-url;">&vg-comment-label;</ulink>, 256<ulink id="&vg-pthreads-perf-sched-id;" 257 xreflabel="&vg-pthreads-perf-sched-label;" 258 url="&vg-pthreads-perf-sched-url;">&vg-pthreads-perf-sched-label;</ulink>, 259<ulink id="&vg-cg-manual-id;" 260 xreflabel="&vg-cg-manual-label;" 261 url="&vg-cg-manual-url;">&vg-cg-manual-label;</ulink>. 262</para> 263 264</refsect1> 265 266 267<refsect1 id="author"> 268<title>Author</title> 269 270<para>The Valgrind developers.</para> 271 272<para>This manpage was written by Andres Roldan <aroldan@debian.org> 273and the Valgrind developers.</para> 274 275</refsect1> 276 277 278</refentry> 279 280