blob: eba57bcca72f4664aa54c97162dd7875e2cbe884 [file] [log] [blame]
nethercotef4928da2004-06-15 10:54:40 +00001usage: valgrind --tool=<toolname> [options] prog-and-args
2
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]
nethercotef4928da2004-06-15 10:54:40 +000013
14 uncommon user options for all Valgrind tools:
nethercote0d588502004-06-21 13:27:11 +000015 --run-libc-freeres=no|yes free up glibc memory at exit? [yes]
sewardjb5f6f512005-03-10 23:59:00 +000016 --weird-hacks=hack1,hack2,... recognised hacks: lax-ioctls,ioctl-mmap [none]
nethercotef4928da2004-06-15 10:54:40 +000017 --pointercheck=no|yes enforce client address space limits [yes]
sewardj09272c72005-01-11 14:21:02 +000018 --support-elan3=no|yes hacks for Quadrics Elan3 support [no]
sewardj8f01fbe2005-03-20 12:06:57 +000019 --show-emwarns=no|yes show warnings about emulation limits? [no]
nethercotef4928da2004-06-15 10:54:40 +000020
21 user options for Valgrind tools that report errors:
nethercotef8548672004-06-21 12:42:35 +000022 --log-fd=<number> log messages to file descriptor [2=stderr]
23 --log-file=<file> log messages to <file>.pid<pid>
sewardj09272c72005-01-11 14:21:02 +000024 --log-file-exactly=<file> log messages to <file>
nethercotef8548672004-06-21 12:42:35 +000025 --log-socket=ipaddr:port log messages to socket ipaddr:port
nethercotef4928da2004-06-15 10:54:40 +000026 --demangle=no|yes automatically demangle C++ names? [yes]
njncc6cc142005-03-12 20:59:29 +000027 --num-callers=<number> show <num> callers in stack traces [12]
nethercotef4928da2004-06-15 10:54:40 +000028 --error-limit=no|yes stop showing new errors if too many? [yes]
29 --show-below-main=no|yes continue stack traces below main() [no]
30 --suppressions=<filename> suppress errors described in <filename>
sewardj09272c72005-01-11 14:21:02 +000031 --gen-suppressions=no|yes|all print suppressions for errors? [no]
nethercotef4928da2004-06-15 10:54:40 +000032 --db-attach=no|yes start debugger when errors detected? [no]
33 --db-command=<command> command to start debugger [gdb -nw %f %p]
34 --input-fd=<number> file descriptor for input [0=stdin]
sewardj412ad6e2005-04-03 00:16:11 +000035 --max-stackframe=<number> assume stack switch for SP changes larger
36 than <number> bytes [2000000]
nethercotef4928da2004-06-15 10:54:40 +000037
njn7eea51f2004-11-26 12:54:07 +000038 user options for Nulgrind:
39 (none)
nethercotef4928da2004-06-15 10:54:40 +000040
41 debugging options for all Valgrind tools:
42 --sanity-level=<number> level of sanity checking to do [1]
43 --single-step=no|yes translate each instr separately? [no]
44 --optimise=no|yes improve intermediate code? [yes]
45 --profile=no|yes profile? (tool must be built for it) [no]
nethercotef4928da2004-06-15 10:54:40 +000046 --branchpred=yes|no generate branch prediction hints [no]
sewardjfa8ec112005-01-19 11:55:34 +000047 --trace-flags=<XXXXXXXX> show generated code? (X = 0|1) [00000000]
48 --profile-flags=<XXXXXXXX> ditto, but for profiling (X = 0|1) [00000000]
sewardjb67b2a22004-12-06 00:47:37 +000049 --trace-notbelow=<number> only show BBs above <number> [0]
nethercotef4928da2004-06-15 10:54:40 +000050 --trace-syscalls=no|yes show all system calls? [no]
51 --trace-signals=no|yes show signal handling details? [no]
52 --trace-symtab=no|yes show symbol table details? [no]
sewardj1dd628a2005-05-03 16:44:31 +000053 --trace-cfi=no|yes show call-frame-info details? [no]
nethercotef4928da2004-06-15 10:54:40 +000054 --trace-sched=no|yes show thread scheduler details? [no]
nethercotef4928da2004-06-15 10:54:40 +000055 --wait-for-gdb=yes|no pause on startup to wait for gdb attach
sewardjb5f6f512005-03-10 23:59:00 +000056 --command-line-only=no|yes only use command line options [no]
njn613812e2005-03-11 04:57:30 +000057
sewardj0dbb7de2004-11-26 12:37:10 +000058 --vex-iropt-verbosity 0 .. 9 [0]
59 --vex-iropt-level 0 .. 2 [2]
60 --vex-iropt-precise-memory-exns [no]
61 --vex-iropt-unroll-thresh 0 .. 400 [120]
62 --vex-guest-max-insns 1 .. 100 [50]
63 --vex-guest-chase-thresh 0 .. 99 [10]
64
sewardjfa8ec112005-01-19 11:55:34 +000065 --trace-flags and --profile-flags values (omit the middle space):
sewardj0dbb7de2004-11-26 12:37:10 +000066 1000 0000 show conversion into IR
67 0100 0000 show after initial opt
68 0010 0000 show after instrumentation
69 0001 0000 show after second opt
70 0000 1000 show after tree building
71 0000 0100 show selecting insns
72 0000 0010 show after reg-alloc
73 0000 0001 show final assembly
74
nethercotef4928da2004-06-15 10:54:40 +000075 debugging options for Valgrind tools that report errors
76 --dump-error=<number> show translation for basic block associated
77 with <number>'th error context [0=show none]
78
njn7eea51f2004-11-26 12:54:07 +000079 debugging options for Nulgrind:
80 (none)
nethercotef4928da2004-06-15 10:54:40 +000081
82 Extra options read from ~/.valgrindrc, $VALGRIND_OPTS, ./.valgrindrc
83
njn53612422005-03-12 16:22:54 +000084 Valgrind is Copyright (C) 2000-2005 Julian Seward et al.
nethercotef4928da2004-06-15 10:54:40 +000085 and licensed under the GNU General Public License, version 2.
86 Bug reports, feedback, admiration, abuse, etc, to: valgrind.kde.org.
87
88 Tools are copyright and licensed by their authors. See each
89 tool's start-up message for more information.
90