Debian Codegraph @

upstream/debian-trixie/man1/timeout.1

raw
1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.50.1.
2 .TH TIMEOUT "1" "June 2025" "GNU coreutils 9.7" "User Commands"
3 .SH NAME
4 timeout \- run a command with a time limit
5 .SH SYNOPSIS
6 .B timeout
7 [\fI\,OPTION\/\fR] \fI\,DURATION COMMAND \/\fR[\fI\,ARG\/\fR]...
8 .br
9 .B timeout
10 [\fI\,OPTION\/\fR]
11 .SH DESCRIPTION
12 .\" Add any additional description here
13 .PP
14 Start COMMAND, and kill it if still running after DURATION.
15 .PP
16 Mandatory arguments to long options are mandatory for short options too.
17 .HP
18 \fB\-f\fR, \fB\-\-foreground\fR
19 .IP
20 when not running timeout directly from a shell prompt,
21 allow COMMAND to read from the TTY and get TTY signals;
22 in this mode, children of COMMAND will not be timed out
23 .HP
24 \fB\-k\fR, \fB\-\-kill\-after\fR=\fI\,DURATION\/\fR
25 .IP
26 also send a KILL signal if COMMAND is still running
27 this long after the initial signal was sent
28 .HP
29 \fB\-p\fR, \fB\-\-preserve\-status\fR
30 .IP
31 exit with the same status as COMMAND,
32 even when the command times out
33 .HP
34 \fB\-s\fR, \fB\-\-signal\fR=\fI\,SIGNAL\/\fR
35 .IP
36 specify the signal to be sent on timeout;
37 SIGNAL may be a name like 'HUP' or a number;
38 see 'kill \fB\-l\fR' for a list of signals
39 .TP
40 \fB\-v\fR, \fB\-\-verbose\fR
41 diagnose to stderr any signal sent upon timeout
42 .TP
43 \fB\-\-help\fR
44 display this help and exit
45 .TP
46 \fB\-\-version\fR
47 output version information and exit
48 .PP
49 DURATION is a floating point number with an optional suffix:
50 \&'s' for seconds (the default), 'm' for minutes, 'h' for hours or 'd' for days.
51 A duration of 0 disables the associated timeout.
52 .PP
53 Upon timeout, send the TERM signal to COMMAND, if no other SIGNAL specified.
54 The TERM signal kills any process that does not block or catch that signal.
55 It may be necessary to use the KILL signal, since this signal can't be caught.
56 .SS "Exit status:"
57 .TP
58 124
59 if COMMAND times out, and \fB\-\-preserve\-status\fR is not specified
60 .TP
61 125
62 if the timeout command itself fails
63 .TP
64 126
65 if COMMAND is found but cannot be invoked
66 .TP
67 127
68 if COMMAND cannot be found
69 .TP
70 137
71 if COMMAND (or timeout itself) is sent the KILL (9) signal (128+9)
72 .TP
73 \-
74 the exit status of COMMAND otherwise
75 .SH BUGS
76 Some platforms don't currently support timeouts beyond the year 2038.
77 .SH AUTHOR
78 Written by Padraig Brady.
79 .SH "REPORTING BUGS"
80 GNU coreutils online help: <https://www.gnu.org/software/coreutils/>
81 .br
82 Report any translation bugs to <https://translationproject.org/team/>
83 .SH "SEE ALSO"
84 \fBkill\fP(1)
85 .PP
86 .br
87 Full documentation <https://www.gnu.org/software/coreutils/timeout>
88 .br
89 or available locally via: info \(aq(coreutils) timeout invocation\(aq
90 .PP
91 .br
92 Packaged by Debian (9.7\-3)
93 .br
94 Copyright \(co 2025 Free Software Foundation, Inc.
95 .br
96 License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
97 .br
98 This is free software: you are free to change and redistribute it.
99 .br
100 There is NO WARRANTY, to the extent permitted by law.