INSTALL

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