Blame INSTALL

Packit Service 9def5d
Installation Instructions
Packit Service 9def5d
*************************
Packit Service 9def5d
Packit Service 9def5d
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
Packit Service 9def5d
2006, 2007 Free Software Foundation, Inc.
Packit Service 9def5d
Packit Service 9def5d
This file is free documentation; the Free Software Foundation gives
Packit Service 9def5d
unlimited permission to copy, distribute and modify it.
Packit Service 9def5d
Packit Service 9def5d
Glog-Specific Install Notes
Packit Service 9def5d
================================
Packit Service 9def5d
Packit Service 9def5d
*** NOTE FOR 64-BIT LINUX SYSTEMS
Packit Service 9def5d
Packit Service 9def5d
The glibc built-in stack-unwinder on 64-bit systems has some problems
Packit Service 9def5d
with the glog libraries.  (In particular, if you are using
Packit Service 9def5d
InstallFailureSignalHandler(), the signal may be raised in the middle
Packit Service 9def5d
of malloc, holding some malloc-related locks when they invoke the
Packit Service 9def5d
stack unwinder.  The built-in stack unwinder may call malloc
Packit Service 9def5d
recursively, which may require the thread to acquire a lock it already
Packit Service 9def5d
holds: deadlock.)
Packit Service 9def5d
Packit Service 9def5d
For that reason, if you use a 64-bit system and you need
Packit Service 9def5d
InstallFailureSignalHandler(), we strongly recommend you install
Packit Service 9def5d
libunwind before trying to configure or install google glog.
Packit Service 9def5d
libunwind can be found at
Packit Service 9def5d
Packit Service 9def5d
   http://download.savannah.nongnu.org/releases/libunwind/libunwind-snap-070410.tar.gz
Packit Service 9def5d
Packit Service 9def5d
Even if you already have libunwind installed, you will probably still
Packit Service 9def5d
need to install from the snapshot to get the latest version.
Packit Service 9def5d
Packit Service 9def5d
CAUTION: if you install libunwind from the URL above, be aware that
Packit Service 9def5d
you may have trouble if you try to statically link your binary with
Packit Service 9def5d
glog: that is, if you link with 'gcc -static -lgcc_eh ...'.  This
Packit Service 9def5d
is because both libunwind and libgcc implement the same C++ exception
Packit Service 9def5d
handling APIs, but they implement them differently on some platforms.
Packit Service 9def5d
This is not likely to be a problem on ia64, but may be on x86-64.
Packit Service 9def5d
Packit Service 9def5d
Also, if you link binaries statically, make sure that you add
Packit Service 9def5d
-Wl,--eh-frame-hdr to your linker options. This is required so that
Packit Service 9def5d
libunwind can find the information generated by the compiler required
Packit Service 9def5d
for stack unwinding.
Packit Service 9def5d
Packit Service 9def5d
Using -static is rare, though, so unless you know this will affect you
Packit Service 9def5d
it probably won't.
Packit Service 9def5d
Packit Service 9def5d
If you cannot or do not wish to install libunwind, you can still try
Packit Service 9def5d
to use two kinds of stack-unwinder: 1. glibc built-in stack-unwinder
Packit Service 9def5d
and 2. frame pointer based stack-unwinder.
Packit Service 9def5d
Packit Service 9def5d
1. As we already mentioned, glibc's unwinder has a deadlock issue.
Packit Service 9def5d
However, if you don't use InstallFailureSignalHandler() or you don't
Packit Service 9def5d
worry about the rare possibilities of deadlocks, you can use this
Packit Service 9def5d
stack-unwinder.  If you specify no options and libunwind isn't
Packit Service 9def5d
detected on your system, the configure script chooses this unwinder by
Packit Service 9def5d
default.
Packit Service 9def5d
Packit Service 9def5d
2. The frame pointer based stack unwinder requires that your
Packit Service 9def5d
application, the glog library, and system libraries like libc, all be
Packit Service 9def5d
compiled with a frame pointer.  This is *not* the default for x86-64.
Packit Service 9def5d
Packit Service 9def5d
If you are on x86-64 system, know that you have a set of system
Packit Service 9def5d
libraries with frame-pointers enabled, and compile all your
Packit Service 9def5d
applications with -fno-omit-frame-pointer, then you can enable the
Packit Service 9def5d
frame pointer based stack unwinder by passing the
Packit Service 9def5d
--enable-frame-pointers flag to configure.
Packit Service 9def5d
Packit Service 9def5d
Packit Service 9def5d
Basic Installation
Packit Service 9def5d
==================
Packit Service 9def5d
Packit Service 9def5d
Briefly, the shell commands `./configure; make; make install' should
Packit Service 9def5d
configure, build, and install this package.  The following
Packit Service 9def5d
more-detailed instructions are generic; see the `README' file for
Packit Service 9def5d
instructions specific to this package.
Packit Service 9def5d
Packit Service 9def5d
   The `configure' shell script attempts to guess correct values for
Packit Service 9def5d
various system-dependent variables used during compilation.  It uses
Packit Service 9def5d
those values to create a `Makefile' in each directory of the package.
Packit Service 9def5d
It may also create one or more `.h' files containing system-dependent
Packit Service 9def5d
definitions.  Finally, it creates a shell script `config.status' that
Packit Service 9def5d
you can run in the future to recreate the current configuration, and a
Packit Service 9def5d
file `config.log' containing compiler output (useful mainly for
Packit Service 9def5d
debugging `configure').
Packit Service 9def5d
Packit Service 9def5d
   It can also use an optional file (typically called `config.cache'
Packit Service 9def5d
and enabled with `--cache-file=config.cache' or simply `-C') that saves
Packit Service 9def5d
the results of its tests to speed up reconfiguring.  Caching is
Packit Service 9def5d
disabled by default to prevent problems with accidental use of stale
Packit Service 9def5d
cache files.
Packit Service 9def5d
Packit Service 9def5d
   If you need to do unusual things to compile the package, please try
