doc/runtest.1

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