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