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