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