external/bsd/atf/dist/tools/atf-compile.1

   1 .\"
   2 .\" Automated Testing Framework (atf)
   3 .\"
   4 .\" Copyright (c) 2007, 2008 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 5, 2007
  30 .Dt ATF-COMPILE 1
  31 .Os
  32 .Sh NAME
  33 .Nm atf-compile
  34 .Nd generates POSIX shell test programs
  35 .Sh SYNOPSIS
  36 .Nm
  37 .Fl o Ar out-file
  38 .Ar src1
  39 .Op Ar .. srcN
  40 .Nm
  41 .Fl h
  42 .Sh DESCRIPTION
  43 .Nm
  44 generates a POSIX shell program based on a set of input files that
  45 implement test cases in this language.
  46 All the given source files are concatenated in order, and the tool
  47 prepends and appends to the results the necessary boilerplate to
  48 implement a test program directly runnable by the user.
  49 .Pp
  50 In the first synopsis form,
  51 .Nm
  52 will generate the
  53 .Ar out-file
  54 test program by adding the source files to it as well as all the necessary
  55 helper code to turn it into an executable.
  56 .Pp
  57 In the second synopsis form,
  58 .Nm
  59 will print information about all supported options and their purpose.
  60 .Pp
  61 The following options are available:
  62 .Bl -tag -width XoXoutXfileXX
  63 .It Fl h
  64 Shows a short summary of all available options and their purpose.
  65 .It Fl o Ar out-file
  66 Specifies the file to which the results will be written.
  67 .El
  68 .Sh SEE ALSO
  69 .Xr atf 7