INSTALL

   1            DBus GLib Installation
   2            =================
   3
   4 Quick start
   5 ===========
   6
   7 DBus uses GNU AutoTools for its build system, thus the basic install
   8 procedure can be summarized as:
   9
  10     ./configure --prefix=/usr
  11     make
  12     su make install
  13
  14 The configure script will automatically determine whether to try and
  15 build bindings for GLib, Qt, Qt3, Python and Mono based on what tools
  16 are installed on the host system. The default build behaviour can be
  17 overridden using the --enable-XXX/--disable-XXX arguments to configure.
  18 A typical scenario in which it is desirable to override automatic
  19 detection, is during packaging of binary builds, where a predictable
  20 dependancy chain is required. For more details on GNU AutoTools
  21 installation, consult the generic instructions later in this document
  22
  23 External software dependancies
  24 ==============================
  25
  26  Requisite:
  27
  28   - GLib >= 2.6
  29
  30  Optional:
  31
  32   - gtk-doc (for API documentation)
  33
  34 ====================================================================
  35
  36 The rest of this document contains the generic GNU AutoTools install
  37 insructions....
  38
  39 Basic Installation
  40 ==================
  41
  42    These are generic installation instructions.
  43
  44    The `configure' shell script attempts to guess correct values for
  45 various system-dependent variables used during compilation.  It uses
  46 those values to create a `Makefile' in each directory of the package.
  47 It may also create one or more `.h' files containing system-dependent
  48 definitions.  Finally, it creates a shell script `config.status' that
  49 you can run in the future to recreate the current configuration, a file
  50 `config.cache' that saves the results of its tests to speed up
  51 reconfiguring, and a file `config.log' containing compiler output
  52 (useful mainly for debugging `configure').
  53
  54    If you need to do unusual things to compile the package, please try
  55 to figure out how `configure' could check whether to do them, and mail
  56 diffs or instructions to the address given in the `README' so they can
  57 be considered for the next release.  If at some point `config.cache'
  58 contains results you don't want to keep, you may remove or edit it.
  59
  60    The file `configure.in' is used to create `configure' by a program
  61 called `autoconf'.  You only need `configure.in' if you want to change
  62 it or regenerate `configure' using a newer version of `autoconf'.
  63
  64 The simplest way to compile this package is:
  65
  66   1. `cd' to the directory containing the package's source code and type
  67      `./configure' to configure the package for your system.  If you're
  68      using `csh' on an old version of System V, you might need to type
  69      `sh ./configure' instead to prevent `csh' from trying to execute
  70      `configure' itself.
  71
  72      Running `configure' takes awhile.  While running, it prints some
  73      messages telling which features it is checking for.
  74
  75   2. Type `make' to compile the package.
  76
  77   3. Optionally, type `make check' to run any self-tests that come with
  78      the package.
  79
  80   4. Type `make install' to install the programs and any data files and
  81      documentation.
  82
  83   5. You can remove the program binaries and object files from the
  84      source code directory by typing `make clean'.  To also remove the
  85      files that `configure' created (so you can compile the package for
  86      a different kind of computer), type `make distclean'.  There is
  87      also a `make maintainer-clean' target, but that is intended mainly
  88      for the package's developers.  If you use it, you may have to get
  89      all sorts of other programs in order to regenerate files that came
  90      with the distribution.
  91
  92 Compilers and Options
  93 =====================
  94
  95    Some systems require unusual options for compilation or linking that
  96 the `configure' script does not know about.  You can give `configure'
  97 initial values for variables by setting them in the environment.  Using
  98 a Bourne-compatible shell, you can do that on the command line like
  99 this:
 100      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
 101
 102 Or on systems that have the `env' program, you can do it like this:
 103      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
 104
 105 Compiling For Multiple Architectures
 106 ====================================
 107
 108    You can compile the package for more than one kind of computer at the
 109 same time, by placing the object files for each architecture in their
 110 own directory.  To do this, you must use a version of `make' that
 111 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
 112 directory where you want the object files and executables to go and run
 113 the `configure' script.  `configure' automatically checks for the
 114 source code in the directory that `configure' is in and in `..'.
 115
 116    If you have to use a `make' that does not supports the `VPATH'
 117 variable, you have to compile the package for one architecture at a time
 118 in the source code directory.  After you have installed the package for
 119 one architecture, use `make distclean' before reconfiguring for another
 120 architecture.
 121
 122 Installation Names
 123 ==================
 124
 125    By default, `make install' will install the package's files in
 126 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
 127 installation prefix other than `/usr/local' by giving `configure' the
 128 option `--prefix=PATH'.
 129
 130    You can specify separate installation prefixes for
 131 architecture-specific files and architecture-independent files.  If you
 132 give `configure' the option `--exec-prefix=PATH', the package will use
 133 PATH as the prefix for installing programs and libraries.
 134 Documentation and other data files will still use the regular prefix.
 135
 136    In addition, if you use an unusual directory layout you can give
 137 options like `--bindir=PATH' to specify different values for particular
 138 kinds of files.  Run `configure --help' for a list of the directories
 139 you can set and what kinds of files go in them.
 140
 141    If the package supports it, you can cause programs to be installed
 142 with an extra prefix or suffix on their names by giving `configure' the
 143 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 144
 145 Optional Features
 146 =================
 147
 148    Some packages pay attention to `--enable-FEATURE' options to
 149 `configure', where FEATURE indicates an optional part of the package.
 150 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 151 is something like `gnu-as' or `x' (for the X Window System).  The
 152 `README' should mention any `--enable-' and `--with-' options that the
 153 package recognizes.
 154
 155    For packages that use the X Window System, `configure' can usually
 156 find the X include and library files automatically, but if it doesn't,
 157 you can use the `configure' options `--x-includes=DIR' and
 158 `--x-libraries=DIR' to specify their locations.
 159
 160 Specifying the System Type
 161 ==========================
 162
 163    There may be some features `configure' can not figure out
 164 automatically, but needs to determine by the type of host the package
 165 will run on.  Usually `configure' can figure that out, but if it prints
 166 a message saying it can not guess the host type, give it the
 167 `--host=TYPE' option.  TYPE can either be a short name for the system
 168 type, such as `sun4', or a canonical name with three fields:
 169      CPU-COMPANY-SYSTEM
 170
 171 See the file `config.sub' for the possible values of each field.  If
 172 `config.sub' isn't included in this package, then this package doesn't
 173 need to know the host type.
 174
 175    If you are building compiler tools for cross-compiling, you can also
 176 use the `--target=TYPE' option to select the type of system they will
 177 produce code for and the `--build=TYPE' option to select the type of
 178 system on which you are compiling the package.
 179
 180 Sharing Defaults
 181 ================
 182
 183    If you want to set default values for `configure' scripts to share,
 184 you can create a site shell script called `config.site' that gives
 185 default values for variables like `CC', `cache_file', and `prefix'.
 186 `configure' looks for `PREFIX/share/config.site' if it exists, then
 187 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 188 `CONFIG_SITE' environment variable to the location of the site script.
 189 A warning: not all `configure' scripts look for a site script.
 190
 191 Operation Controls
 192 ==================
 193
 194    `configure' recognizes the following options to control how it
 195 operates.
 196
 197 `--cache-file=FILE'
 198      Use and save the results of the tests in FILE instead of
 199      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
 200      debugging `configure'.
 201
 202 `--help'
 203      Print a summary of the options to `configure', and exit.
 204
 205 `--quiet'
 206 `--silent'
 207 `-q'
 208      Do not print messages saying which checks are being made.  To
 209      suppress all normal output, redirect it to `/dev/null' (any error
 210      messages will still be shown).
 211
 212 `--srcdir=DIR'
 213      Look for the package's source code in directory DIR.  Usually
 214      `configure' can determine that directory automatically.
 215
 216 `--version'
 217      Print the version of Autoconf used to generate the `configure'
 218      script, and exit.
 219
 220 `configure' also accepts some other, not widely useful, options.