summaryrefslogtreecommitdiffstats
path: root/doc/time.n
diff options
context:
space:
mode:
Diffstat (limited to 'doc/time.n')
-rw-r--r--doc/time.n11
1 files changed, 7 insertions, 4 deletions
diff --git a/doc/time.n b/doc/time.n
index b734c6a..35b41c4 100644
--- a/doc/time.n
+++ b/doc/time.n
@@ -14,21 +14,23 @@ time \- Time the execution of a script
.SH SYNOPSIS
\fBtime \fIscript\fR ?\fIcount\fR?
.BE
-
.SH DESCRIPTION
.PP
This command will call the Tcl interpreter \fIcount\fR
times to evaluate \fIscript\fR (or once if \fIcount\fR is not
specified). It will then return a string of the form
+.PP
.CS
-\fB503 microseconds per iteration\fR
+\fB503.2 microseconds per iteration\fR
.CE
+.PP
which indicates the average amount of time required per iteration,
in microseconds.
Time is measured in elapsed time, not CPU time.
.SH EXAMPLE
Estimate how long it takes for a simple Tcl \fBfor\fR loop to count to
a thousand:
+.PP
.CS
time {
for {set i 0} {$i<1000} {incr i} {
@@ -36,9 +38,10 @@ time {
}
}
.CE
-
.SH "SEE ALSO"
clock(n)
-
.SH KEYWORDS
script, time
+.\" Local Variables:
+.\" mode: nroff
+.\" End: