diff options
| -rw-r--r-- | doc/timerate.n | 11 |
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 |