valgrind-manpage.xml revision 9bea4c13fca0e3bb4b719dcb3ed63d47d479294e 
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="basic-options">
53<title>Basic Options</title>
54
55<xi:include href="manual-core.xml" xpointer="basic.opts.para"
56            xmlns:xi="http://www.w3.org/2001/XInclude" />
57
58<xi:include href="manual-core.xml" xpointer="basic.opts.list"
59            xmlns:xi="http://www.w3.org/2001/XInclude" />
60
61</refsect1>
62
63
64
65<refsect1 id="error-related-options">
66<title>Error-Related Options</title>
67
68<xi:include href="manual-core.xml" xpointer="error-related.opts.para"
69            xmlns:xi="http://www.w3.org/2001/XInclude" />
70
71<xi:include href="manual-core.xml" xpointer="error-related.opts.list"
72            xmlns:xi="http://www.w3.org/2001/XInclude" />
73
74</refsect1>
75
76
77
78<refsect1 id="malloc-related-options">
79<title>malloc()-related Options</title>
80
81<xi:include href="manual-core.xml" xpointer="malloc-related.opts.para"
82            xmlns:xi="http://www.w3.org/2001/XInclude" />
83
84<xi:include href="manual-core.xml" xpointer="malloc-related.opts.list"
85            xmlns:xi="http://www.w3.org/2001/XInclude" />
86
87</refsect1>
88
89
90
91<refsect1 id="uncommon-options">
92<title>Uncommon Options</title>
93
94
95<xi:include href="manual-core.xml" xpointer="uncommon.opts.para"
96            xmlns:xi="http://www.w3.org/2001/XInclude" />
97
98<xi:include href="manual-core.xml" xpointer="uncommon.opts.list"
99            xmlns:xi="http://www.w3.org/2001/XInclude" />
100
101</refsect1>
102
103
104
105<refsect1 id="debugging-valgrind-options">
106<title>Debugging Valgrind Options</title>
107
108<xi:include href="manual-core.xml" xpointer="debug.opts.para"
109            xmlns:xi="http://www.w3.org/2001/XInclude" />
110
111</refsect1>
112
113
114
115<refsect1 id="memcheck-options">
116<title>Memcheck Options</title>
117
118<xi:include href="/memcheck/docs/mc-manual.xml" 
119            xpointer="mc.opts.list"
120            xmlns:xi="http://www.w3.org/2001/XInclude" />
121
122</refsect1>
123
124
125
126<refsect1 id="cachegrind-options">
127<title>Cachegrind Options</title>
128
129<xi:include href="/cachegrind/docs/cg-manual.xml" 
130            xpointer="cg.opts.list"
131            xmlns:xi="http://www.w3.org/2001/XInclude" />
132
133</refsect1>
134
135
136
137<refsect1 id="callgrind-options">
138<title>Callgrind Options</title>
139
140<xi:include href="/callgrind/docs/cl-manual.xml" 
141            xpointer="cl.opts.list.creation"
142            xmlns:xi="http://www.w3.org/2001/XInclude" />
143<xi:include href="/callgrind/docs/cl-manual.xml" 
144            xpointer="cl.opts.list.activity"
145            xmlns:xi="http://www.w3.org/2001/XInclude" />
146<xi:include href="/callgrind/docs/cl-manual.xml" 
147            xpointer="cl.opts.list.collection"
148            xmlns:xi="http://www.w3.org/2001/XInclude" />
149<xi:include href="/callgrind/docs/cl-manual.xml" 
150            xpointer="cl.opts.list.simulation"
151            xmlns:xi="http://www.w3.org/2001/XInclude" />
152</refsect1>
153
154
155
156<refsect1 id="helgrind-options">
157<title>Helgrind Options</title>
158
159<xi:include href="/helgrind/docs/hg-manual.xml" 
160            xpointer="hg.opts.list"
161            xmlns:xi="http://www.w3.org/2001/XInclude" />
162
163</refsect1>
164
165
166
167<refsect1 id="drd-options">
168<title>DRD Options</title>
169
170<xi:include href="/drd/docs/drd-manual.xml" 
171            xpointer="drd.opts.list"
172            xmlns:xi="http://www.w3.org/2001/XInclude" />
173<xi:include href="/drd/docs/drd-manual.xml" 
174            xpointer="drd.debugopts.list"
175            xmlns:xi="http://www.w3.org/2001/XInclude" />
176
177</refsect1>
178
179
180
181<refsect1 id="massif-options">
182<title>Massif Options</title>
183
184<xi:include href="/massif/docs/ms-manual.xml" 
185            xpointer="ms.opts.list"
186            xmlns:xi="http://www.w3.org/2001/XInclude" />
187
188</refsect1>
189
190
191
192<refsect1 id="ptrcheck-options">
193<title>Ptrcheck Options</title>
194
195<xi:include href="/exp-ptrcheck/docs/pc-manual.xml" 
196            xpointer="pc.opts.list"
197            xmlns:xi="http://www.w3.org/2001/XInclude" />
198
199</refsect1>
200
201<refsect1 id="bbv-options">
202<title>BBV Options</title>
203
204<xi:include href="/exp-bbv/docs/bbv-manual.xml" 
205            xpointer="bbv.opts.list"
206            xmlns:xi="http://www.w3.org/2001/XInclude" />
207
208</refsect1>
209
210
211<refsect1 id="lackey-options">
212<title>Lackey Options</title>
213
214<xi:include href="/lackey/docs/lk-manual.xml" 
215            xpointer="lk.opts.list"
216            xmlns:xi="http://www.w3.org/2001/XInclude" />
217
218</refsect1>
219
220
221<refsect1 id="see_also">
222<title>See Also</title>
223
224<para>
225cg_annotate(1),
226callgrind_annotate(1),
227callgrind_control(1),
228ms_print(1),
229<filename>&vg-docs-path;</filename> or
230<filename>&vg-docs-url;</filename>.
231</para>
232
233</refsect1>
234
235
236<refsect1 id="author">
237<title>Author</title>
238
239<para>The Valgrind developers.</para>
240
241<para>This manpage was written by Andres Roldan &lt;aroldan@debian.org&gt;
242and the Valgrind developers.</para>
243
244</refsect1>
245
246
247</refentry>
248
249