1.\" 2.\" Automated Testing Framework (atf) 3.\" 4.\" Copyright (c) 2010 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 March 2, 2014 30.Dt ATF-SH 1 31.Os 32.Sh NAME 33.Nm atf-sh 34.Nd interpreter for shell-based test programs 35.Sh SYNOPSIS 36.Nm 37.Ar script 38.Nm 39.Fl h 40.Sh DESCRIPTION 41.Nm 42is an interpreter that runs the test program given in 43.Ar script 44after loading the 45.Xr atf-sh-api 3 46library. 47.Pp 48.Nm 49is not a real interpreter though: it is just a wrapper around 50the system-wide shell defined by 51.Va ATF_SHELL . 52.Nm 53executes the interpreter, loads the 54.Xr atf-sh-api 3 55library and then runs the script. 56.Pp 57Scripts using 58.Xr atf-sh-api 3 59should start with: 60.Bd -literal -offset indent 61#! /usr/bin/env atf-sh 62.Ed 63.Pp 64The following options are available: 65.Bl -tag -width XhXX 66.It Fl h 67Shows a short summary of all available options and their purpose. 68.El 69.Sh ENVIRONMENT 70.Bl -tag -width ATFXSHELLXX -compact 71.It Va ATF_SHELL 72Path to the system shell to be used in the generated scripts. 73.El 74.Sh SEE ALSO 75.Xr atf-sh-api 3 76