blob: cd54e3234517fdd55ee30b02a77fb8b516b3185b [file] [log] [blame]
njn00cfcfc2005-11-12 18:53:50 +00001usage: valgrind [options] prog-and-args
nethercotef4928da2004-06-15 10:54:40 +00002
3 common user options for all Valgrind tools, with defaults in [ ]:
sewardjb5f6f512005-03-10 23:59:00 +00004 --tool=<name> use the Valgrind tool named <name> [memcheck]
nethercotea76368b2004-06-16 11:56:29 +00005 -h --help show this message
nethercotef4928da2004-06-15 10:54:40 +00006 --help-debug show this message, plus debugging options
7 --version show version
8 -q --quiet run silently; only print error msgs
9 -v --verbose be more verbose, incl counts of errors
10 --trace-children=no|yes Valgrind-ise child processes? [no]
nethercote0d588502004-06-21 13:27:11 +000011 --track-fds=no|yes track open file descriptors? [no]
thughes6233a382004-08-21 11:10:44 +000012 --time-stamp=no|yes add timestamps to log messages? [no]
njnce545552005-07-25 22:36:52 +000013 --log-fd=<number> log messages to file descriptor [2=stderr]
tombbe14b12005-11-04 16:49:39 +000014 --log-file=<file> log messages to <file>.<pid>
njnce545552005-07-25 22:36:52 +000015 --log-file-exactly=<file> log messages to <file>
16 --log-file-qualifier=<VAR> incorporate $VAR in logfile name [none]
17 --log-socket=ipaddr:port log messages to socket ipaddr:port
nethercotef4928da2004-06-15 10:54:40 +000018
19 uncommon user options for all Valgrind tools:
nethercote0d588502004-06-21 13:27:11 +000020 --run-libc-freeres=no|yes free up glibc memory at exit? [yes]
njn628add62005-11-12 18:21:40 +000021 --sim-hints=hint1,hint2,... known hints:
sewardj19617ae2005-10-20 01:09:57 +000022 lax-ioctls, enable-outer [none]
sewardj8f01fbe2005-03-20 12:06:57 +000023 --show-emwarns=no|yes show warnings about emulation limits? [no]
sewardj6c3a2192005-07-24 07:00:45 +000024 --smc-check=none|stack|all checks for self-modifying code: none,
25 only for code found in stacks, or all [stack]
sewardj3c3f0c12005-11-08 15:52:36 +000026 --kernel-variant=variant1,variant2,... known variants: bproc [none]
27 handle non-standard kernel variants
nethercotef4928da2004-06-15 10:54:40 +000028
29 user options for Valgrind tools that report errors:
njnce545552005-07-25 22:36:52 +000030 --xml=yes all output is in XML (Memcheck/Nulgrind only)
njn483398e2005-07-20 03:03:44 +000031 --xml-user-comment=STR copy STR verbatim to XML output
nethercotef4928da2004-06-15 10:54:40 +000032 --demangle=no|yes automatically demangle C++ names? [yes]
njn20b4a152005-10-19 22:39:40 +000033 --num-callers=<number> show <number> callers in stack traces [12]
nethercotef4928da2004-06-15 10:54:40 +000034 --error-limit=no|yes stop showing new errors if too many? [yes]
35 --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]
39 --db-command=<command> command to start debugger [gdb -nw %f %p]
40 --input-fd=<number> file descriptor for input [0=stdin]
sewardj412ad6e2005-04-03 00:16:11 +000041 --max-stackframe=<number> assume stack switch for SP changes larger
42 than <number> bytes [2000000]
nethercotef4928da2004-06-15 10:54:40 +000043
njn7eea51f2004-11-26 12:54:07 +000044 user options for Nulgrind:
45 (none)
nethercotef4928da2004-06-15 10:54:40 +000046
47 debugging options for all Valgrind tools:
48 --sanity-level=<number> level of sanity checking to do [1]
nethercotef4928da2004-06-15 10:54:40 +000049 --profile=no|yes profile? (tool must be built for it) [no]
sewardjfa8ec112005-01-19 11:55:34 +000050 --trace-flags=<XXXXXXXX> show generated code? (X = 0|1) [00000000]
51 --profile-flags=<XXXXXXXX> ditto, but for profiling (X = 0|1) [00000000]
njn20b4a152005-10-19 22:39:40 +000052 --trace-notbelow=<number> only show BBs above <number> [0]
nethercotef4928da2004-06-15 10:54:40 +000053 --trace-syscalls=no|yes show all system calls? [no]
54 --trace-signals=no|yes show signal handling details? [no]
55 --trace-symtab=no|yes show symbol table details? [no]
sewardj1dd628a2005-05-03 16:44:31 +000056 --trace-cfi=no|yes show call-frame-info details? [no]
nethercotef4928da2004-06-15 10:54:40 +000057 --trace-sched=no|yes show thread scheduler details? [no]
nethercotef4928da2004-06-15 10:54:40 +000058 --wait-for-gdb=yes|no pause on startup to wait for gdb attach
sewardjb5f6f512005-03-10 23:59:00 +000059 --command-line-only=no|yes only use command line options [no]
njn613812e2005-03-11 04:57:30 +000060
sewardj0dbb7de2004-11-26 12:37:10 +000061 --vex-iropt-verbosity 0 .. 9 [0]
62 --vex-iropt-level 0 .. 2 [2]
63 --vex-iropt-precise-memory-exns [no]
64 --vex-iropt-unroll-thresh 0 .. 400 [120]
65 --vex-guest-max-insns 1 .. 100 [50]
66 --vex-guest-chase-thresh 0 .. 99 [10]
67
sewardjfa8ec112005-01-19 11:55:34 +000068 --trace-flags and --profile-flags values (omit the middle space):
sewardj0dbb7de2004-11-26 12:37:10 +000069 1000 0000 show conversion into IR
70 0100 0000 show after initial opt
71 0010 0000 show after instrumentation
72 0001 0000 show after second opt
73 0000 1000 show after tree building
74 0000 0100 show selecting insns
75 0000 0010 show after reg-alloc
76 0000 0001 show final assembly
77
nethercotef4928da2004-06-15 10:54:40 +000078 debugging options for Valgrind tools that report errors
79 --dump-error=<number> show translation for basic block associated
80 with <number>'th error context [0=show none]
81
njn7eea51f2004-11-26 12:54:07 +000082 debugging options for Nulgrind:
83 (none)
nethercotef4928da2004-06-15 10:54:40 +000084
85 Extra options read from ~/.valgrindrc, $VALGRIND_OPTS, ./.valgrindrc
86
njn53612422005-03-12 16:22:54 +000087 Valgrind is Copyright (C) 2000-2005 Julian Seward et al.
nethercotef4928da2004-06-15 10:54:40 +000088 and licensed under the GNU General Public License, version 2.
njn272b2162005-05-17 03:22:38 +000089 Bug reports, feedback, admiration, abuse, etc, to: www.valgrind.org.
nethercotef4928da2004-06-15 10:54:40 +000090
91 Tools are copyright and licensed by their authors. See each
92 tool's start-up message for more information.
93