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 | |
njn | 97db761 | 2009-08-04 02:32:55 +0000 | [diff] [blame] | 3 | tool-selection option, with default in [ ]: |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 4 | --tool=<name> use the Valgrind tool named <name> [memcheck] |
njn | 97db761 | 2009-08-04 02:32:55 +0000 | [diff] [blame] | 5 | |
| 6 | basic user options for all Valgrind tools, with defaults in [ ]: |
nethercote | a76368b | 2004-06-16 11:56:29 +0000 | [diff] [blame] | 7 | -h --help show this message |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 8 | --help-debug show this message, plus debugging options |
| 9 | --version show version |
| 10 | -q --quiet run silently; only print error msgs |
sewardj | 2d9e874 | 2009-08-07 15:46:56 +0000 | [diff] [blame] | 11 | -v --verbose be more verbose -- show misc extra info |
njn | 374a36d | 2007-11-23 01:41:32 +0000 | [diff] [blame] | 12 | --trace-children=no|yes Valgrind-ise child processes (follow execve)? [no] |
sewardj | 0642127 | 2009-11-05 08:55:13 +0000 | [diff] [blame] | 13 | --trace-children-skip=patt1,patt2,... specifies a list of executables |
| 14 | that --trace-children=yes should not trace into |
sewardj | 9ab64a4 | 2010-12-06 11:40:04 +0000 | [diff] [blame^] | 15 | --trace-children-skip-by-arg=patt1,patt2,... same as --trace-children-skip= |
| 16 | but check the argv[] entries for children, rather |
| 17 | than the exe name, to make a follow/no-follow decision |
njn | 97db761 | 2009-08-04 02:32:55 +0000 | [diff] [blame] | 18 | --child-silent-after-fork=no|yes omit child output between fork & exec? [no] |
nethercote | 0d58850 | 2004-06-21 13:27:11 +0000 | [diff] [blame] | 19 | --track-fds=no|yes track open file descriptors? [no] |
thughes | 6233a38 | 2004-08-21 11:10:44 +0000 | [diff] [blame] | 20 | --time-stamp=no|yes add timestamps to log messages? [no] |
njn | ce54555 | 2005-07-25 22:36:52 +0000 | [diff] [blame] | 21 | --log-fd=<number> log messages to file descriptor [2=stderr] |
njn | 374a36d | 2007-11-23 01:41:32 +0000 | [diff] [blame] | 22 | --log-file=<file> log messages to <file> |
njn | ce54555 | 2005-07-25 22:36:52 +0000 | [diff] [blame] | 23 | --log-socket=ipaddr:port log messages to socket ipaddr:port |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 24 | |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 25 | user options for Valgrind tools that report errors: |
sewardj | 8fd8758 | 2009-07-15 14:52:02 +0000 | [diff] [blame] | 26 | --xml=yes emit error output in XML (some tools only) |
| 27 | --xml-fd=<number> XML output to file descriptor |
| 28 | --xml-file=<file> XML output to <file> |
| 29 | --xml-socket=ipaddr:port XML output to socket ipaddr:port |
| 30 | --xml-user-comment=STR copy STR verbatim into XML output |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 31 | --demangle=no|yes automatically demangle C++ names? [yes] |
njn | 20b4a15 | 2005-10-19 22:39:40 +0000 | [diff] [blame] | 32 | --num-callers=<number> show <number> callers in stack traces [12] |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 33 | --error-limit=no|yes stop showing new errors if too many? [yes] |
sewardj | 365985f | 2006-05-13 01:54:15 +0000 | [diff] [blame] | 34 | --error-exitcode=<number> exit code to return if errors found [0=disable] |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 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] |
bart | 0f212dc | 2009-08-20 18:38:59 +0000 | [diff] [blame] | 39 | --db-command=<command> command to start debugger [... -nw %f %p] |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 40 | --input-fd=<number> file descriptor for input [0=stdin] |
njn | 97db761 | 2009-08-04 02:32:55 +0000 | [diff] [blame] | 41 | --dsymutil=no|yes run dsymutil on Mac OS X when helpful? [no] |
sewardj | 412ad6e | 2005-04-03 00:16:11 +0000 | [diff] [blame] | 42 | --max-stackframe=<number> assume stack switch for SP changes larger |
| 43 | than <number> bytes [2000000] |
sewardj | 95d86c0 | 2007-12-18 01:49:23 +0000 | [diff] [blame] | 44 | --main-stacksize=<number> set size of main thread's stack (in bytes) |
| 45 | [use current 'ulimit' value] |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 46 | |
njn | 97db761 | 2009-08-04 02:32:55 +0000 | [diff] [blame] | 47 | user options for Valgrind tools that replace malloc: |
| 48 | --alignment=<number> set minimum alignment of heap allocations [...] |
| 49 | |
| 50 | uncommon user options for all Valgrind tools: |
sewardj | 14cdbf8 | 2010-10-12 00:44:05 +0000 | [diff] [blame] | 51 | --fullpath-after= (with nothing after the '=') |
| 52 | show full source paths in call stacks |
| 53 | --fullpath-after=string like --fullpath-after=, but only show the |
| 54 | part of the path after 'string'. Allows removal |
| 55 | of path prefixes. Use this flag multiple times |
| 56 | to specify a set of prefixes to remove. |
njn | 97db761 | 2009-08-04 02:32:55 +0000 | [diff] [blame] | 57 | --smc-check=none|stack|all checks for self-modifying code: none, |
| 58 | only for code found in stacks, or all [stack] |
| 59 | --read-var-info=yes|no read debug info on stack and global variables |
| 60 | and use it to print better error messages in |
| 61 | tools that make use of it (Memcheck, Helgrind, |
bart | f6122a0 | 2010-03-27 07:38:39 +0000 | [diff] [blame] | 62 | DRD) [no] |
njn | 97db761 | 2009-08-04 02:32:55 +0000 | [diff] [blame] | 63 | --run-libc-freeres=no|yes free up glibc memory at exit on Linux? [yes] |
| 64 | --sim-hints=hint1,hint2,... known hints: |
| 65 | lax-ioctls, enable-outer [none] |
| 66 | --kernel-variant=variant1,variant2,... known variants: bproc [none] |
| 67 | handle non-standard kernel variants |
| 68 | --show-emwarns=no|yes show warnings about emulation limits? [no] |
sewardj | f9ebc39 | 2010-05-09 22:30:43 +0000 | [diff] [blame] | 69 | --require-text-symbol=:sonamepattern:symbolpattern abort run if the |
| 70 | stated shared object doesn't have the stated |
| 71 | text symbol. Patterns can contain ? and *. |
njn | 97db761 | 2009-08-04 02:32:55 +0000 | [diff] [blame] | 72 | |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 73 | user options for Nulgrind: |
| 74 | (none) |
| 75 | |
| 76 | Extra options read from ~/.valgrindrc, $VALGRIND_OPTS, ./.valgrindrc |
| 77 | |
sewardj | 9eecbbb | 2010-05-03 21:37:12 +0000 | [diff] [blame] | 78 | Nulgrind is Copyright (C) 2002-2010, and GNU GPL'd, by Nicholas Nethercote. |
| 79 | Valgrind is Copyright (C) 2000-2010, and GNU GPL'd, by Julian Seward et al. |
sewardj | e089f01 | 2010-10-13 21:47:29 +0000 | [diff] [blame] | 80 | LibVEX is Copyright (C) 2004-2010, and GNU GPL'd, by OpenWorks LLP et al. |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 81 | |
njn | 10b9aea | 2009-07-14 06:55:05 +0000 | [diff] [blame] | 82 | Bug reports, feedback, admiration, abuse, etc, to: www.valgrind.org. |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 83 | |