NetBSD-5.0.2/dist/atf/tools/atf-compile.1

Compare this file to the similar file:
Show the results in this format:
.\"
.\" 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 October 5, 2007
.Dt ATF-COMPILE 1
.Os
.Sh NAME
.Nm atf-compile
.Nd generates POSIX shell test programs
.Sh SYNOPSIS
.Nm
.Fl o Ar out-file
.Ar src1
.Op Ar .. srcN
.Nm
.Fl h
.Sh DESCRIPTION
.Nm
generates a POSIX shell program based on a set of input files that
implement test cases in this language.
All the given source files are concatenated in order, and the tool
prepends and appends to the results the necessary boilerplate to
implement a test program directly runnable by the user.
.Pp
In the first synopsis form,
.Nm
will generate the
.Ar out-file
test program by adding the source files to it as well as all the necessary
helper code to turn it into an executable.
.Pp
In the second synopsis form,
.Nm
will print information about all supported options and their purpose.
.Pp
The following options are available:
.Bl -tag -width XoXoutXfileXX
.It Fl h
Shows a short summary of all available options and their purpose.
.It Fl o Ar out-file
Specifies the file to which the results will be written.
.El
.Sh SEE ALSO
.Xr atf 7