diff options
Diffstat (limited to 'upstream/fedora-40/man1/timeout.1')
| -rw-r--r-- | upstream/fedora-40/man1/timeout.1 | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/upstream/fedora-40/man1/timeout.1 b/upstream/fedora-40/man1/timeout.1 new file mode 100644 index 00000000..70e27d5c --- /dev/null +++ b/upstream/fedora-40/man1/timeout.1 @@ -0,0 +1,99 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.5. +.TH TIMEOUT "1" "January 2024" "GNU coreutils 9.4" "User Commands" +.SH NAME +timeout \- run a command with a time limit +.SH SYNOPSIS +.B timeout +[\fI\,OPTION\/\fR] \fI\,DURATION COMMAND \/\fR[\fI\,ARG\/\fR]... +.br +.B timeout +[\fI\,OPTION\/\fR] +.SH DESCRIPTION +.\" Add any additional description here +.PP +Start COMMAND, and kill it if still running after DURATION. +.PP +Mandatory arguments to long options are mandatory for short options too. +.HP +\fB\-\-preserve\-status\fR +.IP +exit with the same status as COMMAND, even when the +.IP +command times out +.HP +\fB\-\-foreground\fR +.IP +when not running timeout directly from a shell prompt, +.IP +allow COMMAND to read from the TTY and get TTY signals; +in this mode, children of COMMAND will not be timed out +.HP +\fB\-k\fR, \fB\-\-kill\-after\fR=\fI\,DURATION\/\fR +.IP +also send a KILL signal if COMMAND is still running +.IP +this long after the initial signal was sent +.HP +\fB\-s\fR, \fB\-\-signal\fR=\fI\,SIGNAL\/\fR +.IP +specify the signal to be sent on timeout; +.IP +SIGNAL may be a name like 'HUP' or a number; +see 'kill \fB\-l\fR' for a list of signals +.TP +\fB\-v\fR, \fB\-\-verbose\fR +diagnose to stderr any signal sent upon timeout +.TP +\fB\-\-help\fR +display this help and exit +.TP +\fB\-\-version\fR +output version information and exit +.PP +DURATION is a floating point number with an optional suffix: +\&'s' for seconds (the default), 'm' for minutes, 'h' for hours or 'd' for days. +A duration of 0 disables the associated timeout. +.PP +Upon timeout, send the TERM signal to COMMAND, if no other SIGNAL specified. +The TERM signal kills any process that does not block or catch that signal. +It may be necessary to use the KILL signal, since this signal can't be caught. +.SS "Exit status:" +.TP +124 +if COMMAND times out, and \fB\-\-preserve\-status\fR is not specified +.TP +125 +if the timeout command itself fails +.TP +126 +if COMMAND is found but cannot be invoked +.TP +127 +if COMMAND cannot be found +.TP +137 +if COMMAND (or timeout itself) is sent the KILL (9) signal (128+9) +.TP +\- +the exit status of COMMAND otherwise +.SH BUGS +Some platforms don't currently support timeouts beyond the year 2038. +.SH AUTHOR +Written by Padraig Brady. +.SH "REPORTING BUGS" +GNU coreutils online help: <https://www.gnu.org/software/coreutils/> +.br +Report any translation bugs to <https://translationproject.org/team/> +.SH COPYRIGHT +Copyright \(co 2023 Free Software Foundation, Inc. +License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. +.br +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. +.SH "SEE ALSO" +\fBkill\fP(1) +.PP +.br +Full documentation <https://www.gnu.org/software/coreutils/timeout> +.br +or available locally via: info \(aq(coreutils) timeout invocation\(aq |