INSTALL

   1 Installation Instructions
   2 *************************
   3
   4 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
   5 2006 Free Software Foundation, Inc.
   6
   7 This file is free documentation; the Free Software Foundation gives
   8 unlimited permission to copy, distribute and modify it.
   9
  10 Basic Installation
  11 ==================
  12
  13 You will need to build and install two libraries before you can
  14 properly build pacman.
  15
  16 libarchive
  17 http://code.google.com/p/libarchive/
  18
  19 libcurl
  20 http://curl.haxx.se/libcurl/
  21
  22 Briefly, the shell commands `./configure; make; make install' should
  23 configure, build, and install this package.  The following
  24 instructions are generic. Run `./configure --help` for specific
  25 options.
  26
  27    The `configure' shell script attempts to guess correct values for
  28 various system-dependent variables used during compilation.  It uses
  29 those values to create a `Makefile' in each directory of the package.
  30 It may also create one or more `.h' files containing system-dependent
  31 definitions.  Finally, it creates a shell script `config.status' that
  32 you can run in the future to recreate the current configuration, and a
  33 file `config.log' containing compiler output (useful mainly for
  34 debugging `configure').
  35
  36    It can also use an optional file (typically called `config.cache'
  37 and enabled with `--cache-file=config.cache' or simply `-C') that saves
  38 the results of its tests to speed up reconfiguring.  Caching is
  39 disabled by default to prevent problems with accidental use of stale
  40 cache files.
  41
  42    If you need to do unusual things to compile the package, please try
  43 to figure out how `configure' could check whether to do them, and mail
  44 diffs or instructions to the address given in the `README' so they can
  45 be considered for the next release.  If you are using the cache, and at
  46 some point `config.cache' contains results you don't want to keep, you
  47 may remove or edit it.
  48
  49    The file `configure.ac' (or `configure.in') is used to create
  50 `configure' by a program called `autoconf'.  You need `configure.ac' if
  51 you want to change it or regenerate `configure' using a newer version
  52 of `autoconf'.
  53
  54 The simplest way to compile this package is:
  55
  56   1. `cd' to the directory containing the package's source code and type
  57      `./configure' to configure the package for your system.
  58
  59      Running `configure' might take a while.  While running, it prints
  60      some messages telling which features it is checking for.
  61
  62   2. Type `make' to compile the package.
  63
  64   3. Optionally, type `make check' to run any self-tests that come with
  65      the package.
  66
  67   4. Type `make install' to install the programs and any data files and
  68      documentation.
  69
  70   5. You can remove the program binaries and object files from the
  71      source code directory by typing `make clean'.  To also remove the
  72      files that `configure' created (so you can compile the package for
  73      a different kind of computer), type `make distclean'.  There is
  74      also a `make maintainer-clean' target, but that is intended mainly
  75      for the package's developers.  If you use it, you may have to get
  76      all sorts of other programs in order to regenerate files that came
  77      with the distribution.
  78
  79 Compilers and Options
  80 =====================
  81
  82 Some systems require unusual options for compilation or linking that the
  83 `configure' script does not know about.  Run `./configure --help' for
  84 details on some of the pertinent environment variables.
  85
  86    You can give `configure' initial values for configuration parameters
  87 by setting variables in the command line or in the environment.  Here
  88 is an example:
  89
  90      ./configure CC=c99 CFLAGS=-g LIBS=-lposix
  91
  92    *Note Defining Variables::, for more details.
  93
  94 Compiling For Multiple Architectures
  95 ====================================
  96
  97 You can compile the package for more than one kind of computer at the
  98 same time, by placing the object files for each architecture in their
  99 own directory.  To do this, you can use GNU `make'.  `cd' to the
 100 directory where you want the object files and executables to go and run
 101 the `configure' script.  `configure' automatically checks for the
 102 source code in the directory that `configure' is in and in `..'.
 103
 104    With a non-GNU `make', it is safer to compile the package for one
 105 architecture at a time in the source code directory.  After you have
 106 installed the package for one architecture, use `make distclean' before
 107 reconfiguring for another architecture.
 108
 109 Installation Names
 110 ==================
 111
 112 By default, `make install' installs the package's commands under
 113 `/usr/local/bin', include files under `/usr/local/include', etc.  You
 114 can specify an installation prefix other than `/usr/local' by giving
 115 `configure' the option `--prefix=PREFIX'.
 116
 117    You can specify separate installation prefixes for
 118 architecture-specific files and architecture-independent files.  If you
 119 pass the option `--exec-prefix=PREFIX' to `configure', the package uses
 120 PREFIX as the prefix for installing programs and libraries.
 121 Documentation and other data files still use the regular prefix.
 122
 123    In addition, if you use an unusual directory layout you can give
 124 options like `--bindir=DIR' to specify different values for particular
 125 kinds of files.  Run `configure --help' for a list of the directories
 126 you can set and what kinds of files go in them.
 127
 128    If the package supports it, you can cause programs to be installed
 129 with an extra prefix or suffix on their names by giving `configure' the
 130 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 131
 132 Optional Features
 133 =================
 134
 135 Some packages pay attention to `--enable-FEATURE' options to
 136 `configure', where FEATURE indicates an optional part of the package.
 137 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 138 is something like `gnu-as' or `x' (for the X Window System).  The
 139 `README' should mention any `--enable-' and `--with-' options that the
 140 package recognizes.
 141
 142    For packages that use the X Window System, `configure' can usually
 143 find the X include and library files automatically, but if it doesn't,
 144 you can use the `configure' options `--x-includes=DIR' and
 145 `--x-libraries=DIR' to specify their locations.
 146
 147 Specifying the System Type
 148 ==========================
 149
 150 There may be some features `configure' cannot figure out automatically,
 151 but needs to determine by the type of machine the package will run on.
 152 Usually, assuming the package is built to be run on the _same_
 153 architectures, `configure' can figure that out, but if it prints a
 154 message saying it cannot guess the machine type, give it the
 155 `--build=TYPE' option.  TYPE can either be a short name for the system
 156 type, such as `sun4', or a canonical name which has the form:
 157
 158      CPU-COMPANY-SYSTEM
 159
 160 where SYSTEM can have one of these forms:
 161
 162      OS KERNEL-OS
 163
 164    See the file `config.sub' for the possible values of each field.  If
 165 `config.sub' isn't included in this package, then this package doesn't
 166 need to know the machine type.
 167
 168    If you are _building_ compiler tools for cross-compiling, you should
 169 use the option `--target=TYPE' to select the type of system they will
 170 produce code for.
 171
 172    If you want to _use_ a cross compiler, that generates code for a
 173 platform different from the build platform, you should specify the
 174 "host" platform (i.e., that on which the generated programs will
 175 eventually be run) with `--host=TYPE'.
 176
 177 Sharing Defaults
 178 ================
 179
 180 If you want to set default values for `configure' scripts to share, you
 181 can create a site shell script called `config.site' that gives default
 182 values for variables like `CC', `cache_file', and `prefix'.
 183 `configure' looks for `PREFIX/share/config.site' if it exists, then
 184 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 185 `CONFIG_SITE' environment variable to the location of the site script.
 186 A warning: not all `configure' scripts look for a site script.
 187
 188 Defining Variables
 189 ==================
 190
 191 Variables not defined in a site shell script can be set in the
 192 environment passed to `configure'.  However, some packages may run
 193 configure again during the build, and the customized values of these
 194 variables may be lost.  In order to avoid this problem, you should set
 195 them in the `configure' command line, using `VAR=value'.  For example:
 196
 197      ./configure CC=/usr/local2/bin/gcc
 198
 199 causes the specified `gcc' to be used as the C compiler (unless it is
 200 overridden in the site shell script).
 201
 202 Unfortunately, this technique does not work for `CONFIG_SHELL' due to
 203 an Autoconf bug.  Until the bug is fixed you can use this workaround:
 204
 205      CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
 206
 207 `configure' Invocation
 208 ======================
 209
 210 `configure' recognizes the following options to control how it operates.
 211
 212 `--help'
 213 `-h'
 214      Print a summary of the options to `configure', and exit.
 215
 216 `--version'
 217 `-V'
 218      Print the version of Autoconf used to generate the `configure'
 219      script, and exit.
 220
 221 `--cache-file=FILE'
 222      Enable the cache: use and save the results of the tests in FILE,
 223      traditionally `config.cache'.  FILE defaults to `/dev/null' to
 224      disable caching.
 225
 226 `--config-cache'
 227 `-C'
 228      Alias for `--cache-file=config.cache'.
 229
 230 `--quiet'
 231 `--silent'
 232 `-q'
 233      Do not print messages saying which checks are being made.  To
 234      suppress all normal output, redirect it to `/dev/null' (any error
 235      messages will still be shown).
 236
 237 `--srcdir=DIR'
 238      Look for the package's source code in directory DIR.  Usually
 239      `configure' can determine that directory automatically.
 240
 241 `configure' also accepts some other, not widely useful, options.  Run
 242 `configure --help' for more details.
 243