usr.bin/timeout/timeout.1

   1 .\" Copyright (c) 2014 Baptiste Daroussin <bapt@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   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.
  12 .\"
  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
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd July 16, 2014
  28 .Dt TIMEOUT 1
  29 .Os
  30 .Sh NAME
  31 .Nm timeout
  32 .Nd run a command with a time limit
  33 .Sh SYNOPSIS
  34 .Nm
  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
  38 .Op Fl -foreground
  39 .Ao Ar duration Ac
  40 .Ao Ar command Ac
  41 .Ao Ar args ... Ac
  42 .Sh DESCRIPTION
  43 .Nm
  44 starts the
  45 .Ar command
  46 with its
  47 .Ar args
  48 and kills if it is still runs after
  49 .Ar duration .
  50 .Bl -tag -width "-k time, --kill-after time"
  51 .It Fl -preserve-status
  52 Always exits with the same status as
  53 .Ar command
  54 even if it times out.
  55 .It Fl -foreground
  56 Do not propagate timeout to the
  57 .Ar command
  58 children.
  59 .It Fl s Ar sig , Fl -signal Ar sig
  60 Speficy the signal to send on timeout by default
  61 .Ar SIGTERM .
  62 .It Fl k Ar time , Fl -kill-after Ar time
  63 Send a second kill if the
  64 .Ar command
  65 is still running after
  66 .Ar time
  67 seconds after the first signal was sent
  68 .Sh SEE ALSO
  69 .Xr signal 3 ,
  70 .Xr kill 1