Packit Service 9def5d
to figure out how `configure' could check whether to do them, and mail
Packit Service 9def5d
diffs or instructions to the address given in the `README' so they can
Packit Service 9def5d
be considered for the next release.  If you are using the cache, and at
Packit Service 9def5d
some point `config.cache' contains results you don't want to keep, you
Packit Service 9def5d
may remove or edit it.
Packit Service 9def5d
Packit Service 9def5d
   The file `configure.ac' (or `configure.in') is used to create
Packit Service 9def5d
`configure' by a program called `autoconf'.  You need `configure.ac' if
Packit Service 9def5d
you want to change it or regenerate `configure' using a newer version
Packit Service 9def5d
of `autoconf'.
Packit Service 9def5d
Packit Service 9def5d
The simplest way to compile this package is:
Packit Service 9def5d
Packit Service 9def5d
  1. `cd' to the directory containing the package's source code and type
Packit Service 9def5d
     `./configure' to configure the package for your system.
Packit Service 9def5d
Packit Service 9def5d
     Running `configure' might take a while.  While running, it prints
Packit Service 9def5d
     some messages telling which features it is checking for.
Packit Service 9def5d
Packit Service 9def5d
  2. Type `make' to compile the package.
Packit Service 9def5d
Packit Service 9def5d
  3. Optionally, type `make check' to run any self-tests that come with
Packit Service 9def5d
     the package.
Packit Service 9def5d
Packit Service 9def5d
  4. Type `make install' to install the programs and any data files and
Packit Service 9def5d
     documentation.
Packit Service 9def5d
Packit Service 9def5d
  5. You can remove the program binaries and object files from the
Packit Service 9def5d
     source code directory by typing `make clean'.  To also remove the
Packit Service 9def5d
     files that `configure' created (so you can compile the package for
Packit Service 9def5d
     a different kind of computer), type `make distclean'.  There is
Packit Service 9def5d
     also a `make maintainer-clean' target, but that is intended mainly
Packit Service 9def5d
     for the package's developers.  If you use it, you may have to get
Packit Service 9def5d
     all sorts of other programs in order to regenerate files that came
Packit Service 9def5d
     with the distribution.
