1 .\" Copyright (c) 2014 Baptiste Daroussin <bapt@FreeBSD.org>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd run a command with a time limit
35 .Op Fl -signal Ar sig | Fl s Ar sig
36 .Op Fl -preserve-status
37 .Op Fl -kill-after Ar time | Fl k Ar time
50 is still running after
56 .Bl -tag -width "-k time, --kill-after time"
57 .It Fl -preserve-status
58 Always exits with the same status as
62 Do not propagate timeout to the
65 .It Fl s Ar sig , Fl -signal Ar sig
66 Specify the signal to send on timeout.
70 .It Fl k Ar time , Fl -kill-after Ar time
71 Send a second kill signal if
73 is still running after
75 after the first signal was sent.
81 can be integer or decimal numbers.
82 Values without unit symbols are interpreted as seconds.
84 Supported unit symbols are:
85 .Bl -tag -width indent -compact
96 If the timeout was not reached, the exit status of
100 If the timeout was reached and
102 is set, the exit status of
107 is not set, an exit status of 124 is returned.
111 exits after receiving a signal, the exit status returned is the signal number
116 is an invalid command, the exit status returned is 126.
120 is a non existing command, the exit status returned is 127.
122 If an invalid parameter is passed to
126 the exit status return is 125.