78 lines
2.4 KiB
Groff
78 lines
2.4 KiB
Groff
|
.\"
|
||
|
|
.\" Automated Testing Framework (atf)
|
||
|
|
.\"
|
||
|
|
.\" Copyright (c) 2010 The NetBSD Foundation, Inc.
|
||
|
|
.\" All rights reserved.
|
||
|
|
.\"
|
||
|
|
.\" Redistribution and use in source and binary forms, with or without
|
||
|
|
.\" modification, are permitted provided that the following conditions
|
||
|
|
.\" are met:
|
||
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer.
|
||
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
||
|
|
.\" documentation and/or other materials provided with the distribution.
|
||
|
|
.\"
|
||
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
|
||
|
|
.\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
|
||
|
|
.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||
|
|
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
||
|
|
.\" IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
|
||
|
|
.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||
|
|
.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||
|
|
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
|
||
|
|
.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
|
||
|
|
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
|
||
|
|
.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
.\"
|
||
|
|
.Dd May 9, 2010
|
||
|
|
.Dt ATF-SH 1
|
||
|
|
.Os
|
||
|
|
.Sh NAME
|
||
|
|
.Nm atf-sh
|
||
|
|
.Nd interpreter for shell-based test programs
|
||
|
|
.Sh SYNOPSIS
|
||
|
|
.Nm
|
||
|
|
.Ar script
|
||
|
|
.Nm
|
||
|
|
.Fl h
|
||
|
|
.Sh DESCRIPTION
|
||
|
|
.Nm
|
||
|
|
is an interpreter that runs the test program given in
|
||
|
|
.Ar script
|
||
|
|
after loading the
|
||
|
|
.Xr atf-sh-api 3
|
||
|
|
library.
|
||
|
|
.Pp
|
||
|
|
.Nm
|
||
|
|
is not a real interpreter though: it is just a wrapper around
|
||
|
|
the system-wide shell defined by the
|
||
|
|
.Sq atf_shell
|
||
|
|
configuration value in
|
||
|
|
.Xr atf-config 1 .
|
||
|
|
.Nm
|
||
|
|
executes the interpreter, loads the
|
||
|
|
.Xr atf-sh-api 3
|
||
|
|
library and then runs the script.
|
||
|
|
.Pp
|
||
|
|
Scripts using
|
||
|
|
.Xr atf-sh-api 3
|
||
|
|
should start with:
|
||
|
|
.Bd -literal -offset indent
|
||
|
|
#! /usr/bin/env atf-sh
|
||
|
|
.Ed
|
||
|
|
.Pp
|
||
|
|
The following options are available:
|
||
|
|
.Bl -tag -width XhXX
|
||
|
|
.It Fl h
|
||
|
|
Shows a short summary of all available options and their purpose.
|
||
|
|
For those formats that write to a single file, specifying a
|
||
|
|
.Sq -
|
||
|
|
as the path will redirect the report to the standard output.
|
||
|
|
.El
|
||
|
|
.Sh SEE ALSO
|
||
|
|
.Xr atf-config 1 ,
|
||
|
|
.Xr atf-sh-api 3 ,
|
||
|
|
.Xr atf 7
|