external/bsd/bind/dist/unit/atf-src/atf-config/atf-config.1

   1 .\"     $NetBSD: atf-config.1,v 1.3 2014/12/10 04:38:03 christos Exp $
   2 .\"
   3 .\"
   4 .\" Automated Testing Framework (atf)
   5 .\"
   6 .\" Copyright (c) 2007 The NetBSD Foundation, Inc.
   7 .\" All rights reserved.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
  19 .\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  20 .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  21 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  22 .\" IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
  23 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  25 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  27 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  28 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  29 .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .Dd March 14, 2009
  32 .Dt ATF-CONFIG 1
  33 .Os
  34 .Sh NAME
  35 .Nm atf-config
  36 .Nd queries static configuration information of ATF
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl t
  40 .Op Ar var1 Op Ar .. varN
  41 .Nm
  42 .Fl h
  43 .Sh DESCRIPTION
  44 .Nm
  45 is a utility that queries static configuration information of ATF.
  46 Static configuration refers to all those values for settings that
  47 were built into the ATF binaries at build time.
  48 .Pp
  49 In the first synopsis form,
  50 .Nm
  51 will print variable-value pairs for all built-in static variables if
  52 no variable names are provided as arguments.
  53 If any is provided, it will only print the variable-value pairs for
  54 those variables.
  55 The output of the utility does not use the
  56 .Sq =
  57 symbol to separate the variable name from its corresponding value in
  58 an attempt to avoid sourcing the output in shell scripts or Makefiles.
  59 If you need to do that, the
  60 .Fl t
  61 flag allows you to query the value of individual variables without any
  62 surrounding text.
  63 .Pp
  64 In the second synopsis form,
  65 .Nm
  66 will print information about all supported options and their purpose.
  67 .Pp
  68 The following options are available:
  69 .Bl -tag -width flag
  70 .It Fl h
  71 Shows a short summary of all available options and their purpose.
  72 .It Fl t
  73 Changes the output of the utility to show the variable values, one
  74 per line, without the variable names.
  75 .El
  76 .Ss Static configuration variables
  77 The following list describes all the variables that are part of ATF's
  78 static configuration:
  79 .Bl -tag -width atfXbuildXcppflagsXX
  80 .It Va atf_arch
  81 The architecture name detected by ATF.
  82 This is derived from
  83 .Va atf_machine
  84 because it is a subset of it.
  85 Given that this name might be misdetected, it is provided to the user
  86 as a configuration variable so that he can fix its value temporarily
  87 until a real fix is incorporated into mainstream sources.
  88 .It Va atf_build_cc
  89 The C compiler used by the ATF checks that provide build-time tests.
  90 .It Va atf_build_cflags
  91 The C compiler flags used by the ATF checks that provide build-time tests.
  92 .It Va atf_build_cpp
  93 The C/C++ preprocessor used by the ATF checks that provide build-time tests.
  94 .It Va atf_build_cppflags
  95 The C/C++ preprocessor flags used by the ATF checks that provide build-time
  96 tests.
  97 .It Va atf_build_cxx
  98 The C++ compiler used by the ATF checks that provide build-time tests.
  99 .It Va atf_build_cxxflags
 100 The C++ compiler flags used by the ATF checks that provide build-time tests.
 101 .It Va atf_confdir
 102 The path to the directory that contains the system-wide configuration
 103 files for ATF.
 104 .It Va atf_includedir
 105 The path to the directory that contains the ATF header files.
 106 .It Va atf_libdir
 107 The path to the directory that contains the ATF libraries.
 108 .It Va atf_libexecdir
 109 The path to the directory that contains the auxiliary utilities of ATF,
 110 used internally by the public tools.
 111 .It Va atf_machine
 112 The machine type name detected by ATF.
 113 This should not be tunable but is provided for symmetry with
 114 .Va atf_arch .
 115 .It Va atf_pkgdatadir
 116 The path to the directory that contains the files that form the ATF's
 117 shell-scripting library.
 118 .It Va atf_shell
 119 The path to the shell interpreter that will be used by ATF.
 120 .It Va atf_workdir
 121 The path to the temporary directory that the utilities and the test
 122 programs will use to store temporary files in.
 123 .El
 124 .Sh ENVIRONMENT
 125 Every variable that is part of the static configuration can be
 126 overridden at run-time by defining an environment variable.
 127 This environment variable has the exact same name as the one shown by
 128 .Nm
 129 except that the name is all composed of uppercase letters.
 130 .Pp
 131 In general, empty values in the environment will be ignored unless
 132 otherwise noted below.
 133 .Pp
 134 The recognized environment variables are:
 135 .Bl -tag -width ATFXBUILDXCPPFLAGSXX
 136 .It Ev ATF_ARCH
 137 Overrides the built-in value of
 138 .Va atf_arch .
 139 .It Ev ATF_BUILD_CC
 140 Overrides the built-in value of
 141 .Va atf_build_cc .
 142 .It Ev ATF_BUILD_CFLAGS
 143 Overrides the built-in value of
 144 .Va atf_build_cflags .
 145 Empty values are allowed.
 146 .It Ev ATF_BUILD_CPP
 147 Overrides the built-in value of
 148 .Va atf_build_cpp .
 149 .It Ev ATF_BUILD_CPPFLAGS
 150 Overrides the built-in value of
 151 .Va atf_build_cppflags .
 152 Empty values are allowed.
 153 .It Ev ATF_BUILD_CXX
 154 Overrides the built-in value of
 155 .Va atf_build_cxx .
 156 .It Ev ATF_BUILD_CXXFLAGS
 157 Overrides the built-in value of
 158 .Va atf_build_cxxflags .
 159 Empty values are allowed.
 160 .It Ev ATF_CONFDIR
 161 Overrides the built-in value of
 162 .Va atf_confdir .
 163 .It Ev ATF_INCLUDEDIR
 164 Overrides the built-in value of
 165 .Va atf_includedir .
 166 .It Ev ATF_LIBDIR
 167 Overrides the built-in value of
 168 .Va atf_libdir .
 169 .It Ev ATF_LIBEXECDIR
 170 Overrides the built-in value of
 171 .Va atf_libexecdir .
 172 .It Ev ATF_MACHINE
 173 Overrides the built-in value of
 174 .Va atf_machine .
 175 .It Ev ATF_PKGDATADIR
 176 Overrides the built-in value of
 177 .Va atf_pkgdatadir .
 178 .It Ev ATF_SHELL
 179 Overrides the built-in value of
 180 .Va atf_shell .
 181 .It Ev ATF_WORKDIR
 182 Overrides the built-in value of
 183 .Va atf_workdir .
 184 .El
 185 .Sh SEE ALSO
 186 .Xr atf 7