blob: 50a0646de14689afdd4e1b2a9267d1dffab032ad [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 [ ]:
nethercote0d588502004-06-21 13:27:11 +00004 --tool=<name> use the Valgrind tool named <name>
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]
16 --weird-hacks=hack1,hack2,... recognised hacks: lax-ioctls [none]
17 --signal-polltime=<time> signal poll period (mS) for older kernels [50]
18 --lowlat-signals=no|yes improve thread signal wake-up latency [no]
19 --lowlat-syscalls=no|yes improve thread syscall wake-up latency [no]
nethercotef4928da2004-06-15 10:54:40 +000020 --pointercheck=no|yes enforce client address space limits [yes]
21
22 user options for Valgrind tools that report errors:
nethercotef8548672004-06-21 12:42:35 +000023 --log-fd=<number> log messages to file descriptor [2=stderr]
24 --log-file=<file> log messages to <file>.pid<pid>
25 --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]
27 --num-callers=<number> show <num> callers in stack traces [4]
28 --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>
31 --gen-suppressions=no|yes print suppressions for errors detected [no]
32 --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]
35
nethercotef4928da2004-06-15 10:54:40 +000036
37 debugging options for all Valgrind tools:
38 --sanity-level=<number> level of sanity checking to do [1]
39 --single-step=no|yes translate each instr separately? [no]
40 --optimise=no|yes improve intermediate code? [yes]
41 --profile=no|yes profile? (tool must be built for it) [no]
42 --chain-bb=no|yes do basic-block chaining? [yes]
43 --branchpred=yes|no generate branch prediction hints [no]
sewardj0dbb7de2004-11-26 12:37:10 +000044 --trace-codegen=<XXXXXXXX> show generated code? (X = 0|1) [00000000]
nethercotef4928da2004-06-15 10:54:40 +000045 --trace-syscalls=no|yes show all system calls? [no]
46 --trace-signals=no|yes show signal handling details? [no]
47 --trace-symtab=no|yes show symbol table details? [no]
48 --trace-sched=no|yes show thread scheduler details? [no]
49 --trace-pthread=none|some|all show pthread event details? [none]
50 --wait-for-gdb=yes|no pause on startup to wait for gdb attach
51
sewardj0dbb7de2004-11-26 12:37:10 +000052 --vex-iropt-verbosity 0 .. 9 [0]
53 --vex-iropt-level 0 .. 2 [2]
54 --vex-iropt-precise-memory-exns [no]
55 --vex-iropt-unroll-thresh 0 .. 400 [120]
56 --vex-guest-max-insns 1 .. 100 [50]
57 --vex-guest-chase-thresh 0 .. 99 [10]
58
59 --trace-codegen values (omit the middle space):
60 1000 0000 show conversion into IR
61 0100 0000 show after initial opt
62 0010 0000 show after instrumentation
63 0001 0000 show after second opt
64 0000 1000 show after tree building
65 0000 0100 show selecting insns
66 0000 0010 show after reg-alloc
67 0000 0001 show final assembly
68
nethercotef4928da2004-06-15 10:54:40 +000069 debugging options for Valgrind tools that report errors
70 --dump-error=<number> show translation for basic block associated
71 with <number>'th error context [0=show none]
72
nethercotef4928da2004-06-15 10:54:40 +000073
74 Extra options read from ~/.valgrindrc, $VALGRIND_OPTS, ./.valgrindrc
75
nethercote08fa9a72004-07-16 17:44:00 +000076 Valgrind is Copyright (C) 2000-2004 Julian Seward et al.
nethercotef4928da2004-06-15 10:54:40 +000077 and licensed under the GNU General Public License, version 2.
78 Bug reports, feedback, admiration, abuse, etc, to: valgrind.kde.org.
79
80 Tools are copyright and licensed by their authors. See each
81 tool's start-up message for more information.
82