external/bsd/kyua-atf-compat/dist/atf2kyua.1

   1 .\" Copyright 2012 Google Inc.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions are
   6 .\" met:
   7 .\"
   8 .\" * Redistributions of source code must retain the above copyright
   9 .\"   notice, this list of conditions and the following disclaimer.
  10 .\" * Redistributions in binary form must reproduce the above copyright
  11 .\"   notice, this list of conditions and the following disclaimer in the
  12 .\"   documentation and/or other materials provided with the distribution.
  13 .\" * Neither the name of Google Inc. nor the names of its contributors
  14 .\"   may be used to endorse or promote products derived from this software
  15 .\"   without specific prior written permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18 .\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20 .\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21 .\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23 .\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27 .\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .Dd June 16, 2012
  29 .Dt ATF2KYUA 1
  30 .Os
  31 .Sh NAME
  32 .Nm atf2kyua
  33 .Nd Converts Atffiles to Kyuafiles for a particular test suite.
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Fl s Ar source_path
  37 .Op Fl t Ar target_path
  38 .Sh DESCRIPTION
  39 .Nm
  40 is a script that generates Kyuafiles for all the corresponding Atffiles in
  41 the specified test suite.
  42 .Pp
  43 By default,
  44 .Nm
  45 will look for Atffiles in the current directory and generate the new
  46 Kyuafiles next to where the Atffiles live.
  47 These behaviors can both be changed by the options described below.
  48 .Pp
  49 The following options are available:
  50 .Bl -tag -width XsXsourceXpathXX
  51 .It Fl s Ar source_path
  52 Path to where the test suite file resides; i.e. the path from which to
  53 start the traversal looking for Atffiles.
  54 If not given, defaults to the current directory.
  55 .It Fl t Ar target_path
  56 Path to where the generated Kyuafiles will be written.
  57 If the target directory is changed to not match the source directory, the
  58 layout of the target directory end up being the same as that of the source
  59 directory.
  60 If not given, defaults to the value of the source path.
  61 .El
  62 .Sh SEE ALSO
  63 .Xr kyua 1 ,
  64 .Xr atf 7