docs: Fix `*' in manpage to `@'

[autopkgtest.git] / runner / adt-run.1

diff --git a/runner/adt-run.1 b/runner/adt-run.1
index fda5fd683fa16c2787ae6d5f942e07133667bbdd..e40bf98f50403fb44ecd3c2ac79dfe5c9076084e 100644 (file)
--- 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.
@@ -135,7 +135,8 @@ 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
@@ -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