xref: /freebsd/contrib/atf/atf-sh/atf-sh.1 (revision f18d3c411697ff46d85e579a72be54ca0cc67dd0)
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 October 15, 2013
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 the
51.Sq atf_shell
52configuration value in
53.Xr atf-config 1 .
54.Nm
55executes the interpreter, loads the
56.Xr atf-sh-api 3
57library and then runs the script.
58.Pp
59Scripts using
60.Xr atf-sh-api 3
61should start with:
62.Bd -literal -offset indent
63#! /usr/bin/env atf-sh
64.Ed
65.Pp
66The following options are available:
67.Bl -tag -width XhXX
68.It Fl h
69Shows a short summary of all available options and their purpose.
70.El
71.Sh SEE ALSO
72.Xr atf-config 1 ,
73.Xr atf-sh-api 3 ,
74.Xr atf 7
75