1.\" $OpenBSD: timeout.1,v 1.4 2022/12/22 19:53:23 kn Exp $ 2.\" $NetBSD: timeout.1,v 1.4 2016/10/13 06:22:26 dholland Exp $ 3.\" 4.\" Copyright (c) 2014 Baptiste Daroussin <bapt@FreeBSD.org> 5.\" All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 1. Redistributions of source code must retain the above copyright 11.\" notice, this list of conditions and the following disclaimer. 12.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" notice, this list of conditions and the following disclaimer in the 14.\" documentation and/or other materials provided with the distribution. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.\" $FreeBSD: head/usr.bin/timeout/timeout.1 268861 2014-07-18 22:56:59Z bapt $ 29.\" 30.Dd $Mdocdate: December 22 2022 $ 31.Dt TIMEOUT 1 32.Os 33.Sh NAME 34.Nm timeout 35.Nd run a command with a time limit 36.Sh SYNOPSIS 37.Nm 38.Op Fl k Ar time 39.Op Fl s Ar sig 40.Op Fl -foreground 41.Op Fl -preserve-status 42.Ar duration 43.Ar command 44.Op Ar arg ... 45.Sh DESCRIPTION 46The 47.Nm 48utility executes 49.Ar command 50and kills it if it is still running after the 51specified 52.Ar duration . 53If 54.Ar duration 55is 0, the timeout is disabled. 56.Pp 57The options are as follows: 58.Bl -tag -width Ds 59.It Fl k Ar time , Fl -kill-after Ns = Ns Ar time 60Send a second signal, 61.Dv SIGKILL , 62if the command is still running 63.Ar time 64after the first signal was sent. 65.It Fl s Ar sig , Fl -signal Ns = Ns Ar sig 66Specify the signal to send on timeout, instead of the default 67.Dv SIGTERM . 68.It Fl -foreground 69Do not propagate the timeout signal to children processes. 70.It Fl -preserve-status 71Always exit with the same status as 72.Ar command , 73even if the timeout was reached. 74.El 75.Sh DURATION FORMAT 76.Ar duration 77and 78.Ar time 79may contain a decimal fraction. 80The value defaults to seconds unless a unit suffix is given. 81.Pp 82The supported unit suffixes are: 83.Pp 84.Bl -tag -width Ds -offset indent -compact 85.It s 86seconds 87.It m 88minutes 89.It h 90hours 91.It d 92days 93.El 94.Sh EXIT STATUS 95If the timeout was not reached or 96.Fl -preserve-status 97was set, the exit status of 98.Ar command 99is returned. 100.Pp 101If the timeout was reached and 102.Fl -preserve-status 103was not set, an exit status of 124 is returned. 104.Pp 105If 106.Ar command 107exited after receiving a signal, the exit status returned is the signal number 108plus 128. 109.Sh SEE ALSO 110.Xr kill 1 , 111.Xr signal 3 112.Sh HISTORY 113The 114.Nm 115utility first appeared in GNU Coreutils 7.0 and has been available since 116.Ox 7.0 . 117