.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH RUNLIM 1 "February 11, 2011"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
runlim \- a program to run benchmarks
.SH SYNOPSIS
.B runlim
[\fI options \fR ...] \fI command \fR [\fI arguments \fR ...]
.SH DESCRIPTION
.B run
is a tool that can be used to run and control benchmarks.
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" respectively.
It executes a given \fIcommand\fR with (optional) \fIarguments\fR,
samples resource usage during the run, and kills the process (and its
child processes) if a certain time and/or space limit is exhausted.
.PP
Every 100 milliseconds, \fBrunlim\fP takes a sample of the program's
resource utilization, and logs status information to stderr every
second. Optionally, the status can be logged to a file.
.PP
Multi-threaded programs can be limited by setting a wall clock
timeout.  \fBrunlim\fP follows the time accumulation scheme of \fBGNU
time\fP for multi-threaded programs and programs that spawn multiple
child-processes: time spent in each thread/child is summed up, unless
you are only interested in walk clock time.
.SH OPTIONS
\fBrunlim\fP accepts the following options:
.TP
.B \-h, \-\-help
Show summary of options.
.TP
.B \-\-version
Show version of program.
.TP
.B -o FILE, \-\-output-file=FILE
Overwrite or create FILE for output logging.
.TP
.B -s NUM, \-\-space-limit=NUM
Set space limit to NUM megabytes.
.TP
.B -t NUM, \-\-time-limit=NUM
Set time limit to NUM seconds.
.TP
.B -r NUM, \-\-real-time-limit=NUM
Set real time limit to NUM seconds.
.TP
.B -k, \-\-kill
Propagate signals.
.SH SEE ALSO
.BR time (1),
.BR timelimit (1),
.BR timeout (1),
.BR time (7).
.br
.SH AUTHOR
runlim was written by Armin Biere and Toni Jussila.
.PP
This manual page was written by Thomas Krennwallner <tkren@kr.tuwien.ac.at>,
for the Debian project (and may be used by others).