"Fossies" - the Fresh Open Source Software Archive

Member "scalasca-2.6/INSTALL" (19 Apr 2021, 34686 Bytes) of package /linux/misc/scalasca-2.6.tar.gz:

As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the last Fossies "Diffs" side-by-side code changes report for "INSTALL": 2.3.1_vs_2.4.

    2                          SCALASCA v2 INSTALL GUIDE
    3                          =========================
    5 This file describes how to configure, compile, and install the Scalasca Trace
    6 Tools package.  If you are not familiar with using the configure scripts
    7 generated by GNU autoconf, read the "Generic Installation Instructions"
    8 section below; then return here.  Also, make sure to carefully read and
    9 follow the platform-specific installation notes (especially when building for
   10 Intel Xeon Phi co-processors).
   13 Prerequisites
   14 =============
   16 To build Scalasca v2, various tools and packages are required:
   18   * ISO C++98 compiler
   19   * ISO C99 compiler
   20   * A "working" POSIX-compatible shell
   21   * A POSIX-compatible make
   22   * A Message Passing Interface (MPI) library supporting MPI 1.2 or higher
   23     (Although Scalasca can be configured without MPI support, this setup
   24     is hardly useful in practice.)
   26 Moreover, the following packages are *strongly recommended* to make effective
   27 use of Scalasca.  While they are not strictly necessary for building, some
   28 commands of those packages are used at runtime.  The version ranges reflect
   29 the state at the time of release.  While we usually recommend to use the
   30 most recent versions for new installs, versions newer than listed below may
   31 or may not work (e.g., due to API changes).  Thus, please also check the
   32 "Build requirements" page on the Scalasca website for up-to-date information
   33 (https://www.scalasca.org/scalasca/software/scalasca-2.x/requirements.html).
   35   * Score-P                        (https://www.score-p.org)
   37        Minimum version: v1.2       Tested up to: v7.0
   39        Scalasca v2 is based on the community instrumentation and measurement
   40        infrastructure Score-P.  To generate event traces for Scalasca to
   41        analyze, a working installation of Score-P is therefore required.
   43   * Cube C++ library and tools     (https://www.scalasca.org/software/cube-4.x/)
   45        Minimum version: v4.4       Tested up to: v4.6
   47        Various Cube command-line tools are implicitly used by Scalasca's
   48        report scoring and post-processing.  Thus, a working installation of
   49        the Cube C++ library and tools is required.
   51   * Cube GUI                       (https://www.scalasca.org/software/cube-4.x/)
   53        Minimum version: v4.4       Tested up to: v4.6
   55        To examine the analysis reports generated by the Scalasca Trace Tools,
   56        the Cube Graphical User Interface (built on top of the aforementioned
   57        Cube C++ libraries) is recommended.  The Cube GUI may also be launched
   58        through Scalasca's convenience commands.
   60 Optionally, Scalasca v2 can be configured to use the following support
   61 libraries:
   63   * Cube C Writer library          (https://www.scalasca.org/software/cube-4.x/)
   65        Minimum version: v4.4       Tested up to: v4.6
   67        Although the Scalasca tarball comes with a recent version of the Cube
   68        C Writer library included, it might be desired to use a separate
   69        installation instead (e.g., to "share" with the Score-P measurement
   70        system).
   72   * OTF2 library                   (https://www.score-p.org/)
   74        Minimum version: v2.1       Tested up to: v2.3
   76        Likewise, the Scalasca tarball includes a recent version of the OTF2
   77        library.  However, it might be desired to use a separate installation
   78        instead (e.g., to "share" with the Score-P measurement system).
   80   * SIONlib library                (https://www.fz-juelich.de/jsc/sionlib)
   82        Minimum version: v1.5.5     Tested up to: v1.7.6
   84        The SIONlib library is only needed if the OTF2 library (either the
   85        included copy or an external installation) shall be configured to
   86        support SIONlib container files for storing trace data.
   88   * zlib library                   (https://www.zlib.net/)
   90        Minimum version: v1.2.3     Tested up to: v1.2.11
   92        The zlib library is only needed if backwards compatibility support for
   93        compressed trace files in EPILOG format (generated by Scalasca v1) or
   94        writing of compressed Cube reports is desired.  In cross-compiling
   95        environments, zlib has to be compiled for the compute nodes (i.e.,
   96        backend).
   98   * GNU liberty library
  100        The GNU liberty library is only required if getopt_long_only() is not
  101        part of the system's C library.  It is distributed as part of GNU gcc,
  102        gdb, and binutils.  In cross-compiling environments, liberty has to be
  103        compiled for the frontend.
  106 Quick start
  107 ===========
  109 In a nutshell, configuring, building, and installing Scalasca can be as
  110 simple as executing the shell commands
  112     ./configure --prefix=<installdir>
  113     make
  114     make install
  116 Depending on your system configuration and specific needs, the build process
  117 can be customized as described below.
  120 Configuration
  121 =============
  123 The configure script in this package tries to automatically determine the
  124 platform for which Scalasca will be compiled in order to provide reasonable
  125 defaults for backend (i.e., compute node) compilers, MPI compilers, and--in
  126 case of cross-compiling environments--frontend (i.e., login node) compilers.
  128 Depending on the environment it is possible to override the platform defaults
  129 by using the following configure options:
  131 In non-cross-compiling environments, the compiler suite used to build the
  132 backend parts can be specified explicitly if desired.  On Linux clusters it
  133 is currently recommended to use this option to select a compiler suite other
  134 than GCC.
  136   --with-nocross-compiler-suite=(gcc|ibm|intel|pgi|studio|clang|aocc)
  137                The compiler suite used to build this package in
  138                non-cross-compiling environments.  Needs to be in $PATH.
  139                [Default: gcc]
  141   Note: if you select 'pgi', CXX will be set to 'pgc++', which is PGI's
  142   default C++ compiler in recent releases.  If you have a PGI compiler
  143   installation prior to v16.1, you might want to use 'pgCC' instead (e.g.,
  144   if your MPI C++ compiler wrappers use this one).  To select pgCC, please
  145   add 'CXX=pgCC' to your configure line.
  146   Note: for the NVIDIA HPC SDK, select 'pgi'.
  148 In cross-compiling environments, the compiler suite used to build the
  149 frontend parts can be specified explicitly if desired.
  151   --with-frontend-compiler-suite=(gcc|ibm|intel|pgi|studio|clang|aocc)
  152                The compiler suite used to build the frontend parts of
  153                this package in cross-compiling environments.  Needs to
  154                be in $PATH.
  155                [Default: gcc]
  157 The MPI compiler, if in $PATH, is usually autodetected.  If there are several
  158 MPI compilers found in $PATH, the user is requested to select one using the
  159 configure option:
  161   --with-mpi=(bullxmpi|hp|ibmpoe|intel|intel2|intel3|intelpoe|lam| \
  162               mpibull2|mpich|mpich2|mpich3|openmpi|openmpi3|platform| \
  163               scali|sgimpt|sgimptwrapper|spectrum|sun)
  164                The MPI compiler suite to build this package in non
  165                cross-compiling mode.  Usually autodetected.  Needs to
  166                be in $PATH.
  168                For some MPI implementations, multiple versions with different
  169                characteristics are supported:
  171                  intel     -  Intel MPI 1.x
  172                  intel2    -  Intel MPI 2.x to 4.x
  173                  intel3    -  Intel MPI 5.x and newer
  174                  mpich     -  MPICH 1.x
  175                  mpich2    -  MPICH2 1.x
  176                  mpich3    -  MPICH 3.x
  177                  openmpi   -  Open MPI 1.x and 2.x
  178                  openmpi3  -  Open MPI 3.x and newer
  180                When using this option, make sure to specify the correct
  181                configuration.  Note that MPICH configurations can also be
  182                used for derived implementations such as MVAPICH or
  183                ParaStation MPI; likewise for Open MPI.
  185 Note that there is currently no consistency check whether backend and MPI
  186 compiler are from the same vendor.  If they are not, linking problems
  187 (undefined references) might occur.
  189 If a particular system requires to use compilers different to those Scalasca
  190 currently supports, please edit the files
  191 build-config/common/platforms/platform-*-user-provided to your needs
  192 and use the following configure option:
  194   --with-custom-compilers
  195                Customize compiler settings by 1. copying the files
  196                <srcdir>/build-config/common/platforms/platform-*-user-provided
  197                to the directory where you run configure <builddir>,
  198                2. editing those files to your needs, and 3. running
  199                configure.  Alternatively, edit the files under <srcdir>
  200                directly.  Files in <builddir> take precedence.  You are
  201                entering unsupported terrain.  Namaste, and good luck!
  203 On cross-compile systems the default frontend compiler is IBM XL for the Blue
  204 Gene series and GCC on all other platforms.  The backend compilers will
  205 either be automatically selected by the platform detection (IBM Blue Gene
  206 series) or by the currently loaded environment modules (Cray XT/XE/XK/XC
  207 series).  If you want to customize these settings, please use the configure
  208 option '--with-custom-compilers' as described above.
  210 It is also possible to explicitly disable support for MPI and/or OpenMP using
  211 the following options, though this should be rarely necessary.
  213   --disable-openmp        Disable OpenMP support
  214   --without-mpi           Disable MPI support
  216 Although this package comes with recent versions of the OTF2 and Cube C Writer
  217 libraries included, it is possible to use existing installations instead:
  219   --with-otf2[=<otf2-bindir>]
  220                           Use an already installed and compatible OTF2
  221                           library.  Provide path to otf2-config.
  222                           Auto-detected if already in $PATH.
  223   --with-cubew[=<cubew-bindir>]
  224                           Use an already installed and compatible Cube
  225                           library.  Provide path to cubew-config.
  226                           Auto-detected if already in $PATH.
  228 To enable SIONlib support in the included OTF2 library, the following option
  229 is required.  It has no effect if an external OTF2 installation is used (as
  230 it was already compiled with or without SIONlib support).
  232   --with-sionlib[=<sionlib-bindir>]
  233                           Use an already installed sionlib.  Provide
  234                           path to sionconfig.  Auto-detected if already
  235                           in $PATH.
  237 The following two options can be used to provide the installation paths of
  238 the 'libz' and 'libiberty' libraries in case configure is unable to determine
  239 them automatically:
  241   --with-libz=(yes|no|<Path to libz installation>)
  242                           If you want to build Scalasca with libz but do not
  243                           have a libz in a standard location, you need to
  244                           explicitly specify the directory where it is
  245                           installed.  On non-cross-compile systems we search
  246                           the system include and lib paths per default [yes];
  247                           on cross-compile systems, however, you have to
  248                           specify a path [no]. --with-libz is a shorthand for
  249                           --with-libz-include=<Path/include> and
  250                           --with-libz-lib=<Path/lib>.  If these shorthand
  251                           assumptions are not correct, you can use the
  252                           explicit include and lib options directly.
  254   --with-libiberty=(yes|no|<Path to libiberty installation>)
  255                           If you want to build Scalasca with libiberty but do
  256                           not have a (frontend) libiberty in a standard
  257                           location, you need to explicitly specify the
  258                           directory where it is installed
  259                           (--with-libiberty=<libiberty-install-dir>) [yes].
  260                           This is a shorthand for
  261                           --with-libiberty-include=<Path/include> and
  262                           --with-libiberty-lib=<Path/lib>.  If these
  263                           shorthand assumptions are not correct, you can use
  264                           the explicit include and lib options directly.
  266 The '--with-libiberty' option should only be used if directed by configure or
  267 the detected implementation of getopt_long_only() is known to be broken.
  269 Finally, to enable a build for Intel Xeon Phi co-processors (such as Knights
  270 Corner), the option '--enable-platform-mic' can be used.  For such systems,
  271 special care has to be taken.  Thus, please carefully read and follow the
  272 platform-specific installation notes below.  Note that *no* special treatment
  273 is required for *self-hosted* Xeon Phi platforms (such as Knights Landing).
  275 Scalasca's build system also supports some additional configuration options,
  276 including many standard GNU autotools options.  To get the full list of
  277 supported configuration options, run './configure --help=recursive'.
  279 Instead of passing command-line options to the 'configure' script, the
  280 package configuration can also be influenced by setting the following
  281 environment variables:
  283   CC          C compiler command
  284   CFLAGS      C compiler flags
  285   LDFLAGS     linker flags, e.g. -L<lib dir> if you have libraries in a
  286               nonstandard directory <lib dir>
  287   LIBS        libraries to pass to the linker, e.g. -l<library>
  288   CPPFLAGS    (Objective) C/C++ preprocessor flags, e.g. -I<include dir> if
  289               you have headers in a nonstandard directory <include dir>
  291               User-defined run-time library search path.
  292   CXX         C++ compiler command
  293   CXXFLAGS    C++ compiler flags
  294   CPP         C preprocessor
  295   OTF_CONFIG  config script used for otf
  296   OTF_CFLAGS  CFLAGS used for the otf
  297   OTF_LIBS    LIBS used for the otf
  298   CXXCPP      C++ preprocessor
  299   CC_FOR_BUILD
  300               C compiler command for the frontend build
  302               C++ compiler command for the frontend build
  303   F77_FOR_BUILD
  304               Fortran 77 compiler command for the frontend build
  305   FC_FOR_BUILD
  306               Fortran compiler command for the frontend build
  308               (Objective) C/C++ preprocessor flags for the frontend build,
  309               e.g. -I<include dir> if you have headers in a nonstandard
  310               directory <include dir>
  312               C compiler flags for the frontend build
  314               C++ compiler flags for the frontend build
  316               Fortran 77 compiler flags for the frontend build
  318               Fortran compiler flags for the frontend build
  320               linker flags for the frontend build, e.g. -L<lib dir> if you
  321               have libraries in a nonstandard directory <lib dir>
  323               libraries to pass to the linker for the frontend build, e.g.
  324               -l<library>
  325   YACC        The `Yet Another Compiler Compiler' implementation to use.
  326               Defaults to the first program found out of: `bison -y', `byacc',
  327               `yacc'.
  328   YFLAGS      The list of arguments that will be passed by default to $YACC.
  329               This script will default YFLAGS to the empty string to avoid a
  330               default value of `-d' given by some make applications.
  332               Path to libiberty headers.
  334               Path to libiberty libraries.
  336               Path to libz headers.
  337   LIBZ_LIB    Path to libz libraries.
  338   MPICC       MPI C compiler command
  339   MPI_CFLAGS  MPI C compiler flags
  340   MPICXX      MPI C++ compiler command
  342               MPI (Objective) C/C++ preprocessor flags, e.g. -I<include dir>
  343               if you have headers in a nonstandard directory <include dir>
  345               MPI C++ compiler flags
  346   MPI_LDFLAGS MPI linker flags, e.g. -L<lib dir> if you have libraries in a
  347               nonstandard directory <lib dir>
  348   MPI_LIBS    MPI libraries to pass to the linker, e.g. -l<library>
  350               Whether to prevent passing --enable-backend-test-runs to
  351               sub-packages.  Activation values are '1', 'yes', and 'true'.
  354 Building & Installing
  355 =====================
  357 Before building the Scalasca Trace Tools, carefully check whether the
  358 configuration summary printed by the configure script matches your
  359 expectations (i.e., whether MPI and/or OpenMP support is correctly
  360 enabled/disabled, external libraries are used, etc).  If everything is
  361 OK, the Scalasca Trace Tools can be built and installed using
  363         make
  364         make install
  366 Note that parallel builds (i.e., using 'make -j <n>') are fully supported.
  371                       Platform-specific Instructions
  372                       ==============================
  374 Intel Xeon Phi (aka. MIC) co-processors
  375 =======================================
  377    [Note: The following instructions only apply to Intel Xeon Phi
  378 co-processors, like the Knights Corner (KNC).  They do not apply to
  379 self-hosted Xeon Phis, like the Knights Landing (KNL); for these
  380 platforms no special treatment is required.]
  382    Building Scalasca for Intel Xeon Phi co-processors requires some extra
  383 care, and in some cases two installations into the same location.  Therefore,
  384 we strongly recommend to strictly follow the procedure as described below.
  386   1. Ensure that Intel compilers and Intel MPI (if desired) are
  387      installed and available in $PATH, and that the Intel Manycore
  388      Platform Software Stack (MPSS) is installed.
  390   2. Configure Scalasca to use the MIC platform:
  392        ./configure --enable-platform-mic [other options, e.g., '--prefix']
  394   3. Build and install:
  396        make; make install
  398    In case a native MIC-only installation serves your needs, that's it.
  399 However, if the installation should also support analysis of host code, a
  400 second installation *on top* of the just installed one is required:
  402   4. Remove MIC program binaries, object files, and configure-generated files
  403      from the build/source-code directory:
  405        make distclean
  407   5. Reconfigure for the host using *identical directory options* (e.g.,
  408      '--prefix' or '--bindir') as in step 2:
  410        ./configure [other options as used in step 2]
  412      This will automatically detect the already existing native MIC build and
  413      enable the required support in the host tools.  On non-cross-compile
  414      systems (e.g., typical Linux clusters), make sure to explicitly select
  415      Intel compiler support by passing '--with-nocross-compiler-suite=intel'
  416      to the configure script.
  418   6. Build and install:
  420        make; make install
  422    Note that this approach also works with VPATH builds (even with two
  423 separate build directories) as long as the same options defining directory
  424 locations are passed in steps 2 and 5.
  427 Cray XC systems
  428 ===============
  430    The PGI C++ 17.x compilers are known to have problems with static linking.
  431 This will result in "undefined reference" linking errors when compiling the
  432 Scalasca Trace Tools.  The suggested workaround is to use dynamic linking by
  433 exporting the environment variable 'CRAYPE_LINK_TYPE=dynamic' before running
  434 'configure' and 'make'.
  438                      Generic Installation Instructions
  439                      =================================
  441 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
  442 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
  444    Copying and distribution of this file, with or without modification,
  445 are permitted in any medium without royalty provided the copyright
  446 notice and this notice are preserved.  This file is offered as-is,
  447 without warranty of any kind.
  449 Basic Installation
  450 ==================
  452    Briefly, the shell commands `./configure; make; make install' should
  453 configure, build, and install this package.  The following more-detailed
  454 instructions are generic; see the section above for instructions
  455 specific to this package.  Some packages provide this `INSTALL' file but
  456 do not implement all of the features documented below.  The lack of an
  457 optional feature in a given package is not necessarily a bug.
  459    The `configure' shell script attempts to guess correct values for
  460 various system-dependent variables used during compilation.  It uses
  461 those values to create a `Makefile' in each directory of the package.
  462 It may also create one or more `.h' files containing system-dependent
  463 definitions.  Finally, it creates a shell script `config.status' that
  464 you can run in the future to recreate the current configuration, and a
  465 file `config.log' containing compiler output (useful mainly for
  466 debugging `configure').
  468    It can also use an optional file (typically called `config.cache'
  469 and enabled with `--cache-file=config.cache' or simply `-C') that saves
  470 the results of its tests to speed up reconfiguring.  Caching is
  471 disabled by default to prevent problems with accidental use of stale
  472 cache files.
  474    If you need to do unusual things to compile the package, please try
  475 to figure out how `configure' could check whether to do them, and mail
  476 diffs or instructions to scalasca@fz-juelich.de so they can be
  477 considered for the next release.  If you are using the cache, and at
  478 some point `config.cache' contains results you don't want to keep, you
  479 may remove or edit it.
  481    The file `configure.ac' (or `configure.in') is used to create
  482 `configure' by a program called `autoconf'.  You need `configure.ac' if
  483 you want to change it or regenerate `configure' using a newer version
  484 of `autoconf'.
  486    The simplest way to compile this package is:
  488   1. `cd' to the directory containing the package's source code and type
  489      `./configure' to configure the package for your system.
  491      Running `configure' might take a while.  While running, it prints
  492      some messages telling which features it is checking for.
  494   2. Type `make' to compile the package.
  496   3. Optionally, type `make check' to run any self-tests that come with
  497      the package, generally using the just-built uninstalled binaries.
  499   4. Type `make install' to install the programs and any data files and
  500      documentation.  When installing into a prefix owned by root, it is
  501      recommended that the package be configured and built as a regular
  502      user, and only the `make install' phase executed with root
  503      privileges.
  505   5. Optionally, type `make installcheck' to repeat any self-tests, but
  506      this time using the binaries in their final installed location.
  507      This target does not install anything.  Running this target as a
  508      regular user, particularly if the prior `make install' required
  509      root privileges, verifies that the installation completed
  510      correctly.
  512   6. You can remove the program binaries and object files from the
  513      source code directory by typing `make clean'.  To also remove the
  514      files that `configure' created (so you can compile the package for
  515      a different kind of computer), type `make distclean'.  There is
  516      also a `make maintainer-clean' target, but that is intended mainly
  517      for the package's developers.  If you use it, you may have to get
  518      all sorts of other programs in order to regenerate files that came
  519      with the distribution.
  521   7. Often, you can also type `make uninstall' to remove the installed
  522      files again.  In practice, not all packages have tested that
  523      uninstallation works correctly, even though it is required by the
  524      GNU Coding Standards.
  526   8. Some packages, particularly those that use Automake, provide `make
  527      distcheck', which can by used by developers to test that all other
  528      targets like `make install' and `make uninstall' work correctly.
  529      This target is generally not run by end users.
  531 Compilers and Options
  532 =====================
  534    Some systems require unusual options for compilation or linking that
  535 the `configure' script does not know about.  Run `./configure --help'
  536 for details on some of the pertinent environment variables.
  538    You can give `configure' initial values for configuration parameters
  539 by setting variables in the command line or in the environment.  Here
  540 is an example:
  542      ./configure CC=c99 CFLAGS=-g LIBS=-lposix
  544    *Note Defining Variables::, for more details.
  546 Compiling For Multiple Architectures
  547 ====================================
  549    You can compile the package for more than one kind of computer at the
  550 same time, by placing the object files for each architecture in their
  551 own directory.  To do this, you can use GNU `make'.  `cd' to the
  552 directory where you want the object files and executables to go and run
  553 the `configure' script.  `configure' automatically checks for the
  554 source code in the directory that `configure' is in and in `..'.  This
  555 is known as a "VPATH" build.
  557    With a non-GNU `make', it is safer to compile the package for one
  558 architecture at a time in the source code directory.  After you have
  559 installed the package for one architecture, use `make distclean' before
  560 reconfiguring for another architecture.
  562    On MacOS X 10.5 and later systems, you can create libraries and
  563 executables that work on multiple system types--known as "fat" or
  564 "universal" binaries--by specifying multiple `-arch' options to the
  565 compiler but only a single `-arch' option to the preprocessor.  Like
  566 this:
  568      ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
  569                  CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
  570                  CPP="gcc -E" CXXCPP="g++ -E"
  572    This is not guaranteed to produce working output in all cases, you
  573 may have to build one architecture at a time and combine the results
  574 using the `lipo' tool if you have problems.
  576 Installation Names
  577 ==================
  579    By default, `make install' installs the package's commands under
  580 `/usr/local/bin', include files under `/usr/local/include', etc.  You
  581 can specify an installation prefix other than `/usr/local' by giving
  582 `configure' the option `--prefix=PREFIX', where PREFIX must be an
  583 absolute file name.
  585    You can specify separate installation prefixes for
  586 architecture-specific files and architecture-independent files.  If you
  587 pass the option `--exec-prefix=PREFIX' to `configure', the package uses
  588 PREFIX as the prefix for installing programs and libraries.
  589 Documentation and other data files still use the regular prefix.
  591    In addition, if you use an unusual directory layout you can give
  592 options like `--bindir=DIR' to specify different values for particular
  593 kinds of files.  Run `configure --help' for a list of the directories
  594 you can set and what kinds of files go in them.  In general, the
  595 default for these options is expressed in terms of `${prefix}', so that
  596 specifying just `--prefix' will affect all of the other directory
  597 specifications that were not explicitly provided.
  599    The most portable way to affect installation locations is to pass the
  600 correct locations to `configure'; however, many packages provide one or
  601 both of the following shortcuts of passing variable assignments to the
  602 `make install' command line to change installation locations without
  603 having to reconfigure or recompile.
  605    The first method involves providing an override variable for each
  606 affected directory.  For example, `make install
  607 prefix=/alternate/directory' will choose an alternate location for all
  608 directory configuration variables that were expressed in terms of
  609 `${prefix}'.  Any directories that were specified during `configure',
  610 but not in terms of `${prefix}', must each be overridden at install
  611 time for the entire installation to be relocated.  The approach of
  612 makefile variable overrides for each directory variable is required by
  613 the GNU Coding Standards, and ideally causes no recompilation.
  614 However, some platforms have known limitations with the semantics of
  615 shared libraries that end up requiring recompilation when using this
  616 method, particularly noticeable in packages that use GNU Libtool.
  618    The second method involves providing the `DESTDIR' variable.  For
  619 example, `make install DESTDIR=/alternate/directory' will prepend
  620 `/alternate/directory' before all installation names.  The approach of
  621 `DESTDIR' overrides is not required by the GNU Coding Standards, and
  622 does not work on platforms that have drive letters.  On the other hand,
  623 it does better at avoiding recompilation issues, and works well even
  624 when some directory options were not specified in terms of `${prefix}'
  625 at `configure' time.
  627 Optional Features
  628 =================
  630    If the package supports it, you can cause programs to be installed
  631 with an extra prefix or suffix on their names by giving `configure' the
  632 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
  634    Some packages pay attention to `--enable-FEATURE' options to
  635 `configure', where FEATURE indicates an optional part of the package.
  636 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
  637 is something like `gnu-as' or `x' (for the X Window System).
  639    For packages that use the X Window System, `configure' can usually
  640 find the X include and library files automatically, but if it doesn't,
  641 you can use the `configure' options `--x-includes=DIR' and
  642 `--x-libraries=DIR' to specify their locations.
  644    Some packages offer the ability to configure how verbose the
  645 execution of `make' will be.  For these packages, running `./configure
  646 --enable-silent-rules' sets the default to minimal output, which can be
  647 overridden with `make V=1'; while running `./configure
  648 --disable-silent-rules' sets the default to verbose, which can be
  649 overridden with `make V=0'.
  651 Particular systems
  652 ==================
  654    On HP-UX, the default C compiler is not ANSI C compatible.  If GNU
  655 CC is not installed, it is recommended to use the following options in
  656 order to use an ANSI C compiler:
  658      ./configure CC="cc -Ae -D_XOPEN_SOURCE=500"
  660 and if that doesn't work, install pre-built binaries of GCC for HP-UX.
  662    On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
  663 parse its `<wchar.h>' header file.  The option `-nodtk' can be used as
  664 a workaround.  If GNU CC is not installed, it is therefore recommended
  665 to try
  667      ./configure CC="cc"
  669 and if that doesn't work, try
  671      ./configure CC="cc -nodtk"
  673    On Solaris, don't put `/usr/ucb' early in your `PATH'.  This
  674 directory contains several dysfunctional programs; working variants of
  675 these programs are available in `/usr/bin'.  So, if you need `/usr/ucb'
  676 in your `PATH', put it _after_ `/usr/bin'.
  678    On Haiku, software installed for all users goes in `/boot/common',
  679 not `/usr/local'.  It is recommended to use the following options:
  681      ./configure --prefix=/boot/common
  683 Specifying the System Type
  684 ==========================
  686    There may be some features `configure' cannot figure out
  687 automatically, but needs to determine by the type of machine the package
  688 will run on.  Usually, assuming the package is built to be run on the
  689 _same_ architectures, `configure' can figure that out, but if it prints
  690 a message saying it cannot guess the machine type, give it the
  691 `--build=TYPE' option.  TYPE can either be a short name for the system
  692 type, such as `sun4', or a canonical name which has the form:
  696 where SYSTEM can have one of these forms:
  698      OS
  699      KERNEL-OS
  701    See the file `config.sub' for the possible values of each field.  If
  702 `config.sub' isn't included in this package, then this package doesn't
  703 need to know the machine type.
  705    If you are _building_ compiler tools for cross-compiling, you should
  706 use the option `--target=TYPE' to select the type of system they will
  707 produce code for.
  709    If you want to _use_ a cross compiler, that generates code for a
  710 platform different from the build platform, you should specify the
  711 "host" platform (i.e., that on which the generated programs will
  712 eventually be run) with `--host=TYPE'.
  714 Sharing Defaults
  715 ================
  717    If you want to set default values for `configure' scripts to share,
  718 you can create a site shell script called `config.site' that gives
  719 default values for variables like `CC', `cache_file', and `prefix'.
  720 `configure' looks for `PREFIX/share/config.site' if it exists, then
  721 `PREFIX/etc/config.site' if it exists.  Or, you can set the
  722 `CONFIG_SITE' environment variable to the location of the site script.
  723 A warning: not all `configure' scripts look for a site script.
  725 Defining Variables
  726 ==================
  728    Variables not defined in a site shell script can be set in the
  729 environment passed to `configure'.  However, some packages may run
  730 configure again during the build, and the customized values of these
  731 variables may be lost.  In order to avoid this problem, you should set
  732 them in the `configure' command line, using `VAR=value'.  For example:
  734      ./configure CC=/usr/local2/bin/gcc
  736 causes the specified `gcc' to be used as the C compiler (unless it is
  737 overridden in the site shell script).
  739 Unfortunately, this technique does not work for `CONFIG_SHELL' due to
  740 an Autoconf bug.  Until the bug is fixed you can use this workaround:
  742      CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
  744 `configure' Invocation
  745 ======================
  747    `configure' recognizes the following options to control how it
  748 operates.
  750 `--help'
  751 `-h'
  752      Print a summary of all of the options to `configure', and exit.
  754 `--help=short'
  755 `--help=recursive'
  756      Print a summary of the options unique to this package's
  757      `configure', and exit.  The `short' variant lists options used
  758      only in the top level, while the `recursive' variant lists options
  759      also present in any nested packages.
  761 `--version'
  762 `-V'
  763      Print the version of Autoconf used to generate the `configure'
  764      script, and exit.
  766 `--cache-file=FILE'
  767      Enable the cache: use and save the results of the tests in FILE,
  768      traditionally `config.cache'.  FILE defaults to `/dev/null' to
  769      disable caching.
  771 `--config-cache'
  772 `-C'
  773      Alias for `--cache-file=config.cache'.
  775 `--quiet'
  776 `--silent'
  777 `-q'
  778      Do not print messages saying which checks are being made.  To
  779      suppress all normal output, redirect it to `/dev/null' (any error
  780      messages will still be shown).
  782 `--srcdir=DIR'
  783      Look for the package's source code in directory DIR.  Usually
  784      `configure' can determine that directory automatically.
  786 `--prefix=DIR'
  787      Use DIR as the installation prefix.  *note Installation Names::
  788      for more details, including other options available for fine-tuning
  789      the installation locations.
  791 `--no-create'
  792 `-n'
  793      Run the configure checks, but stop before creating any output
  794      files.
  796 `configure' also accepts some other, not widely useful, options.  Run
  797 `configure --help' for more details.