Updated: 2022/Sep/29

Please read Privacy Policy. It's for your privacy.


ATF-CONFIG(1)               General Commands Manual              ATF-CONFIG(1)

NAME
     atf-config - queries static configuration information of ATF

SYNOPSIS
     atf-config [-t] [var1 [.. varN]]
     atf-config -h

DESCRIPTION
     atf-config is a utility that queries static configuration information of
     ATF.  Static configuration refers to all those values for settings that
     were built into the ATF binaries at build time.

     In the first synopsis form, atf-config will print variable-value pairs
     for all built-in static variables if no variable names are provided as
     arguments.  If any is provided, it will only print the variable-value
     pairs for those variables.  The output of the utility does not use the
     `=' symbol to separate the variable name from its corresponding value in
     an attempt to avoid sourcing the output in shell scripts or Makefiles.
     If you need to do that, the -t flag allows you to query the value of
     individual variables without any surrounding text.

     In the second synopsis form, atf-config will print information about all
     supported options and their purpose.

     The following options are available:

     -h    Shows a short summary of all available options and their purpose.

     -t    Changes the output of the utility to show the variable values, one
           per line, without the variable names.

   Static configuration variables
     The following list describes all the variables that are part of ATF's
     static configuration:

     atf_arch              The architecture name detected by ATF.  This is
                           derived from atf_machine because it is a subset of
                           it.  Given that this name might be misdetected, it
                           is provided to the user as a configuration variable
                           so that he can fix its value temporarily until a
                           real fix is incorporated into mainstream sources.

     atf_build_cc          The C compiler used by the ATF checks that provide
                           build-time tests.

     atf_build_cflags      The C compiler flags used by the ATF checks that
                           provide build-time tests.

     atf_build_cpp         The C/C++ preprocessor used by the ATF checks that
                           provide build-time tests.

     atf_build_cppflags    The C/C++ preprocessor flags used by the ATF checks
                           that provide build-time tests.

     atf_build_cxx         The C++ compiler used by the ATF checks that
                           provide build-time tests.

     atf_build_cxxflags    The C++ compiler flags used by the ATF checks that
                           provide build-time tests.

     atf_confdir           The path to the directory that contains the system-
                           wide configuration files for ATF.

     atf_includedir        The path to the directory that contains the ATF
                           header files.

     atf_libdir            The path to the directory that contains the ATF
                           libraries.

     atf_libexecdir        The path to the directory that contains the
                           auxiliary utilities of ATF, used internally by the
                           public tools.

     atf_machine           The machine type name detected by ATF.  This should
                           not be tunable but is provided for symmetry with
                           atf_arch.

     atf_pkgdatadir        The path to the directory that contains the files
                           that form the ATF's shell-scripting library.

     atf_shell             The path to the shell interpreter that will be used
                           by ATF.

     atf_workdir           The path to the temporary directory that the
                           utilities and the test programs will use to store
                           temporary files in.

ENVIRONMENT
     Every variable that is part of the static configuration can be overridden
     at run-time by defining an environment variable.  This environment
     variable has the exact same name as the one shown by atf-config except
     that the name is all composed of uppercase letters.

     In general, empty values in the environment will be ignored unless
     otherwise noted below.

     The recognized environment variables are:

     ATF_ARCH              Overrides the built-in value of atf_arch.

     ATF_BUILD_CC          Overrides the built-in value of atf_build_cc.

     ATF_BUILD_CFLAGS      Overrides the built-in value of atf_build_cflags.
                           Empty values are allowed.

     ATF_BUILD_CPP         Overrides the built-in value of atf_build_cpp.

     ATF_BUILD_CPPFLAGS    Overrides the built-in value of atf_build_cppflags.
                           Empty values are allowed.

     ATF_BUILD_CXX         Overrides the built-in value of atf_build_cxx.

     ATF_BUILD_CXXFLAGS    Overrides the built-in value of atf_build_cxxflags.
                           Empty values are allowed.

     ATF_CONFDIR           Overrides the built-in value of atf_confdir.

     ATF_INCLUDEDIR        Overrides the built-in value of atf_includedir.

     ATF_LIBDIR            Overrides the built-in value of atf_libdir.

     ATF_LIBEXECDIR        Overrides the built-in value of atf_libexecdir.

     ATF_MACHINE           Overrides the built-in value of atf_machine.

     ATF_PKGDATADIR        Overrides the built-in value of atf_pkgdatadir.

     ATF_SHELL             Overrides the built-in value of atf_shell.

     ATF_WORKDIR           Overrides the built-in value of atf_workdir.

SEE ALSO
     atf(7)

NetBSD 10.99                    March 14, 2009                    NetBSD 10.99