external/bsd/bind/dist/unit/atf-src/atf-sh/atf-sh.1

   1 .\"     $NetBSD: atf-sh.1,v 1.1.1.3 2014/12/10 03:34:48 christos Exp $
   2 .\"
   3 .\"
   4 .\" Automated Testing Framework (atf)
   5 .\"
   6 .\" Copyright (c) 2010 The NetBSD Foundation, Inc.
   7 .\" All rights reserved.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
  19 .\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  20 .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  21 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  22 .\" IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
  23 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  25 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  27 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  28 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  29 .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .Dd May 9, 2010
  32 .Dt ATF-SH 1
  33 .Os
  34 .Sh NAME
  35 .Nm atf-sh
  36 .Nd interpreter for shell-based test programs
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Ar script
  40 .Nm
  41 .Fl h
  42 .Sh DESCRIPTION
  43 .Nm
  44 is an interpreter that runs the test program given in
  45 .Ar script
  46 after loading the
  47 .Xr atf-sh-api 3
  48 library.
  49 .Pp
  50 .Nm
  51 is not a real interpreter though: it is just a wrapper around
  52 the system-wide shell defined by the
  53 .Sq atf_shell
  54 configuration value in
  55 .Xr atf-config 1 .
  56 .Nm
  57 executes the interpreter, loads the
  58 .Xr atf-sh-api 3
  59 library and then runs the script.
  60 .Pp
  61 Scripts using
  62 .Xr atf-sh-api 3
  63 should start with:
  64 .Bd -literal -offset indent
  65 #! /usr/bin/env atf-sh
  66 .Ed
  67 .Pp
  68 The following options are available:
  69 .Bl -tag -width XhXX
  70 .It Fl h
  71 Shows a short summary of all available options and their purpose.
  72 For those formats that write to a single file, specifying a
  73 .Sq -
  74 as the path will redirect the report to the standard output.
  75 .El
  76 .Sh SEE ALSO
  77 .Xr atf-config 1 ,
  78 .Xr atf-sh-api 3 ,
  79 .Xr atf 7