doc/runtest.1

   1 .TH runtest 1 "29 Jul 2003"
   2 .SH NAME
   3 runtest \- the DejaGnu test driver program
   4 .SH SYNOPSIS
   5 .B runtest
   6 [ options ]
   7 .SH DESCRIPTION
   8 .I DejaGnu
   9 is a framework for running test suites on GNU tools. It is written in
  10 expect, which uses Tcl (Tool command language).
  11 .B runtest
  12 is the test driver program; use it to control what tests to run,
  13 and variations on how to run them.
  14
  15 You can find a comprehensive description of DejaGnu and \fBruntest\fR in
  16 .I
  17 The DejaGnu Testing Framework
  18 or its Info version,
  19 .BR dejagnu.info .
  20 .SH OPTIONS
  21 .TP
  22 .B --all
  23 Print all test output to screen. By default, only unexpected results are
  24 displayed.
  25 .TP
  26 .BI --baud \ rate
  27 Set the baud rate for a serial line connection. Some serial interface
  28 programs (like \fBtip\fR) don't use this value but instead use a separate
  29 initialization file.
  30 .TP
  31 .BI --connect \ type
  32 The type of connection to use.  The choices are
  33 .BR rlogin ,
  34 .BR telnet ,
  35 .BR rsh ,
  36 .BR kermit ,
  37 .BR tip
  38 and
  39 .BR mondfe .
  40 .TP
  41 .B --debug
  42 Turn on
  43 .B expect
  44 internal debugging output. All output is logged to
  45 a file called \fBdbg.out\fR.
  46 The output of the \fB--strace\fR also goes into this file.
  47 .TP
  48 .B --help
  49 Prints out a help screen and then exits.
  50 .TP
  51 .BI --host \ type
  52 The configuration string for the host.
  53 .TP
  54 .BI --ignore \ test1.exp\ test2.exp\ ...
  55 Do not run the specified tests.
  56 .TP
  57 .BI --mail \ \'name1\ name2\ ...\'
  58 Electronic mail addresses to receive test results.
  59 .TP
  60 .BI --name \ hostname
  61 The network hostname of the target board.
  62 .TP
  63 .BI --objdir \ path
  64 \fIpath\fR is a directory containing compiled test code.
  65 .TP
  66 .BI --outdir \ directory
  67 The name of a directory for test log output.
  68 .TP
  69 .B --reboot
  70 Reboot the target board when \fBruntest\fR initializes
  71 (if supported).
  72 .TP
  73 .BI --srcdir \ path
  74 \fIpath\fR is a directory containing test directories.
  75 .TP
  76 .BI --strace \ N
  77 Turns on
  78 .B expect
  79 internal tracing to \fIN\fR levels deep.
  80 .TP
  81 .BI --target \ type
  82 The configuration string for the target.
  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 .B --verbose,\ -v
  89 Turns on more debugging output from test cases and DejaGnu utility code.
  90 Use more than once to increase output further.
  91 .TP
  92 .B --version,\ -V
  93 Prints out the versions of DejaGnu, expect and Tcl.
  94 .TP
  95 .B -D[number]
  96 Activate the Tcl debugger.\fBnumber\fR can be either 1 or 0. If it is
  97 1, then the expect shell will break when it starts to run. All ^C's
  98 drop DejaGnu back to the debugger prompt. A 0 starts DejaGnu like
  99 normal, but a ^C drops to the debugger prompt.
 100 .TP 0
 101 Any file name on the command line is assumed to be a subset
 102 of the test names to run.  Usually these are the names of the
 103 expect test driver, ie... special.exp.
 104
 105 Makefile style variables are used to specify tool names and their
 106 flags; these and other configuration dependent values are saved in the
 107 file \fBsite.exp\fR, created during configuration.
 108 .SH EXIT CODES
 109 .B runtest
 110 sets the exit code to 1 if any of the tests failed, or
 111 sets it to 0 if all the tests passed.
 112 .SH SEE ALSO
 113 .I The DejaGnu Testing Framework
 114 .RB ( dejagnu.info ).
 115 This is the DejaGnu manual; its source is the SGML files
 116 .B
 117 doc/*.sgml.
 118 in the DejaGnu distribution.
 119 .SH AUTHOR
 120 Rob Savoye (rob@welcomehome.org)