blob: 7c7d9e421aa8682abc273f3c245d71f74c4c3f15 [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]
sewardj4daf4392005-07-07 11:32:37 +000020 --smc-support=none|stack|all support for self-modifying code:
21 none, for code found in stacks, or all [stack]
nethercotef4928da2004-06-15 10:54:40 +000022
23 user options for Valgrind tools that report errors:
njn483398e2005-07-20 03:03:44 +000024 --xml=yes all output is in XML (Memcheck only)
25 --xml-user-comment=STR copy STR verbatim to XML output
nethercotef8548672004-06-21 12:42:35 +000026 --log-fd=<number> log messages to file descriptor [2=stderr]
27 --log-file=<file> log messages to <file>.pid<pid>
sewardj09272c72005-01-11 14:21:02 +000028 --log-file-exactly=<file> log messages to <file>
njn483398e2005-07-20 03:03:44 +000029 --log-file-qualifier=<VAR> incorporate $VAR in logfile name [none]
nethercotef8548672004-06-21 12:42:35 +000030 --log-socket=ipaddr:port log messages to socket ipaddr:port
nethercotef4928da2004-06-15 10:54:40 +000031 --demangle=no|yes automatically demangle C++ names? [yes]
njncc6cc142005-03-12 20:59:29 +000032 --num-callers=<number> show <num> callers in stack traces [12]
nethercotef4928da2004-06-15 10:54:40 +000033 --error-limit=no|yes stop showing new errors if too many? [yes]
34 --show-below-main=no|yes continue stack traces below main() [no]
35 --suppressions=<filename> suppress errors described in <filename>
sewardj09272c72005-01-11 14:21:02 +000036 --gen-suppressions=no|yes|all print suppressions for errors? [no]
nethercotef4928da2004-06-15 10:54:40 +000037 --db-attach=no|yes start debugger when errors detected? [no]
38 --db-command=<command> command to start debugger [gdb -nw %f %p]
39 --input-fd=<number> file descriptor for input [0=stdin]
sewardj412ad6e2005-04-03 00:16:11 +000040 --max-stackframe=<number> assume stack switch for SP changes larger
41 than <number> bytes [2000000]
nethercotef4928da2004-06-15 10:54:40 +000042
njn7eea51f2004-11-26 12:54:07 +000043 user options for Nulgrind:
44 (none)
nethercotef4928da2004-06-15 10:54:40 +000045
46 debugging options for all Valgrind tools:
47 --sanity-level=<number> level of sanity checking to do [1]
48 --single-step=no|yes translate each instr separately? [no]
49 --optimise=no|yes improve intermediate code? [yes]
50 --profile=no|yes profile? (tool must be built for it) [no]
nethercotef4928da2004-06-15 10:54:40 +000051 --branchpred=yes|no generate branch prediction hints [no]
sewardjfa8ec112005-01-19 11:55:34 +000052 --trace-flags=<XXXXXXXX> show generated code? (X = 0|1) [00000000]
53 --profile-flags=<XXXXXXXX> ditto, but for profiling (X = 0|1) [00000000]
sewardjb67b2a22004-12-06 00:47:37 +000054 --trace-notbelow=<number> only show BBs above <number> [0]
nethercotef4928da2004-06-15 10:54:40 +000055 --trace-syscalls=no|yes show all system calls? [no]
56 --trace-signals=no|yes show signal handling details? [no]
57 --trace-symtab=no|yes show symbol table details? [no]
sewardj1dd628a2005-05-03 16:44:31 +000058 --trace-cfi=no|yes show call-frame-info details? [no]
nethercotef4928da2004-06-15 10:54:40 +000059 --trace-sched=no|yes show thread scheduler details? [no]
nethercotef4928da2004-06-15 10:54:40 +000060 --wait-for-gdb=yes|no pause on startup to wait for gdb attach
sewardjb5f6f512005-03-10 23:59:00 +000061 --command-line-only=no|yes only use command line options [no]
njn613812e2005-03-11 04:57:30 +000062
sewardj0dbb7de2004-11-26 12:37:10 +000063 --vex-iropt-verbosity 0 .. 9 [0]
64 --vex-iropt-level 0 .. 2 [2]
65 --vex-iropt-precise-memory-exns [no]
66 --vex-iropt-unroll-thresh 0 .. 400 [120]
67 --vex-guest-max-insns 1 .. 100 [50]
68 --vex-guest-chase-thresh 0 .. 99 [10]
69
sewardjfa8ec112005-01-19 11:55:34 +000070 --trace-flags and --profile-flags values (omit the middle space):
sewardj0dbb7de2004-11-26 12:37:10 +000071 1000 0000 show conversion into IR
72 0100 0000 show after initial opt
73 0010 0000 show after instrumentation
74 0001 0000 show after second opt
75 0000 1000 show after tree building
76 0000 0100 show selecting insns
77 0000 0010 show after reg-alloc
78 0000 0001 show final assembly
79
nethercotef4928da2004-06-15 10:54:40 +000080 debugging options for Valgrind tools that report errors
81 --dump-error=<number> show translation for basic block associated
82 with <number>'th error context [0=show none]
83
njn7eea51f2004-11-26 12:54:07 +000084 debugging options for Nulgrind:
85 (none)
nethercotef4928da2004-06-15 10:54:40 +000086
87 Extra options read from ~/.valgrindrc, $VALGRIND_OPTS, ./.valgrindrc
88
njn53612422005-03-12 16:22:54 +000089 Valgrind is Copyright (C) 2000-2005 Julian Seward et al.
nethercotef4928da2004-06-15 10:54:40 +000090 and licensed under the GNU General Public License, version 2.
njn272b2162005-05-17 03:22:38 +000091 Bug reports, feedback, admiration, abuse, etc, to: www.valgrind.org.
nethercotef4928da2004-06-15 10:54:40 +000092
93 Tools are copyright and licensed by their authors. See each
94 tool's start-up message for more information.
95