|
From: <sv...@va...> - 2005-11-14 15:01:35
|
Author: tom Date: 2005-11-14 15:01:32 +0000 (Mon, 14 Nov 2005) New Revision: 5124 Log: Update manual page. Modified: trunk/docs/valgrind.1 Modified: trunk/docs/valgrind.1 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/docs/valgrind.1 2005-11-14 14:37:02 UTC (rev 5123) +++ trunk/docs/valgrind.1 2005-11-14 15:01:32 UTC (rev 5124) @@ -144,8 +144,8 @@ =20 .TP .B ---gen-suppressions=3D<yes|no> [default: no] -When enabled, \fBvalgrind\fP will pause after every error shown and +--gen-suppressions=3D<yes|no|all> [default: no] +When set to \fByes\fP, \fBvalgrind\fP will pause after every error shown= and print the line: =20 .PP @@ -167,6 +167,10 @@ .P Pressing C Ret or c Ret will cause no suppression to be printed and \fBvalgrind\fP will not ask again. + +.P +When set to \fall\fP, \fBvalgrind\fP will print suppressions for all +errors without asking any questions. .RE =20 .TP @@ -188,6 +192,14 @@ =20 .TP .B +--log-fd=3D<number> [default: 2, stderr] +Specifies that \fBvalgrind\fP should send all of its messages to +the specified file descriptor. The default, 2, is the standard error +channel (stderr). Note that this may interfere with the client's own +use of stderr. + +.TP +.B --log-file=3D<filename> Specifies that \fBvalgrind\fP should send all of its messages to the specified file. In fact, the file name used is created by concatenating @@ -197,23 +209,15 @@ .TP .B --log-file-exactly=3D<filename> -Just like \fB--log-file\fB, but the ".pid" suffix is not added. If you +Just like \fB--log-file\fP, but the ".pid" suffix is not added. If you trace multiple processes with Valgrind when using this option the log file may get all messed up. =20 .TP .B ---log-fd=3D<number> [default: 2, stderr] -Specifies that \fBvalgrind\fP should send all of its messages to -the specified file descriptor. The default, 2, is the standard error -channel (stderr). Note that this may interfere with the client's own -use of stderr. - -.TP -.B --log-file-qualifier=3D<VAR> -Specifies that \fBvalgrind\fB should send all of its messages to the -file named by the environment variable \fB$VAR\fB. This is useful when +Specifies that \fBvalgrind\fP should send all of its messages to the +file named by the environment variable \fB$VAR\fP. This is useful when running MPI programs. =20 .TP @@ -229,7 +233,14 @@ =20 .TP .B ---num-callers=3D<number> [default=3D12] +--max-stackframe=3D<number> [default: 2000000] +The maximum size of a stack frame - if the stack pointer moves by more +than this amount then \fBvalgrind\fP will assume that the program is +switching to a different stack. + +.TP +.B +--num-callers=3D<number> [default: 12] By default, \fBvalgrind\fP shows 12 levels of function call names to help you identify program locations. You can change that number with this option. This can help in determining the program's location in @@ -304,6 +315,18 @@ with. This was done to minimise the chances of strange problems arising from tool-vs-core version incompatibilities. =20 +.TP +.B +--xml=3D<yes|no> [default: no] +Generate output in XML format. Only \fBmemcheck\fP and \fBnulgrind\fP +currently support this option. + +.TP +.B +--xml-user-comment=3D<string> +The specified string will be output at the start of the XML file +if XML output is requested. + .SH ADDRCHECK OPTIONS =20 .TP @@ -344,7 +367,7 @@ =20 .TP .B ---partial-loads-ok=3D<yes|no> [default: yes] +--partial-loads-ok=3D<yes|no> [default: no] Controls how \fBaddrcheck\fP handles word (4-byte) loads from addresses for which some bytes are addressible and others are not. When enabled, such loads do not elicit an address error. Instead, \fBaddrcheck\fP @@ -377,17 +400,8 @@ the stack pointer. 2.95.3 seems to be a good choice in this respect. =20 .SH MEMCHECK OPTIONS -\fBmemcheck\fP understands the same options as \fBaddrcheck\fP, along -with the following options: +\fBmemcheck\fP understands the same options as \fBaddrcheck\fP. =20 -.TP -.B ---avoid-strlen-errors=3D<yes|no> [default: yes] -Enable or disable a heuristic for dealing with highly-optimized versions -of \fBstrlen\fP. These versions of \fBstrlen\fP can cause spurious -errors to be reported by \fBmemcheck\fP, so it's usually a good idea to -leave this enabled. - .SH CACHEGRIND OPTIONS =20 .TP @@ -529,11 +543,17 @@ and assume that unknown ioctls just behave correctly. .TP .B -- enable-inner +- enable-outer Enable some special magic needed when the program being run is=20 itself \fBvalgrind\fP. .RE =20 +.TP +.B +--smc-check=3D<none|stack|all> [default: stack] +Control which areas of memory \fBvalgrind\fP should consider might +contain self modifying code. + .SH CORE DEBUGGING OPTIONS =20 .TP |