|
From: Robert W. <rj...@du...> - 2005-03-06 04:29:13
|
CVS commit by rjwalsh:
Update memcheck description. Comment out all mention of helgrind until
it's working again.
M +19 -14 valgrind.1 1.4
--- valgrind/docs/valgrind.1 #1.3:1.4
@@ -27,9 +27,13 @@
valgrind program args
-This runs \fBprogram\fP (with arguments \fBargs\fP) under valgrind using
-the \fBmemcheck\fP tool. To use a different tool, use the \fB--tool\fP
-option:
+This runs \fBprogram\fP (with arguments \fBargs\fP) under valgrind
+using the \fBmemcheck\fP tool. \fBmemcheck\fP performs a range of
+memory-checking functions, including detecting accesses to uninitialized
+memory, misuse of allocated memory (double frees, access after free,
+etc.) and detecting memory leaks.
- valgrind --tool=addrcheck program args
+To use a different tool, use the \fB--tool\fP option:
+
+ valgrind --tool=toolname program args
The following tools are available:
@@ -40,5 +44,6 @@
- addrcheck
\fBaddrcheck\fP is similar to memcheck, but does not perform the same
-granularity of memory checking.
+granularity of memory checking. This will run faster and use less memory,
+but may miss some problems that \fBmemcheck\fP would catch.
.TP
.B
@@ -403,15 +408,15 @@
have multiple stacks.
-.SH HELGRIND OPTIONS
+." .SH HELGRIND OPTIONS
-.TP
-.B
---private-stacks=<yes|no> [default: no]
-Assume thread stacks are used privately.
+." .TP
+." .B
+." --private-stacks=<yes|no> [default: no]
+." Assume thread stacks are used privately.
-.TP
-.B
---show-last-access=<yes|some|no> [default: no]
-Show location of last word access on error.
+." .TP
+." .B
+." --show-last-access=<yes|some|no> [default: no]
+." Show location of last word access on error.
.SH LESS FREQUENTLY USED CORE OPTIONS
|