external/bsd/atf/dist/tools/atf-exec.1

   1 .\"
   2 .\" Automated Testing Framework (atf)
   3 .\"
   4 .\" Copyright (c) 2008 The NetBSD Foundation, Inc.
   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 NETBSD FOUNDATION, INC. AND
  17 .\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  18 .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  19 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20 .\" IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
  21 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  23 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  25 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  26 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  27 .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .Dd May 2, 2008
  30 .Dt ATF-EXEC 1
  31 .Os
  32 .Sh NAME
  33 .Nm atf-exec
  34 .Nd executes a command in a controlled manner
  35 .Sh SYNOPSIS
  36 .Nm
  37 .Op Fl t Ar secs:file
  38 .Ar command
  39 .Nm
  40 .Fl h
  41 .Sh DESCRIPTION
  42 .Nm
  43 is a wrapper that executes a given command in a controlled manner.
  44 At the moment, all it can do is set a timeout on the command and
  45 terminate it (and all of its children) if the timeout expires.
  46 .Pp
  47 In the first synopsis form,
  48 .Nm
  49 will execute the provided command and, unless any options are specified,
  50 the command is executed as if
  51 .Nm
  52 had not been used.
  53 If the
  54 .Fl t
  55 option is used,
  56 .Nm
  57 will forcibly terminate the command if a specified amount of time passes.
  58 The subprocesses are run on a different process group, so that the
  59 termination of the parent also causes the termination of all of its
  60 children.
  61 .Pp
  62 In the second synopsis form,
  63 .Nm
  64 will print information about all supported options and their purpose.
  65 .Pp
  66 The following options are available:
  67 .Bl -tag -width XtXsecsXfileXX
  68 .It Fl h
  69 Shows a short summary of all available options and their purpose.
  70 .It Fl t Ar secs:file
  71 Kills the child process after
  72 .Ar secs
  73 seconds unless it has voluntarily finished before this amount of time
  74 has passed.
  75 If the time runs out, the control file
  76 .Ar file
  77 is created and an error code is returned.
  78 .El
  79 .Sh SEE ALSO
  80 .Xr atf 7