INSTALL

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