Original DBUS bindings for TQt
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

295 lines
10KB

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