blob: 10e906c4f4a588bf52cbd6196d1dc9a2df69327b [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]
sewardj09272c72005-01-11 14:21:02 +000021 --support-elan3=no|yes hacks for Quadrics Elan3 support [no]
nethercotef4928da2004-06-15 10:54:40 +000022
23 user options for Valgrind tools that report errors:
nethercotef8548672004-06-21 12:42:35 +000024 --log-fd=<number> log messages to file descriptor [2=stderr]
25 --log-file=<file> log messages to <file>.pid<pid>
sewardj09272c72005-01-11 14:21:02 +000026 --log-file-exactly=<file> log messages to <file>
nethercotef8548672004-06-21 12:42:35 +000027 --log-socket=ipaddr:port log messages to socket ipaddr:port
nethercotef4928da2004-06-15 10:54:40 +000028 --demangle=no|yes automatically demangle C++ names? [yes]
29 --num-callers=<number> show <num> callers in stack traces [4]
30 --error-limit=no|yes stop showing new errors if too many? [yes]
31 --show-below-main=no|yes continue stack traces below main() [no]
32 --suppressions=<filename> suppress errors described in <filename>
sewardj09272c72005-01-11 14:21:02 +000033 --gen-suppressions=no|yes|all print suppressions for errors? [no]
nethercotef4928da2004-06-15 10:54:40 +000034 --db-attach=no|yes start debugger when errors detected? [no]
35 --db-command=<command> command to start debugger [gdb -nw %f %p]
36 --input-fd=<number> file descriptor for input [0=stdin]
37
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]
njnc767b432004-11-29 16:08:22 +000046 --bbprofile=no|yes profile bbs? [no]
nethercotef4928da2004-06-15 10:54:40 +000047 --branchpred=yes|no generate branch prediction hints [no]
sewardj0dbb7de2004-11-26 12:37:10 +000048 --trace-codegen=<XXXXXXXX> show generated code? (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]
53 --trace-sched=no|yes show thread scheduler details? [no]
54 --trace-pthread=none|some|all show pthread event details? [none]
55 --wait-for-gdb=yes|no pause on startup to wait for gdb attach
56
sewardj0dbb7de2004-11-26 12:37:10 +000057 --vex-iropt-verbosity 0 .. 9 [0]
58 --vex-iropt-level 0 .. 2 [2]
59 --vex-iropt-precise-memory-exns [no]
60 --vex-iropt-unroll-thresh 0 .. 400 [120]
61 --vex-guest-max-insns 1 .. 100 [50]
62 --vex-guest-chase-thresh 0 .. 99 [10]
63
64 --trace-codegen values (omit the middle space):
65 1000 0000 show conversion into IR
66 0100 0000 show after initial opt
67 0010 0000 show after instrumentation
68 0001 0000 show after second opt
69 0000 1000 show after tree building
70 0000 0100 show selecting insns
71 0000 0010 show after reg-alloc
72 0000 0001 show final assembly
73
nethercotef4928da2004-06-15 10:54:40 +000074 debugging options for Valgrind tools that report errors
75 --dump-error=<number> show translation for basic block associated
76 with <number>'th error context [0=show none]
77
njn7eea51f2004-11-26 12:54:07 +000078 debugging options for Nulgrind:
79 (none)
nethercotef4928da2004-06-15 10:54:40 +000080
81 Extra options read from ~/.valgrindrc, $VALGRIND_OPTS, ./.valgrindrc
82
nethercote08fa9a72004-07-16 17:44:00 +000083 Valgrind is Copyright (C) 2000-2004 Julian Seward et al.
nethercotef4928da2004-06-15 10:54:40 +000084 and licensed under the GNU General Public License, version 2.
85 Bug reports, feedback, admiration, abuse, etc, to: valgrind.kde.org.
86
87 Tools are copyright and licensed by their authors. See each
88 tool's start-up message for more information.
89