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