contrib/atf/atf-config/atf-config.1

   1 .\"
   2 .\" Automated Testing Framework (atf)
   3 .\"
   4 .\" Copyright (c) 2007 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 March 14, 2009
  30 .Dt ATF-CONFIG 1
  31 .Os
  32 .Sh NAME
  33 .Nm atf-config
  34 .Nd queries static configuration information of ATF
  35 .Sh SYNOPSIS
  36 .Nm
  37 .Op Fl t
  38 .Op Ar var1 Op Ar .. varN
  39 .Nm
  40 .Fl h
  41 .Sh DESCRIPTION
  42 .Nm
  43 is a utility that queries static configuration information of ATF.
  44 Static configuration refers to all those values for settings that
  45 were built into the ATF binaries at build time.
  46 .Pp
  47 In the first synopsis form,
  48 .Nm
  49 will print variable-value pairs for all built-in static variables if
  50 no variable names are provided as arguments.
  51 If any is provided, it will only print the variable-value pairs for
  52 those variables.
  53 The output of the utility does not use the
  54 .Sq =
  55 symbol to separate the variable name from its corresponding value in
  56 an attempt to avoid sourcing the output in shell scripts or Makefiles.
  57 If you need to do that, the
  58 .Fl t
  59 flag allows you to query the value of individual variables without any
  60 surrounding text.
  61 .Pp
  62 In the second synopsis form,
  63 .Nm
  64 will print information about all supported options and their purpose.
  65 .Pp
  66 The following options are available:
  67 .Bl -tag -width flag
  68 .It Fl h
  69 Shows a short summary of all available options and their purpose.
  70 .It Fl t
  71 Changes the output of the utility to show the variable values, one
  72 per line, without the variable names.
  73 .El
  74 .Ss Static configuration variables
  75 The following list describes all the variables that are part of ATF's
  76 static configuration:
  77 .Bl -tag -width atfXbuildXcppflagsXX
  78 .It Va atf_arch
  79 The architecture name detected by ATF.
  80 This is derived from
  81 .Va atf_machine
  82 because it is a subset of it.
  83 Given that this name might be misdetected, it is provided to the user
  84 as a configuration variable so that he can fix its value temporarily
  85 until a real fix is incorporated into mainstream sources.
  86 .It Va atf_build_cc
  87 The C compiler used by the ATF checks that provide build-time tests.
  88 .It Va atf_build_cflags
  89 The C compiler flags used by the ATF checks that provide build-time tests.
  90 .It Va atf_build_cpp
  91 The C/C++ preprocessor used by the ATF checks that provide build-time tests.
  92 .It Va atf_build_cppflags
  93 The C/C++ preprocessor flags used by the ATF checks that provide build-time
  94 tests.
  95 .It Va atf_build_cxx
  96 The C++ compiler used by the ATF checks that provide build-time tests.
  97 .It Va atf_build_cxxflags
  98 The C++ compiler flags used by the ATF checks that provide build-time tests.
  99 .It Va atf_confdir
 100 The path to the directory that contains the system-wide configuration
 101 files for ATF.
 102 .It Va atf_includedir
 103 The path to the directory that contains the ATF header files.
 104 .It Va atf_libdir
 105 The path to the directory that contains the ATF libraries.
 106 .It Va atf_libexecdir
 107 The path to the directory that contains the auxiliary utilities of ATF,
 108 used internally by the public tools.
 109 .It Va atf_machine
 110 The machine type name detected by ATF.
 111 This should not be tunable but is provided for symmetry with
 112 .Va atf_arch .
 113 .It Va atf_pkgdatadir
 114 The path to the directory that contains the files that form the ATF's
 115 shell-scripting library.
 116 .It Va atf_shell
 117 The path to the shell interpreter that will be used by ATF.
 118 .It Va atf_workdir
 119 The path to the temporary directory that the utilities and the test
 120 programs will use to store temporary files in.
 121 .El
 122 .Sh ENVIRONMENT
 123 Every variable that is part of the static configuration can be
 124 overridden at run-time by defining an environment variable.
 125 This environment variable has the exact same name as the one shown by
 126 .Nm
 127 except that the name is all composed of uppercase letters.
 128 .Pp
 129 In general, empty values in the environment will be ignored unless
 130 otherwise noted below.
 131 .Pp
 132 The recognized environment variables are:
 133 .Bl -tag -width ATFXBUILDXCPPFLAGSXX
 134 .It Ev ATF_ARCH
 135 Overrides the built-in value of
 136 .Va atf_arch .
 137 .It Ev ATF_BUILD_CC
 138 Overrides the built-in value of
 139 .Va atf_build_cc .
 140 .It Ev ATF_BUILD_CFLAGS
 141 Overrides the built-in value of
 142 .Va atf_build_cflags .
 143 Empty values are allowed.
 144 .It Ev ATF_BUILD_CPP
 145 Overrides the built-in value of
 146 .Va atf_build_cpp .
 147 .It Ev ATF_BUILD_CPPFLAGS
 148 Overrides the built-in value of
 149 .Va atf_build_cppflags .
 150 Empty values are allowed.
 151 .It Ev ATF_BUILD_CXX
 152 Overrides the built-in value of
 153 .Va atf_build_cxx .
 154 .It Ev ATF_BUILD_CXXFLAGS
 155 Overrides the built-in value of
 156 .Va atf_build_cxxflags .
 157 Empty values are allowed.
 158 .It Ev ATF_CONFDIR
 159 Overrides the built-in value of
 160 .Va atf_confdir .
 161 .It Ev ATF_INCLUDEDIR
 162 Overrides the built-in value of
 163 .Va atf_includedir .
 164 .It Ev ATF_LIBDIR
 165 Overrides the built-in value of
 166 .Va atf_libdir .
 167 .It Ev ATF_LIBEXECDIR
 168 Overrides the built-in value of
 169 .Va atf_libexecdir .
 170 .It Ev ATF_MACHINE
 171 Overrides the built-in value of
 172 .Va atf_machine .
 173 .It Ev ATF_PKGDATADIR
 174 Overrides the built-in value of
 175 .Va atf_pkgdatadir .
 176 .It Ev ATF_SHELL
 177 Overrides the built-in value of
 178 .Va atf_shell .
 179 .It Ev ATF_WORKDIR
 180 Overrides the built-in value of
 181 .Va atf_workdir .
 182 .El
 183 .Sh SEE ALSO
 184 .Xr atf 7