Packit Service 9def5d
Packit Service 9def5d
  6. Often, you can also type `make uninstall' to remove the installed
Packit Service 9def5d
     files again.
Packit Service 9def5d
Packit Service 9def5d
Compilers and Options
Packit Service 9def5d
=====================
Packit Service 9def5d
Packit Service 9def5d
Some systems require unusual options for compilation or linking that the
Packit Service 9def5d
`configure' script does not know about.  Run `./configure --help' for
Packit Service 9def5d
details on some of the pertinent environment variables.
Packit Service 9def5d
Packit Service 9def5d
   You can give `configure' initial values for configuration parameters
Packit Service 9def5d
by setting variables in the command line or in the environment.  Here
Packit Service 9def5d
is an example:
Packit Service 9def5d
Packit Service 9def5d
     ./configure CC=c99 CFLAGS=-g LIBS=-lposix
Packit Service 9def5d
Packit Service 9def5d
   *Note Defining Variables::, for more details.
Packit Service 9def5d
Packit Service 9def5d
Compiling For Multiple Architectures
Packit Service 9def5d
====================================
Packit Service 9def5d
Packit Service 9def5d
You can compile the package for more than one kind of computer at the
Packit Service 9def5d
same time, by placing the object files for each architecture in their
Packit Service 9def5d
own directory.  To do this, you can use GNU `make'.  `cd' to the
Packit Service 9def5d
directory where you want the object files and executables to go and run
Packit Service 9def5d
the `configure' script.  `configure' automatically checks for the
Packit Service 9def5d
source code in the directory that `configure' is in and in `..'.
Packit Service 9def5d
Packit Service 9def5d
   With a non-GNU `make', it is safer to compile the package for one
Packit Service 9def5d
architecture at a time in the source code directory.  After you have
Packit Service 9def5d
installed the package for one architecture, use `make distclean' before
Packit Service 9def5d
reconfiguring for another architecture.
Packit Service 9def5d
Packit Service 9def5d
Installation Names
Packit Service 9def5d
==================
Packit Service 9def5d
Packit Service 9def5d
By default, `make install' installs the package's commands under
Packit Service 9def5d
`/usr/local/bin', include files under `/usr/local/include', etc.  You
Packit Service 9def5d
can specify an installation prefix other than `/usr/local' by giving
Packit Service 9def5d
`configure' the option `--prefix=PREFIX'.
Packit Service 9def5d
Packit Service 9def5d
   You can specify separate installation prefixes for
Packit Service 9def5d
architecture-specific files and architecture-independent files.  If you
Packit Service 9def5d
pass the option `--exec-prefix=PREFIX' to `configure', the package uses
Packit Service 9def5d
PREFIX as the prefix for installing programs and libraries.
Packit Service 9def5d
Documentation and other data files still use the regular prefix.
Packit Service 9def5d
Packit Service 9def5d
   In addition, if you use an unusual directory layout you can give
Packit Service 9def5d
options like `--bindir=DIR' to specify different values for particular
Packit Service 9def5d
kinds of files.  Run `configure --help' for a list of the directories
Packit Service 9def5d
you can set and what kinds of files go in them.
Packit Service 9def5d
Packit Service 9def5d
   If the package supports it, you can cause programs to be installed
Packit Service 9def5d
with an extra prefix or suffix on their names by giving `configure' the
Packit Service 9def5d
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
Packit Service 9def5d
Packit Service 9def5d
Optional Features
Packit Service 9def5d
=================
Packit Service 9def5d
Packit Service 9def5d
Some packages pay attention to `--enable-FEATURE' options to
Packit Service 9def5d
`configure', where FEATURE indicates an optional part of the package.
Packit Service 9def5d
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
Packit Service 9def5d
is something like `gnu-as' or `x' (for the X Window System).  The
Packit Service 9def5d
`README' should mention any `--enable-' and `--with-' options that the
Packit Service 9def5d
package recognizes.
Packit Service 9def5d
Packit Service 9def5d
   For packages that use the X Window System, `configure' can usually
Packit Service 9def5d
find the X include and library files automatically, but if it doesn't,
Packit Service 9def5d
you can use the `configure' options `--x-includes=DIR' and
Packit Service 9def5d
`--x-libraries=DIR' to specify their locations.
Packit Service 9def5d
Packit Service 9def5d
Specifying the System Type
Packit Service 9def5d
==========================
Packit Service 9def5d
Packit Service 9def5d
There may be some features `configure' cannot figure out automatically,
Packit Service 9def5d
but needs to determine by the type of machine the package will run on.
Packit Service 9def5d
Usually, assuming the package is built to be run on the _same_
Packit Service 9def5d
architectures, `configure' can figure that out, but if it prints a
Packit Service 9def5d
message saying it cannot guess the machine type, give it the
Packit Service 9def5d
`--build=TYPE' option.  TYPE can either be a short name for the system
Packit Service 9def5d
type, such as `sun4', or a canonical name which has the form:
Packit Service 9def5d
Packit Service 9def5d
     CPU-COMPANY-SYSTEM
Packit Service 9def5d
Packit Service 9def5d
where SYSTEM can have one of these forms:
Packit Service 9def5d
Packit Service 9def5d
     OS KERNEL-OS
Packit Service 9def5d
Packit Service 9def5d
   See the file `config.sub' for the possible values of each field.  If
