blob: fadaa59537135a220ab787538d4ed4e21efdb17d [file] [log] [blame]
njn00cfcfc2005-11-12 18:53:50 +00001usage: valgrind [options] prog-and-args
nethercotef4928da2004-06-15 10:54:40 +00002
njn97db7612009-08-04 02:32:55 +00003 tool-selection option, with default in [ ]:
sewardjb5f6f512005-03-10 23:59:00 +00004 --tool=<name> use the Valgrind tool named <name> [memcheck]
njn97db7612009-08-04 02:32:55 +00005
6 basic user options for all Valgrind tools, with defaults in [ ]:
nethercotea76368b2004-06-16 11:56:29 +00007 -h --help show this message
nethercotef4928da2004-06-15 10:54:40 +00008 --help-debug show this message, plus debugging options
9 --version show version
10 -q --quiet run silently; only print error msgs
sewardj2d9e8742009-08-07 15:46:56 +000011 -v --verbose be more verbose -- show misc extra info
njn374a36d2007-11-23 01:41:32 +000012 --trace-children=no|yes Valgrind-ise child processes (follow execve)? [no]
sewardj06421272009-11-05 08:55:13 +000013 --trace-children-skip=patt1,patt2,... specifies a list of executables
14 that --trace-children=yes should not trace into
sewardj9ab64a42010-12-06 11:40:04 +000015 --trace-children-skip-by-arg=patt1,patt2,... same as --trace-children-skip=
16 but check the argv[] entries for children, rather
17 than the exe name, to make a follow/no-follow decision
njn97db7612009-08-04 02:32:55 +000018 --child-silent-after-fork=no|yes omit child output between fork & exec? [no]
nethercote0d588502004-06-21 13:27:11 +000019 --track-fds=no|yes track open file descriptors? [no]
thughes6233a382004-08-21 11:10:44 +000020 --time-stamp=no|yes add timestamps to log messages? [no]
njnce545552005-07-25 22:36:52 +000021 --log-fd=<number> log messages to file descriptor [2=stderr]
njn374a36d2007-11-23 01:41:32 +000022 --log-file=<file> log messages to <file>
njnce545552005-07-25 22:36:52 +000023 --log-socket=ipaddr:port log messages to socket ipaddr:port
nethercotef4928da2004-06-15 10:54:40 +000024
nethercotef4928da2004-06-15 10:54:40 +000025 user options for Valgrind tools that report errors:
sewardj8fd87582009-07-15 14:52:02 +000026 --xml=yes emit error output in XML (some tools only)
27 --xml-fd=<number> XML output to file descriptor
28 --xml-file=<file> XML output to <file>
29 --xml-socket=ipaddr:port XML output to socket ipaddr:port
30 --xml-user-comment=STR copy STR verbatim into XML output
nethercotef4928da2004-06-15 10:54:40 +000031 --demangle=no|yes automatically demangle C++ names? [yes]
njn20b4a152005-10-19 22:39:40 +000032 --num-callers=<number> show <number> callers in stack traces [12]
nethercotef4928da2004-06-15 10:54:40 +000033 --error-limit=no|yes stop showing new errors if too many? [yes]
sewardj365985f2006-05-13 01:54:15 +000034 --error-exitcode=<number> exit code to return if errors found [0=disable]
nethercotef4928da2004-06-15 10:54:40 +000035 --show-below-main=no|yes continue stack traces below main() [no]
36 --suppressions=<filename> suppress errors described in <filename>
sewardj09272c72005-01-11 14:21:02 +000037 --gen-suppressions=no|yes|all print suppressions for errors? [no]
nethercotef4928da2004-06-15 10:54:40 +000038 --db-attach=no|yes start debugger when errors detected? [no]
bart0f212dc2009-08-20 18:38:59 +000039 --db-command=<command> command to start debugger [... -nw %f %p]
nethercotef4928da2004-06-15 10:54:40 +000040 --input-fd=<number> file descriptor for input [0=stdin]
njn97db7612009-08-04 02:32:55 +000041 --dsymutil=no|yes run dsymutil on Mac OS X when helpful? [no]
sewardj412ad6e2005-04-03 00:16:11 +000042 --max-stackframe=<number> assume stack switch for SP changes larger
43 than <number> bytes [2000000]
sewardj95d86c02007-12-18 01:49:23 +000044 --main-stacksize=<number> set size of main thread's stack (in bytes)
45 [use current 'ulimit' value]
nethercotef4928da2004-06-15 10:54:40 +000046
njn97db7612009-08-04 02:32:55 +000047 user options for Valgrind tools that replace malloc:
48 --alignment=<number> set minimum alignment of heap allocations [...]
49
50 uncommon user options for all Valgrind tools:
sewardj14cdbf82010-10-12 00:44:05 +000051 --fullpath-after= (with nothing after the '=')
52 show full source paths in call stacks
53 --fullpath-after=string like --fullpath-after=, but only show the
54 part of the path after 'string'. Allows removal
55 of path prefixes. Use this flag multiple times
56 to specify a set of prefixes to remove.
njn97db7612009-08-04 02:32:55 +000057 --smc-check=none|stack|all checks for self-modifying code: none,
58 only for code found in stacks, or all [stack]
59 --read-var-info=yes|no read debug info on stack and global variables
60 and use it to print better error messages in
61 tools that make use of it (Memcheck, Helgrind,
bartf6122a02010-03-27 07:38:39 +000062 DRD) [no]
njn97db7612009-08-04 02:32:55 +000063 --run-libc-freeres=no|yes free up glibc memory at exit on Linux? [yes]
64 --sim-hints=hint1,hint2,... known hints:
65 lax-ioctls, enable-outer [none]
66 --kernel-variant=variant1,variant2,... known variants: bproc [none]
67 handle non-standard kernel variants
68 --show-emwarns=no|yes show warnings about emulation limits? [no]
sewardjf9ebc392010-05-09 22:30:43 +000069 --require-text-symbol=:sonamepattern:symbolpattern abort run if the
70 stated shared object doesn't have the stated
71 text symbol. Patterns can contain ? and *.
njn97db7612009-08-04 02:32:55 +000072
nethercotef4928da2004-06-15 10:54:40 +000073 user options for Nulgrind:
74 (none)
75
76 Extra options read from ~/.valgrindrc, $VALGRIND_OPTS, ./.valgrindrc
77
sewardj9eecbbb2010-05-03 21:37:12 +000078 Nulgrind is Copyright (C) 2002-2010, and GNU GPL'd, by Nicholas Nethercote.
79 Valgrind is Copyright (C) 2000-2010, and GNU GPL'd, by Julian Seward et al.
sewardje089f012010-10-13 21:47:29 +000080 LibVEX is Copyright (C) 2004-2010, and GNU GPL'd, by OpenWorks LLP et al.
nethercotef4928da2004-06-15 10:54:40 +000081
njn10b9aea2009-07-14 06:55:05 +000082 Bug reports, feedback, admiration, abuse, etc, to: www.valgrind.org.
nethercotef4928da2004-06-15 10:54:40 +000083