NetBSD-5.0.2/dist/atf/doc/atf-test-program.1

.\"
.\" Automated Testing Framework (atf)
.\"
.\" Copyright (c) 2007, 2008 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 August 18, 2007
.Dt ATF-TEST-PROGRAM 1
.Os
.Sh NAME
.Nm atf-test-program
.Nd common interface to ATF test programs
.Sh SYNOPSIS
.Nm
.Op Fl r Ar fd
.Op Fl s Ar srcdir
.Op Fl v Ar var1=value1 Op .. Fl v Ar varN=valueN
.Op Ar test_case1 Op Ar .. test_caseN
.Nm
.Fl l
.Ar test_case1
.Op Ar test_case1 Op Ar .. test_caseN
.Nm
.Fl h
.Sh DESCRIPTION
Test programs written using the ATF libraries all share a common user
interface, which is what this manual page describes.
.Pp
In the first synopsis form, the test program will execute the listed
test cases, or all of them if none are provided as arguments.
The test cases' names can be given as glob patterns.
.Pp
In the second synopsis form, the test program will list all available
test cases alongside a brief description of what they do.
If any arguments are specified, the list will be restricted to the
matching test cases.
The test cases' names can be given as glob patterns.
.Pp
In the third synopsis form, the test program will print information
about all supported options and their purpose.
.Pp
The following options are available:
.Bl -tag -width XvXvarXvalueXX
.It Fl h
Shows a short summary of all available options and their purpose.
.It Fl l
Lists available test cases alongside a brief description for each of them.
.It Fl r Ar fd
Specifies the file descriptor to which the test case will redirect its
results.
These results follow a machine-parseable standardized format, and are not
meant for direct user consumption.
See
.Xr atf-formats 5
for more details.
.It Fl s Ar srcdir
The path to the directory where the test program is located.
This is needed in all cases, except when the test program is being executed
from the current directory.
The test program will use this path to locate any helper data files or
utilities.
.It Fl v Ar var=value
Sets the configuration variable
.Ar var
to the value
.Ar value .
.El
.Sh SEE ALSO
.Xr atf-run 1 ,
.Xr atf 7