INSTALL

   1            DBus 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 The only fundamental requirement to build DBus is an XML parser,
  27 however, there are a number of other software packages which (if
  28 present) will enhance functionality.
  29
  30 Core library
  31 ------------
  32
  33  Requisite:
  34
  35   - Gettext
  36   - expat or libxml-2
  37
  38  NB, expat is the recommended XML parser because it has more robust
  39  handling of OOM conditions.
  40
  41  Optional:
  42
  43   - libselinux  (for SELinux integration)
  44   - dnotify     (for automatic service file reload)
  45   - doxygen     (for API documentation)
  46   - xmlto       (for Spec & other XML documentation)
  47
  48 GLib Bindings
  49 -------------
  50
  51  Requisite:
  52
  53   - GLib >= 2.4
  54
  55  Optional:
  56
  57   - GTK+ >= 2.4  (for dbus-viewer tool)
  58
  59 Qt Bindings
  60 -----------
  61
  62  Requisite:
  63
  64   - Qt >= 4.0
  65
  66  Optional:
  67
  68   - QtTest   (for Qt Unit tests)
  69
  70 Qt 3 Bindings
  71 -------------
  72
  73  Requisite:
  74
  75   - Qt >= 3.1
  76
  77 Mono Bindings
  78 -------------
  79
  80  Requisite:
  81
  82   - Mono >= 0.95
  83
  84  Optional:
  85
  86   - MonoDoc >= 0.16   (for API documentation)
  87
  88 Python Bindings
  89 ---------------
  90
  91  Requisite:
  92
  93   - Python >= 2.4
  94   - Pyrex
  95
  96 ====================================================================
  97
  98 The rest of this document contains the generic GNU AutoTools install
  99 insructions....
 100
 101 Basic Installation
 102 ==================
 103
 104    These are generic installation instructions.
 105
 106    The `configure' shell script attempts to guess correct values for
 107 various system-dependent variables used during compilation.  It uses
 108 those values to create a `Makefile' in each directory of the package.
 109 It may also create one or more `.h' files containing system-dependent
 110 definitions.  Finally, it creates a shell script `config.status' that
 111 you can run in the future to recreate the current configuration, a file
 112 `config.cache' that saves the results of its tests to speed up
 113 reconfiguring, and a file `config.log' containing compiler output
 114 (useful mainly for debugging `configure').
 115
 116    If you need to do unusual things to compile the package, please try
 117 to figure out how `configure' could check whether to do them, and mail
 118 diffs or instructions to the address given in the `README' so they can
 119 be considered for the next release.  If at some point `config.cache'
 120 contains results you don't want to keep, you may remove or edit it.
 121
 122    The file `configure.in' is used to create `configure' by a program
 123 called `autoconf'.  You only need `configure.in' if you want to change
 124 it or regenerate `configure' using a newer version of `autoconf'.
 125
 126 The simplest way to compile this package is:
 127
 128   1. `cd' to the directory containing the package's source code and type
 129      `./configure' to configure the package for your system.  If you're
 130      using `csh' on an old version of System V, you might need to type
 131      `sh ./configure' instead to prevent `csh' from trying to execute
 132      `configure' itself.
 133
 134      Running `configure' takes awhile.  While running, it prints some
 135      messages telling which features it is checking for.
 136
 137   2. Type `make' to compile the package.
 138
 139   3. Optionally, type `make check' to run any self-tests that come with
 140      the package.
 141
 142   4. Type `make install' to install the programs and any data files and
 143      documentation.
 144
 145   5. You can remove the program binaries and object files from the
 146      source code directory by typing `make clean'.  To also remove the
 147      files that `configure' created (so you can compile the package for
 148      a different kind of computer), type `make distclean'.  There is
 149      also a `make maintainer-clean' target, but that is intended mainly
 150      for the package's developers.  If you use it, you may have to get
 151      all sorts of other programs in order to regenerate files that came
 152      with the distribution.
 153
 154 Compilers and Options
 155 =====================
 156
 157    Some systems require unusual options for compilation or linking that
 158 the `configure' script does not know about.  You can give `configure'
 159 initial values for variables by setting them in the environment.  Using
 160 a Bourne-compatible shell, you can do that on the command line like
 161 this:
 162      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
 163
 164 Or on systems that have the `env' program, you can do it like this:
 165      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
 166
 167 Compiling For Multiple Architectures
 168 ====================================
 169
 170    You can compile the package for more than one kind of computer at the
 171 same time, by placing the object files for each architecture in their
 172 own directory.  To do this, you must use a version of `make' that
 173 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
 174 directory where you want the object files and executables to go and run
 175 the `configure' script.  `configure' automatically checks for the
 176 source code in the directory that `configure' is in and in `..'.
 177
 178    If you have to use a `make' that does not supports the `VPATH'
 179 variable, you have to compile the package for one architecture at a time
 180 in the source code directory.  After you have installed the package for
 181 one architecture, use `make distclean' before reconfiguring for another
 182 architecture.
 183
 184 Installation Names
 185 ==================
 186
 187    By default, `make install' will install the package's files in
 188 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
 189 installation prefix other than `/usr/local' by giving `configure' the
 190 option `--prefix=PATH'.
 191
 192    You can specify separate installation prefixes for
 193 architecture-specific files and architecture-independent files.  If you
 194 give `configure' the option `--exec-prefix=PATH', the package will use
 195 PATH as the prefix for installing programs and libraries.
 196 Documentation and other data files will still use the regular prefix.
 197
 198    In addition, if you use an unusual directory layout you can give
 199 options like `--bindir=PATH' to specify different values for particular
 200 kinds of files.  Run `configure --help' for a list of the directories
 201 you can set and what kinds of files go in them.
 202
 203    If the package supports it, you can cause programs to be installed
 204 with an extra prefix or suffix on their names by giving `configure' the
 205 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 206
 207 Optional Features
 208 =================
 209
 210    Some packages pay attention to `--enable-FEATURE' options to
 211 `configure', where FEATURE indicates an optional part of the package.
 212 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 213 is something like `gnu-as' or `x' (for the X Window System).  The
 214 `README' should mention any `--enable-' and `--with-' options that the
 215 package recognizes.
 216
 217    For packages that use the X Window System, `configure' can usually
 218 find the X include and library files automatically, but if it doesn't,
 219 you can use the `configure' options `--x-includes=DIR' and
 220 `--x-libraries=DIR' to specify their locations.
 221
 222 Specifying the System Type
 223 ==========================
 224
 225    There may be some features `configure' can not figure out
 226 automatically, but needs to determine by the type of host the package
 227 will run on.  Usually `configure' can figure that out, but if it prints
 228 a message saying it can not guess the host type, give it the
 229 `--host=TYPE' option.  TYPE can either be a short name for the system
 230 type, such as `sun4', or a canonical name with three fields:
 231      CPU-COMPANY-SYSTEM
 232
 233 See the file `config.sub' for the possible values of each field.  If
 234 `config.sub' isn't included in this package, then this package doesn't
 235 need to know the host type.
 236
 237    If you are building compiler tools for cross-compiling, you can also
 238 use the `--target=TYPE' option to select the type of system they will
 239 produce code for and the `--build=TYPE' option to select the type of
 240 system on which you are compiling the package.
 241
 242 Sharing Defaults
 243 ================
 244
 245    If you want to set default values for `configure' scripts to share,
 246 you can create a site shell script called `config.site' that gives
 247 default values for variables like `CC', `cache_file', and `prefix'.
 248 `configure' looks for `PREFIX/share/config.site' if it exists, then
 249 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 250 `CONFIG_SITE' environment variable to the location of the site script.
 251 A warning: not all `configure' scripts look for a site script.
 252
 253 Operation Controls
 254 ==================
 255
 256    `configure' recognizes the following options to control how it
 257 operates.
 258
 259 `--cache-file=FILE'
 260      Use and save the results of the tests in FILE instead of
 261      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
 262      debugging `configure'.
 263
 264 `--help'
 265      Print a summary of the options to `configure', and exit.
 266
 267 `--quiet'
 268 `--silent'
 269 `-q'
 270      Do not print messages saying which checks are being made.  To
 271      suppress all normal output, redirect it to `/dev/null' (any error
 272      messages will still be shown).
 273
 274 `--srcdir=DIR'
 275      Look for the package's source code in directory DIR.  Usually
 276      `configure' can determine that directory automatically.
 277
 278 `--version'
 279      Print the version of Autoconf used to generate the `configure'
 280      script, and exit.
 281
 282 `configure' also accepts some other, not widely useful, options.