summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorsebres <sebres@users.sourceforge.net>2019-02-13 01:22:07 (GMT)
committersebres <sebres@users.sourceforge.net>2019-02-13 01:22:07 (GMT)
commit963cceee572b9eb7fca08a7401a07a5263f5dc40 (patch)
treebc8fab0a4e6bfc1062bf3d2501b9b441a290d992
parent5add43aac85a1d21f7b0ee6b9c9f43eb0a747918 (diff)
downloadtcl-963cceee572b9eb7fca08a7401a07a5263f5dc40.zip
tcl-963cceee572b9eb7fca08a7401a07a5263f5dc40.tar.gz
tcl-963cceee572b9eb7fca08a7401a07a5263f5dc40.tar.bz2
timerate documentation extended
-rw-r--r--doc/timerate.n11
1 files changed, 7 insertions, 4 deletions
diff --git a/doc/timerate.n b/doc/timerate.n
index df9a8f7..2380597 100644
--- a/doc/timerate.n
+++ b/doc/timerate.n
@@ -11,17 +11,20 @@
.SH NAME
timerate \- Time-related execution resp. performance measurement of a script
.SH SYNOPSIS
-\fBtimerate \fIscript\fR \fI?time?\fR
+\fBtimerate \fIscript\fR \fI?time ?max-count??\fR
.sp
-\fBtimerate \fI?-direct?\fR \fI?-overhead double?\fR \fIscript\fR \fI?time?\fR
+\fBtimerate \fI?-direct?\fR \fI?-overhead double?\fR \fIscript\fR \fI?time ?max-count??\fR
.sp
-\fBtimerate \fI?-calibrate?\fR \fI?-direct?\fR \fIscript\fR \fI?time?\fR
+\fBtimerate \fI?-calibrate?\fR \fI?-direct?\fR \fIscript\fR \fI?time ?max-count??\fR
.BE
.SH DESCRIPTION
.PP
The first and second form will evaluate \fIscript\fR until the interval
\fItime\fR given in milliseconds elapses, or for 1000 milliseconds (1 second)
-if \fItime\fR is not specified.
+if \fItime\fR is not specified.
+.sp
+If \fImax-count\fR is specified, it imposes a further restriction by the maximal
+number of iterations.
.sp
It will then return a canonical tcl-list of the form
.PP