2014-07-16 11:55:36 +02:00
|
|
|
.\" Copyright (c) 2014 Baptiste Daroussin <bapt@FreeBSD.org>
|
|
|
|
|
.\" All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
|
.\"
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
|
.\"
|
|
|
|
|
.\" $FreeBSD$
|
|
|
|
|
.\"
|
2014-10-28 11:33:31 +01:00
|
|
|
.Dd Oct 28, 2014
|
2014-07-16 11:55:36 +02:00
|
|
|
.Dt TIMEOUT 1
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm timeout
|
|
|
|
|
.Nd run a command with a time limit
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.Nm
|
|
|
|
|
.Op Fl -signal Ar sig | Fl s Ar sig
|
|
|
|
|
.Op Fl -preserve-status
|
|
|
|
|
.Op Fl -kill-after Ar time | Fl k Ar time
|
|
|
|
|
.Op Fl -foreground
|
|
|
|
|
.Ao Ar duration Ac
|
|
|
|
|
.Ao Ar command Ac
|
|
|
|
|
.Ao Ar args ... Ac
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
.Nm
|
|
|
|
|
starts the
|
|
|
|
|
.Ar command
|
|
|
|
|
with its
|
2014-07-19 00:56:59 +02:00
|
|
|
.Ar args.
|
|
|
|
|
If
|
|
|
|
|
.Ar command
|
|
|
|
|
is still running after
|
|
|
|
|
.Ar duration ,
|
|
|
|
|
it is killed.
|
|
|
|
|
By default,
|
|
|
|
|
.Ar SIGTERM.
|
|
|
|
|
is sent.
|
2014-07-16 11:55:36 +02:00
|
|
|
.Bl -tag -width "-k time, --kill-after time"
|
|
|
|
|
.It Fl -preserve-status
|
2014-07-16 13:30:04 +02:00
|
|
|
Always exits with the same status as
|
2014-07-16 11:55:36 +02:00
|
|
|
.Ar command
|
|
|
|
|
even if it times out.
|
|
|
|
|
.It Fl -foreground
|
|
|
|
|
Do not propagate timeout to the
|
|
|
|
|
.Ar command
|
|
|
|
|
children.
|
|
|
|
|
.It Fl s Ar sig , Fl -signal Ar sig
|
2014-07-19 00:56:59 +02:00
|
|
|
Specify the signal to send on timeout.
|
|
|
|
|
By default,
|
2014-07-16 11:55:36 +02:00
|
|
|
.Ar SIGTERM .
|
2014-07-19 00:56:59 +02:00
|
|
|
is sent.
|
2014-07-16 11:55:36 +02:00
|
|
|
.It Fl k Ar time , Fl -kill-after Ar time
|
2014-07-19 00:56:59 +02:00
|
|
|
Send a second kill signal if
|
2014-07-16 11:55:36 +02:00
|
|
|
.Ar command
|
|
|
|
|
is still running after
|
|
|
|
|
.Ar time
|
2014-07-19 00:56:59 +02:00
|
|
|
after the first signal was sent.
|
|
|
|
|
.El
|
|
|
|
|
.Sh DURATION FORMAT
|
|
|
|
|
.Ar duration
|
|
|
|
|
and
|
|
|
|
|
.Ar time
|
|
|
|
|
can be integer or decimal numbers.
|
|
|
|
|
Values without unit symbols are interpreted as seconds.
|
|
|
|
|
.Pp
|
|
|
|
|
Supported unit symbols are:
|
|
|
|
|
.Bl -tag -width indent -compact
|
|
|
|
|
.It s
|
|
|
|
|
seconds
|
|
|
|
|
.It m
|
|
|
|
|
minutes
|
|
|
|
|
.It h
|
|
|
|
|
hours
|
|
|
|
|
.It d
|
|
|
|
|
days
|
|
|
|
|
.El
|
|
|
|
|
.Sh EXIT STATUS
|
|
|
|
|
If the timeout was not reached, the exit status of
|
|
|
|
|
.Ar command
|
|
|
|
|
is returned.
|
|
|
|
|
.Pp
|
|
|
|
|
If the timeout was reached and
|
|
|
|
|
.Fl -preserve-status
|
|
|
|
|
is set, the exit status of
|
|
|
|
|
.Ar command
|
|
|
|
|
is returned.
|
|
|
|
|
If
|
|
|
|
|
.Fl -preserve-status
|
|
|
|
|
is not set, an exit status of 124 is returned.
|
|
|
|
|
.Pp
|
|
|
|
|
If
|
|
|
|
|
.Ar command
|
2014-10-28 11:33:31 +01:00
|
|
|
exits after receiving a signal, the exit status returned is the signal number
|
|
|
|
|
plus 128.
|
|
|
|
|
.Pp
|
|
|
|
|
If
|
|
|
|
|
.Ar command
|
|
|
|
|
is an invalid command, the exit status returned is 126.
|
|
|
|
|
.Pp
|
|
|
|
|
If
|
|
|
|
|
.Ar command
|
|
|
|
|
is a non existing command, the exit status returned is 127.
|
|
|
|
|
.Pp
|
|
|
|
|
If an invalid parameter is passed to
|
|
|
|
|
.Fl s
|
|
|
|
|
or
|
|
|
|
|
.Fl k ,
|
|
|
|
|
the exit status return is 125.
|
2014-07-16 11:55:36 +02:00
|
|
|
.Sh SEE ALSO
|
2014-07-19 00:56:59 +02:00
|
|
|
.Xr kill 1 ,
|
|
|
|
|
.Xr signal 3
|
