original/man1/timeout.1

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.3.
   2 .TH TIMEOUT "1" "January 2016" "GNU coreutils 8.25" "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\-\-preserve\-status\fR
  19 .IP
  20 exit with the same status as COMMAND, even when the
  21 .IP
  22 command times out
  23 .HP
  24 \fB\-\-foreground\fR
  25 .IP
  26 when not running timeout directly from a shell prompt,
  27 .IP
  28 allow COMMAND to read from the TTY and get TTY signals;
  29 in this mode, children of COMMAND will not be timed out
  30 .HP
  31 \fB\-k\fR, \fB\-\-kill\-after\fR=\fI\,DURATION\/\fR
  32 .IP
  33 also send a KILL signal if COMMAND is still running
  34 .IP
  35 this long after the initial signal was sent
  36 .HP
  37 \fB\-s\fR, \fB\-\-signal\fR=\fI\,SIGNAL\/\fR
  38 .IP
  39 specify the signal to be sent on timeout;
  40 .IP
  41 SIGNAL may be a name like 'HUP' or a number;
  42 see 'kill \fB\-l\fR' for a list of signals
  43 .TP
  44 \fB\-\-help\fR
  45 display this help and exit
  46 .TP
  47 \fB\-\-version\fR
  48 output version information and exit
  49 .PP
  50 DURATION is a floating point number with an optional suffix:
  51 \&'s' for seconds (the default), 'm' for minutes, 'h' for hours or 'd' for days.
  52 .PP
  53 If the command times out, and \fB\-\-preserve\-status\fR is not set, then exit with
  54 status 124.  Otherwise, exit with the status of COMMAND.  If no signal
  55 is specified, send the TERM signal upon timeout.  The TERM signal kills
  56 any process that does not block or catch that signal.  It may be necessary
  57 to use the KILL (9) signal, since this signal cannot be caught, in which
  58 case the exit status is 128+9 rather than 124.
  59 .SH BUGS
  60 Some platforms don't curently support timeouts beyond the year 2038.
  61 .SH AUTHOR
  62 Written by Padraig Brady.
  63 .SH "REPORTING BUGS"
  64 GNU coreutils online help: <http://www.gnu.org/software/coreutils/>
  65 .br
  66 Report timeout translation bugs to <http://translationproject.org/team/>
  67 .SH COPYRIGHT
  68 Copyright \(co 2016 Free Software Foundation, Inc.
  69 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
  70 .br
  71 This is free software: you are free to change and redistribute it.
  72 There is NO WARRANTY, to the extent permitted by law.
  73 .SH "SEE ALSO"
  74 kill(1)
  75 .PP
  76 .br
  77 Full documentation at: <http://www.gnu.org/software/coreutils/timeout>
  78 .br
  79 or available locally via: info \(aq(coreutils) timeout invocation\(aq