diff options
author | Ben Elliston <bje@gnu.org> | 2005-12-23 12:07:22 +0000 |
---|---|---|
committer | Ben Elliston <bje@gnu.org> | 2005-12-23 12:07:22 +0000 |
commit | 2cc41b2497c06224ad177d7b389c4d9d8d793ada (patch) | |
tree | 6c6e6f71ddc25ba530dbbe3e25e134b1259db63d | |
parent | 24cf779ec612dcdb8c878f66fc37abfd2cf45824 (diff) | |
download | dejagnu-2cc41b2497c06224ad177d7b389c4d9d8d793ada.zip dejagnu-2cc41b2497c06224ad177d7b389c4d9d8d793ada.tar.gz dejagnu-2cc41b2497c06224ad177d7b389c4d9d8d793ada.tar.bz2 |
* doc/runtest.1: Update manual page.
-rw-r--r-- | ChangeLog | 4 | ||||
-rw-r--r-- | doc/runtest.1 | 124 |
2 files changed, 74 insertions, 54 deletions
@@ -1,5 +1,9 @@ 2005-12-23 Ben Elliston <bje@gnu.org> + * doc/runtest.1: Update manual page. + +2005-12-23 Ben Elliston <bje@gnu.org> + * doc/overview.sgml: Remove in favour of XML versions. * doc/ref.sgml: Ditto. * doc/user.sgml: Ditto. diff --git a/doc/runtest.1 b/doc/runtest.1 index 09e7a45..b787bba 100644 --- a/doc/runtest.1 +++ b/doc/runtest.1 @@ -1,52 +1,42 @@ -.TH runtest 1 "2004-02-09" +.TH runtest 1 "2005-12-23" .SH NAME -runtest \- the DejaGnu test driver program +runtest \- DejaGnu test driver .SH SYNOPSIS .B runtest -[ options ] +[OPTION]... .SH DESCRIPTION .I DejaGnu -is a framework for running testsuites. It is written in Expect, which -in turn uses Tcl, the Tool command language. +is a framework for testing programs using Expect. .B runtest -is the test driver program; use it to control what tests to run, and -variations on how to run them. -You can find a comprehensive description of DejaGnu and \fBruntest\fR in -.I -The DejaGnu Testing Framework -or its Info version, -.BR dejagnu.info . +is the driver program for +.I DejaGnu. +It controls what tests to run and how to run them. .SH OPTIONS .TP .B --all -Print all test output to screen. By default, only unexpected results are +Output all test results. By default, only unexpected results are displayed. .TP -.BI --baud \ rate -Set the baud rate for a serial line connection. Some serial interface -programs (like \fBtip\fR) don't use this value but instead use a separate -initialization file. -.TP -.BI --connect \ type -The type of connection to use. The supported types are -.BR rlogin , -.BR telnet , -.BR rsh , -.BR kermit -and -.BR tip . -.TP .B --debug Turn on .B expect internal debugging output. The output is logged to a file called \fBdbg.out\fR. .TP +.BI --build \ TRIPLET +The configuration TRIPLET for the build system. +.TP +.BI --directory \ DIRECTORY +Run only tests in the specified DIRECTORY. +.TP .B --help Prints out a help screen and then exits. .TP -.BI --host \ type -The configuration string for the host. +.BI --host \ TRIPLET +The configuration TRIPLET for the host system. +.TP +.BI --host_board \ NAME +The host board defintion to use. .TP .BI --ignore \ test1.exp\ test2.exp\ ... Do not run the specified tests. @@ -54,21 +44,24 @@ Do not run the specified tests. .BI --mail \ \'name1\ name2\ ...\' Electronic mail addresses to receive test results. .TP -.BI --name \ hostname -The network hostname of the target board. +.BI --name \ HOSTNAME +The network HOSTNAME of the target board. .TP -.BI --objdir \ path -\fIpath\fR is a directory containing compiled test code. +.BI --objdir \ PATH +\fIPATH\fR is a directory containing compiled test code. .TP -.BI --outdir \ directory -The name of a directory for test log output. +.BI --outdir \ DIRECTORY +The name of a DIRECTORY for test log output. .TP .B --reboot Reboot the target board when \fBruntest\fR initializes (if supported). .TP -.BI --srcdir \ path -\fIpath\fR is a directory containing test directories. +.BI --srcdir \ PATH +\fIPATH\fR is a directory containing test directories. +.TP +.BI --status +Set the exit status to fail on Tcl errors. .TP .BI --strace \ N Turns on @@ -76,29 +69,41 @@ Turns on internal tracing to \fIN\fR levels deep. The output is logged to a file called \fBdbg.out\fR. .TP -.BI --target \ type -The configuration string for the target. +.BI --target \ TRIPLET +The configuration TRIPLET for the target. +.TP +.BI --target_board \ NAME +A list of target board NAMEs to run tests on. .TP -.BI --tool \ toolname -Specify the tool to be tested. \fItoolname\fR controls the test suite +.BI --tool \ TOOLNAME +Specify the tool to be tested. \fITOOLNAME\fR controls the test suite applied, and the associated initialization module. .TP +.BI --tool_exec \ PATH +Specify the PATH to the executable to test. +.TP +.BI --tool_opts \ OPTIONS +Additional OPTIONS to pass to the tool. +.TP .B --verbose,\ -v Turns on more debugging output from test cases and DejaGnu utility code. Use more than once to increase output further. .TP .B --version,\ -V -Prints out the versions of DejaGnu, expect and Tcl. +Prints out the versions of DejaGnu, Expect and Tcl. +.TP +.B --xml,\ -x +Generate XML output. .TP .B -D[number] -Activate the Tcl debugger.\fBnumber\fR can be either 1 or 0. If it is -1, then the expect shell will break when it starts to run. All ^C's -drop DejaGnu back to the debugger prompt. A 0 starts DejaGnu like -normal, but a ^C drops to the debugger prompt. +Activate the Tcl debugger. \fBnumber\fR can be either 1 or 0. If it +is 1, then the expect shell will break when it starts to run. The +interrupt key will cause DejaGnu to drop to the debugger prompt. If it +is 0, DejaGnu starts as usual, but a ^C drops to the debugger prompt. .TP 0 Any file name on the command line is assumed to be a subset of the test names to run. Usually these are the names of the -expect test driver, ie... special.exp. +test scripts (eg. foo.exp). Makefile-style variables are used to specify tool names and their flags; these and other configuration dependent values are saved in the @@ -107,12 +112,23 @@ file \fBsite.exp\fR, created during configuration. .B runtest sets the exit code to 1 if any of the tests failed, or sets it to 0 if all the tests passed. -.SH SEE ALSO -.I The DejaGnu Testing Framework -.RB ( dejagnu.info ). -This is the DejaGnu manual; its source is the SGML files -.B -doc/*.sgml. -in the DejaGnu distribution. .SH AUTHOR Rob Savoye (rob@welcomehome.org) +.SH "REPORTING BUGS" +Report bugs to <bug\-dejagnu@gnu.org>. +.SH COPYRIGHT +Copyright \(co 2005 Free Software Foundation, Inc. +.br +This is free software. You may redistribute copies of it under the terms of +the GNU General Public License <http://www.gnu.org/licenses/gpl.html>. +There is NO WARRANTY, to the extent permitted by law. +.SH "SEE ALSO" +The full documentation for +.B DejaGnu +is maintained as a Docbook manual. If the +.B info +program is properly installed at your site, the command +.IP +.B info dejagnu +.PP +should give you access to the complete manual. |