njn | 00cfcfc | 2005-11-12 18:53:50 +0000 | [diff] [blame] | 1 | usage: valgrind [options] prog-and-args |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 2 | |
| 3 | common user options for all Valgrind tools, with defaults in [ ]: |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 4 | --tool=<name> use the Valgrind tool named <name> [memcheck] |
nethercote | a76368b | 2004-06-16 11:56:29 +0000 | [diff] [blame] | 5 | -h --help show this message |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 6 | --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] |
nethercote | 0d58850 | 2004-06-21 13:27:11 +0000 | [diff] [blame] | 11 | --track-fds=no|yes track open file descriptors? [no] |
thughes | 6233a38 | 2004-08-21 11:10:44 +0000 | [diff] [blame] | 12 | --time-stamp=no|yes add timestamps to log messages? [no] |
njn | ce54555 | 2005-07-25 22:36:52 +0000 | [diff] [blame] | 13 | --log-fd=<number> log messages to file descriptor [2=stderr] |
tom | bbe14b1 | 2005-11-04 16:49:39 +0000 | [diff] [blame] | 14 | --log-file=<file> log messages to <file>.<pid> |
njn | ce54555 | 2005-07-25 22:36:52 +0000 | [diff] [blame] | 15 | --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 |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 18 | |
| 19 | uncommon user options for all Valgrind tools: |
nethercote | 0d58850 | 2004-06-21 13:27:11 +0000 | [diff] [blame] | 20 | --run-libc-freeres=no|yes free up glibc memory at exit? [yes] |
njn | 628add6 | 2005-11-12 18:21:40 +0000 | [diff] [blame] | 21 | --sim-hints=hint1,hint2,... known hints: |
sewardj | 19617ae | 2005-10-20 01:09:57 +0000 | [diff] [blame] | 22 | lax-ioctls, enable-outer [none] |
sewardj | 8f01fbe | 2005-03-20 12:06:57 +0000 | [diff] [blame] | 23 | --show-emwarns=no|yes show warnings about emulation limits? [no] |
sewardj | 6c3a219 | 2005-07-24 07:00:45 +0000 | [diff] [blame] | 24 | --smc-check=none|stack|all checks for self-modifying code: none, |
| 25 | only for code found in stacks, or all [stack] |
sewardj | 3c3f0c1 | 2005-11-08 15:52:36 +0000 | [diff] [blame] | 26 | --kernel-variant=variant1,variant2,... known variants: bproc [none] |
| 27 | handle non-standard kernel variants |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 28 | |
| 29 | user options for Valgrind tools that report errors: |
njn | ce54555 | 2005-07-25 22:36:52 +0000 | [diff] [blame] | 30 | --xml=yes all output is in XML (Memcheck/Nulgrind only) |
njn | 483398e | 2005-07-20 03:03:44 +0000 | [diff] [blame] | 31 | --xml-user-comment=STR copy STR verbatim to XML output |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 32 | --demangle=no|yes automatically demangle C++ names? [yes] |
njn | 20b4a15 | 2005-10-19 22:39:40 +0000 | [diff] [blame] | 33 | --num-callers=<number> show <number> callers in stack traces [12] |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 34 | --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> |
sewardj | 09272c7 | 2005-01-11 14:21:02 +0000 | [diff] [blame] | 37 | --gen-suppressions=no|yes|all print suppressions for errors? [no] |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 38 | --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] |
sewardj | 412ad6e | 2005-04-03 00:16:11 +0000 | [diff] [blame] | 41 | --max-stackframe=<number> assume stack switch for SP changes larger |
| 42 | than <number> bytes [2000000] |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 43 | |
njn | 7eea51f | 2004-11-26 12:54:07 +0000 | [diff] [blame] | 44 | user options for Nulgrind: |
| 45 | (none) |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 46 | |
| 47 | debugging options for all Valgrind tools: |
| 48 | --sanity-level=<number> level of sanity checking to do [1] |
sewardj | fa8ec11 | 2005-01-19 11:55:34 +0000 | [diff] [blame] | 49 | --trace-flags=<XXXXXXXX> show generated code? (X = 0|1) [00000000] |
| 50 | --profile-flags=<XXXXXXXX> ditto, but for profiling (X = 0|1) [00000000] |
njn | 20b4a15 | 2005-10-19 22:39:40 +0000 | [diff] [blame] | 51 | --trace-notbelow=<number> only show BBs above <number> [0] |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 52 | --trace-syscalls=no|yes show all system calls? [no] |
| 53 | --trace-signals=no|yes show signal handling details? [no] |
| 54 | --trace-symtab=no|yes show symbol table details? [no] |
sewardj | 1dd628a | 2005-05-03 16:44:31 +0000 | [diff] [blame] | 55 | --trace-cfi=no|yes show call-frame-info details? [no] |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 56 | --trace-sched=no|yes show thread scheduler details? [no] |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 57 | --wait-for-gdb=yes|no pause on startup to wait for gdb attach |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 58 | --command-line-only=no|yes only use command line options [no] |
njn | 613812e | 2005-03-11 04:57:30 +0000 | [diff] [blame] | 59 | |
sewardj | 0dbb7de | 2004-11-26 12:37:10 +0000 | [diff] [blame] | 60 | --vex-iropt-verbosity 0 .. 9 [0] |
| 61 | --vex-iropt-level 0 .. 2 [2] |
| 62 | --vex-iropt-precise-memory-exns [no] |
| 63 | --vex-iropt-unroll-thresh 0 .. 400 [120] |
| 64 | --vex-guest-max-insns 1 .. 100 [50] |
| 65 | --vex-guest-chase-thresh 0 .. 99 [10] |
| 66 | |
sewardj | fa8ec11 | 2005-01-19 11:55:34 +0000 | [diff] [blame] | 67 | --trace-flags and --profile-flags values (omit the middle space): |
sewardj | 0dbb7de | 2004-11-26 12:37:10 +0000 | [diff] [blame] | 68 | 1000 0000 show conversion into IR |
| 69 | 0100 0000 show after initial opt |
| 70 | 0010 0000 show after instrumentation |
| 71 | 0001 0000 show after second opt |
| 72 | 0000 1000 show after tree building |
| 73 | 0000 0100 show selecting insns |
| 74 | 0000 0010 show after reg-alloc |
| 75 | 0000 0001 show final assembly |
| 76 | |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 77 | debugging options for Valgrind tools that report errors |
| 78 | --dump-error=<number> show translation for basic block associated |
| 79 | with <number>'th error context [0=show none] |
| 80 | |
njn | 7eea51f | 2004-11-26 12:54:07 +0000 | [diff] [blame] | 81 | debugging options for Nulgrind: |
| 82 | (none) |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 83 | |
| 84 | Extra options read from ~/.valgrindrc, $VALGRIND_OPTS, ./.valgrindrc |
| 85 | |
njn | 5361242 | 2005-03-12 16:22:54 +0000 | [diff] [blame] | 86 | Valgrind is Copyright (C) 2000-2005 Julian Seward et al. |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 87 | and licensed under the GNU General Public License, version 2. |
njn | 272b216 | 2005-05-17 03:22:38 +0000 | [diff] [blame] | 88 | Bug reports, feedback, admiration, abuse, etc, to: www.valgrind.org. |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 89 | |
| 90 | Tools are copyright and licensed by their authors. See each |
| 91 | tool's start-up message for more information. |
| 92 | |