doc/runtest.1

   1 .TH runtest 1 "2018-12-01"
   2 .SH NAME
   3 runtest \- DejaGnu test driver
   4 .SH SYNOPSIS
   5 .B runtest
   6 [OPTION]...
   7 .SH DESCRIPTION
   8 .I DejaGnu
   9 is a framework for testing programs using Expect.
  10 .B runtest
  11 is the driver program for
  12 .I DejaGnu.
  13 It controls what tests to run and how to run them.
  14 .SH OPTIONS
  15 .TP
  16 .B --all,\ -a
  17 Output all test results. By default, only unexpected results are
  18 displayed.
  19 .TP
  20 .BI --build \ TRIPLET
  21 The configuration TRIPLET for the build system.
  22 .TP
  23 .B --debug
  24 Turn on
  25 .B Expect
  26 internal debugging output. The output is logged to a file called
  27 \fBdbg.log\fR.
  28 .TP
  29 .BI --directory \ DIRECTORY
  30 Run only tests in the specified DIRECTORY.
  31 .TP
  32 .BI --global_init \ NAME
  33 The NAME to use for the global init file in libdir.
  34 The default is \fBsite.exp\fR if this option is not given.
  35 .TP
  36 .B --help
  37 Prints a usage message and then exits.
  38 .TP
  39 .BI --host \ TRIPLET
  40 The configuration TRIPLET for the host system.
  41 .TP
  42 .BI --host_board \ NAME
  43 The host board definition to use.
  44 .TP
  45 .BI --ignore \ test1.exp\ test2.exp\ ...
  46 Do not run the specified tests.
  47 .TP
  48 .BI --local_init \ NAME
  49 The NAME to use for the testsuite local init file in both the current
  50 directory and objdir.
  51 The default is \fBsite.exp\fR if this option is not given.
  52 .TP
  53 .B --log_dialog
  54 Emit Expect output to standard output.
  55 .TP
  56 .BI --mail \ \'name1\ name2\ ...\'
  57 Electronic mail addresses to receive test results.
  58 .TP
  59 .BI --objdir \ PATH
  60 \fIPATH\fR is a directory containing compiled test code.
  61 .TP
  62 .BI --outdir \ DIRECTORY
  63 The name of a DIRECTORY for test log output.
  64 .TP
  65 .B --reboot
  66 Reboot the target board when \fBruntest\fR initializes
  67 (if supported).
  68 .TP
  69 .BI --srcdir \ PATH
  70 \fIPATH\fR is a directory containing test directories.
  71 .TP
  72 .BI --strace \ N
  73 Turns on
  74 .B Expect
  75 internal tracing to \fIN\fR levels deep. The output is logged to a
  76 file called \fBdbg.log\fR.
  77 .TP
  78 .BI --target \ TRIPLET
  79 The configuration TRIPLET for the target.
  80 .TP
  81 .BI --target_board \ NAME
  82 A list of target board NAMEs to run tests on.
  83 .TP
  84 .BI --tool \ TOOLNAME
  85 Specify the tool to be tested.  \fITOOLNAME\fR controls the test suite
  86 applied, and the associated initialization module.
  87 .TP
  88 .BI --tool_exec \ PATH
  89 Specify the PATH to the executable to test.
  90 .TP
  91 .BI --tool_opts \ OPTIONS
  92 Additional OPTIONS to pass to the tool.
  93 .TP
  94 .B -v,\ --verbose
  95 Turns on more debugging output from test cases and DejaGnu utility code.
  96 Use more than once to increase output further.
  97 .TP
  98 .B -V,\ --version
  99 Prints out the versions of DejaGnu, Expect and Tcl.
 100 .TP
 101 .B -x,\ --xml
 102 Generate XML output.  The output file is named after the tool with
 103 an .xml extension.
 104 .TP
 105 .B -D[number]
 106 Activate the Tcl debugger.  \fBnumber\fR can be either 1 or 0. If it
 107 is 1, then the Expect shell will break when it starts to run. The
 108 interrupt key will cause DejaGnu to drop to the debugger prompt. If it
 109 is 0, DejaGnu starts as usual, but Control-C drops to the debugger
 110 prompt.
 111 .TP 0
 112 Any file name on the command line is assumed to be a subset of the
 113 test names to run.  Usually these are the names of the test scripts
 114 (eg. foo.exp).
 115 .PP
 116 Makefile-style variables are used to specify tool names and their
 117 flags; these and other configuration dependent values are saved in the
 118 file \fBsite.exp\fR, created during configuration.
 119 .SS "Exit status:"
 120 .TP
 121 0
 122 if all tests passed including expected failures and unsupported tests,
 123 .TP
 124 1
 125 if any test failed, passed unexpectedly, or was unresolved,
 126 .TP
 127 2
 128 if Expect encountered any error in the test scripts.
 129 .SH AUTHOR
 130 Rob Savoye (rob@welcomehome.org)
 131 .SH "REPORTING BUGS"
 132 Report bugs to <bug\-dejagnu@gnu.org>.
 133 .SH COPYRIGHT
 134 Copyright \(co 2005\-2016, 2018 Free Software Foundation, Inc.
 135 .PP
 136 This is free software.  You may redistribute copies of it under the terms of
 137 the GNU General Public License <http://www.gnu.org/licenses/gpl.html>.
 138 There is NO WARRANTY, to the extent permitted by law.
 139 .SH "SEE ALSO"
 140 The full documentation for
 141 .B DejaGnu
 142 is maintained as a Texinfo manual.  If the
 143 .B info
 144 program is properly installed at your site, the command
 145 .IP
 146 .B info dejagnu
 147 .PP
 148 should give you access to the complete manual.