X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=runner%2Fadt-run.1;h=2704728d4d110bd9b2b1db81403fe229dc7c867e;hb=629e736487dd1f47503472b3fe1e5e779d7e2357;hp=b65bd283a7962cf694eb28161ff1ddea51764bd7;hpb=79dac374de98493135cee65f9957ec8ffeade88a;p=autopkgtest.git

diff --git a/runner/adt-run.1 b/runner/adt-run.1
index b65bd28..2704728 100644
--- a/runner/adt-run.1
+++ b/runner/adt-run.1
@@ -31,7 +31,7 @@ host.  The package should be installed on the testbed.
 Specifies that tests from the built source tree
 .IR directory
 should be run.  Note that the packages that would normally be
-installed as a result of \fB*\fR in the tests' \fBDepends\fR field
+installed as a result of \fB@\fR in the tests' \fBDepends\fR field
 (which includes the case where the \fBDepends\fR field is not
 specified) are \fInot\fR installed.  The caller must explicitly
 instruct \fBadt-run\fR to install any relevant packages.
@@ -121,7 +121,7 @@ and
 for the log transcript.  If no \fIoutput-dir\fR is specified, or the
 path is specified to be on the testbed (ie, if \fB--output-dir\fR
 follows \fB--paths-testbed\fR), then the \fBlog\fR file is instead
-written to the temporary directory \fItmpdir\fR if one was specified,
+written to the temporary directory \fItmp\fR if one was specified,
 or otherwise no separate copy is made.  Note that the log transcript
 output will also be sent to \fBadt-run\fR's stderr unless
 \fB--quiet\fR is specified.
@@ -135,22 +135,23 @@ tests run as whatever user is provided.
 Prefixes
 .B debian/rules binary
 with
-.RB gain-root .  The default is not to use anything, except that if
+.RB gain-root .
+The default is not to use anything, except that if
 \fB--user\fR is supplied or root on the testbed is not available the
 default is \fBfakeroot\fR.
 .TP
-.BI --tmp-dir= tmpdir
-Specifies that \fItmpdir\fR should be used instead of a fresh
-temporary directory on the host.  \fItmpdir\fR will be created if
+.BI --tmp-dir= tmp
+Specifies that \fItmp\fR should be used instead of a fresh
+temporary directory on the host.  \fItmp\fR will be created if
 necessary, and emptied of all of its contents before \fBadt-run\fR
-starts, and it will not be cleaned out afterwards.  \fItmpdir\fR is
+starts, and it will not be cleaned out afterwards.  \fItmp\fR is
 not affected by \fB--paths-testbed\fR.
 .B NOTE
-again that all of the contents of \fItmpdir\fR will be \fBdeleted\fR.
+again that all of the contents of \fItmp\fR will be \fBdeleted\fR.
 .TP
 .BI --log-file= logfile
 Specifies that the trace log should be written to \fIlogfile\fR
-instead of to \fBlog\fR in \fIoutput-dir\fR or \fItmpdir\fR.
+instead of to \fBlog\fR in \fIoutput-dir\fR or \fItmp\fR.
 \fIlog-file\fR is not affected by \fB--paths-testbed\fR.
 .TP
 .BI --summary= summary
@@ -159,6 +160,27 @@ Specifies that a summary of the outcome should be written to
 in any case.
 \fIsummary\fR is not affected by \fB--paths-testbed\fR.
 .TP
+.BR --timeout- \fIwhich\fR = \fIseconds\fR
+Use a different timeout for operations on or with the testbed.  There
+are four timeouts affected by four values of \fIwhich\fR:
+.BR short :
+supposedly
+short operations like setting up the testbed's apt and checking the
+state (default: 100s);
+.BR install :
+installation of packages including dependencies
+(default: 3ks);
+.BR test :
+test runs (default: 10ks); and
+.BR build :
+builds (default:
+100ks).  The value must be specified as an integer number of seconds.
+.TP
+.BR --timeout-factor =\fIdouble\fR
+Multiply all of the default timeouts by the specified factor (see
+\fB--timeout-\fR\fIwhich\fR above).  Only the defaults are affected;
+explicit timeout settings are used exactly as specified.
+.TP
 .BR --debug | -d
 Include additional debugging information in the trace log.  Each
 additional \fB-d\fR increases the debugging level; the current maximum
@@ -181,7 +203,7 @@ quantities of high-quality entropy.
 .BR -q " | " --quiet
 Do not send a copy of \fBadt-run\fR's trace logstream to stderr.  This
 option does not affect the copy sent to \fIlogfile\fR,
-\fIoutput-dir\fR or \fItmpdir\fR.  Note that without the trace
+\fIoutput-dir\fR or \fItmp\fR.  Note that without the trace
 logstream it can be very hard to diagnose problems.
 .TP
 \fB---\fR \fIvirt-server virt-server-arg\fR...
@@ -189,6 +211,16 @@ Specifies the virtualisation regime server, as a command and arguments
 to invoke.  All the remaining arguments and options after
 .B ---
 are passed to the virtualisation server program.
+.TP
+.BI --set-lang= langval
+When running commands on the testbed, sets the \fBLANG\fR environment
+variable to \fIlangval\fR.  The default in \fBadt-run\fR is to set it
+to \fBC\fR.
+.TP
+.BI --leave-lang
+Suppresses the setting by \fBadt-run\fR of \fBLANG\fR on the testbed.
+This results in tests and builds using the testbed's own normal
+\fBLANG\fR value setting.
 
 .SH OUTPUT FORMAT
 During a normal test run, one line is printed for each test.  This