Packit Service 9def5d
`config.sub' isn't included in this package, then this package doesn't
Packit Service 9def5d
need to know the machine type.
Packit Service 9def5d
Packit Service 9def5d
   If you are _building_ compiler tools for cross-compiling, you should
Packit Service 9def5d
use the option `--target=TYPE' to select the type of system they will
Packit Service 9def5d
produce code for.
Packit Service 9def5d
Packit Service 9def5d
   If you want to _use_ a cross compiler, that generates code for a
Packit Service 9def5d
platform different from the build platform, you should specify the
Packit Service 9def5d
"host" platform (i.e., that on which the generated programs will
Packit Service 9def5d
eventually be run) with `--host=TYPE'.
Packit Service 9def5d
Packit Service 9def5d
Sharing Defaults
Packit Service 9def5d
================
Packit Service 9def5d
Packit Service 9def5d
If you want to set default values for `configure' scripts to share, you
Packit Service 9def5d
can create a site shell script called `config.site' that gives default
Packit Service 9def5d
values for variables like `CC', `cache_file', and `prefix'.
Packit Service 9def5d
`configure' looks for `PREFIX/share/config.site' if it exists, then
Packit Service 9def5d
`PREFIX/etc/config.site' if it exists.  Or, you can set the
Packit Service 9def5d
`CONFIG_SITE' environment variable to the location of the site script.
Packit Service 9def5d
A warning: not all `configure' scripts look for a site script.
Packit Service 9def5d
Packit Service 9def5d
Defining Variables
Packit Service 9def5d
==================
Packit Service 9def5d
Packit Service 9def5d
Variables not defined in a site shell script can be set in the
Packit Service 9def5d
environment passed to `configure'.  However, some packages may run
Packit Service 9def5d
configure again during the build, and the customized values of these
Packit Service 9def5d
variables may be lost.  In order to avoid this problem, you should set
Packit Service 9def5d
them in the `configure' command line, using `VAR=value'.  For example:
Packit Service 9def5d
Packit Service 9def5d
     ./configure CC=/usr/local2/bin/gcc
Packit Service 9def5d
Packit Service 9def5d
causes the specified `gcc' to be used as the C compiler (unless it is
Packit Service 9def5d
overridden in the site shell script).
Packit Service 9def5d
Packit Service 9def5d
Unfortunately, this technique does not work for `CONFIG_SHELL' due to
Packit Service 9def5d
an Autoconf bug.  Until the bug is fixed you can use this workaround:
Packit Service 9def5d
Packit Service 9def5d
     CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
Packit Service 9def5d
Packit Service 9def5d
`configure' Invocation
Packit Service 9def5d
======================
Packit Service 9def5d
Packit Service 9def5d
`configure' recognizes the following options to control how it operates.
Packit Service 9def5d
Packit Service 9def5d
`--help'
Packit Service 9def5d
`-h'
Packit Service 9def5d
     Print a summary of the options to `configure', and exit.
Packit Service 9def5d
Packit Service 9def5d
`--version'
Packit Service 9def5d
`-V'
Packit Service 9def5d
     Print the version of Autoconf used to generate the `configure'
Packit Service 9def5d
     script, and exit.
Packit Service 9def5d
Packit Service 9def5d
`--cache-file=FILE'
Packit Service 9def5d
     Enable the cache: use and save the results of the tests in FILE,
Packit Service 9def5d
     traditionally `config.cache'.  FILE defaults to `/dev/null' to
Packit Service 9def5d
     disable caching.
Packit Service 9def5d
Packit Service 9def5d
`--config-cache'
Packit Service 9def5d
`-C'
Packit Service 9def5d
     Alias for `--cache-file=config.cache'.
Packit Service 9def5d
Packit Service 9def5d
`--quiet'
Packit Service 9def5d
`--silent'
Packit Service 9def5d
`-q'
Packit Service 9def5d
     Do not print messages saying which checks are being made.  To
Packit Service 9def5d
     suppress all normal output, redirect it to `/dev/null' (any error
Packit Service 9def5d
     messages will still be shown).
Packit Service 9def5d
Packit Service 9def5d
`--srcdir=DIR'
Packit Service 9def5d
     Look for the package's source code in directory DIR.  Usually
Packit Service 9def5d
     `configure' can determine that directory automatically.
Packit Service 9def5d
Packit Service 9def5d
`configure' also accepts some other, not widely useful, options.  Run
Packit Service 9def5d
`configure --help' for more details.
Packit Service 9def5d