README

   1 Sections in this file describe:
   2  - introduction and overview
   3  - low-level vs. high-level API
   4  - version numbers
   5  - options to the configure script
   6  - ABI stability policy
   7
   8 Introduction
   9 ===
  10
  11 D-Bus is a simple system for interprocess communication and coordination.
  12
  13 The "and coordination" part is important; D-Bus provides a bus daemon that does things like:
  14  - notify applications when other apps exit
  15  - start services on demand
  16  - support single-instance applications
  17
  18 See http://www.freedesktop.org/software/dbus/ for lots of documentation,
  19 mailing lists, etc.
  20
  21 See also the file HACKING for notes of interest to developers working on D-Bus.
  22
  23 If you're considering D-Bus for use in a project, you should be aware
  24 that D-Bus was designed for a couple of specific use cases, a "system
  25 bus" and a "desktop session bus." These are documented in more detail
  26 in the D-Bus specification and FAQ available on the web site.
  27
  28 If your use-case isn't one of these, D-Bus may still be useful, but
  29 only by accident; so you should evaluate carefully whether D-Bus makes
  30 sense for your project.
  31
  32 Note: low-level API vs. high-level binding APIs
  33 ===
  34
  35 A core concept of the D-Bus implementation is that "libdbus" is
  36 intended to be a low-level API. Most programmers are intended to use
  37 the bindings to GLib, Qt, Python, Mono, Java, or whatever. These
  38 bindings have varying levels of completeness and are maintained as
  39 separate projects from the main D-Bus package. The main D-Bus package
  40 contains the low-level libdbus, the bus daemon, and a few command-line
  41 tools such as dbus-launch.
  42
  43 If you use the low-level API directly, you're signing up for some
  44 pain. Think of the low-level API as analogous to Xlib or GDI, and the
  45 high-level API as analogous to Qt/GTK+/HTML.
  46
  47 Version numbers
  48 ===
  49
  50 D-Bus uses the common "Linux kernel" versioning system, where
  51 even-numbered minor versions are stable and odd-numbered minor
  52 versions are development snapshots.
  53
  54 So for example, development snapshots: 1.1.1, 1.1.2, 1.1.3, 1.3.4
  55 Stable versions: 1.0, 1.0.1, 1.0.2, 1.2.1, 1.2.3
  56
  57 All pre-1.0 versions were development snapshots.
  58
  59 Development snapshots make no ABI stability guarantees for new ABI
  60 introduced since the last stable release. Development snapshots are
  61 likely to have more bugs than stable releases, obviously.
  62
  63 Configuration
  64 ===
  65
  66 dbus could be build by using autotools or cmake.
  67
  68 When using autotools the configure step is initiated by running ./configure
  69 with our without additional configuration flags.
  70
  71 When using cmake the configure step is initiated by running the cmake
  72 program with our without additional configuration flags.
  73
  74 Configuration flags
  75 ===
  76
  77 When using autotools, run "./configure --help" to see the possible
  78 configuration options and environment variables.
  79
  80 When using the cmake build system the dbus-specific configuration flags that can be given
  81 to the cmake program are these (use -D<key>=<value> on command line)
  82
  83     CMAKE_BUILD_TYPE                   set dbus build mode - one of Debug|Release|RelWithDebInfo|MinSizeRel
  84     DBUS_BUILD_TESTS                   enable unit test code  default=ON
  85     DBUS_BUILD_X11                     Build with X11 autolaunch support default=ON
  86     HAVE_CONSOLE_OWNER_FILE            enable console owner file (solaris only) ) default=ON
  87     DBUS_DISABLE_ASSERTS               Disable assertion checking default=OFF
  88     DBUS_DISABLE_CHECKS                Disable public API sanity checking default=OFF
  89     DBUS_ENABLE_ABSTRACT_SOCKETS       enable support for abstract sockets (linux only) default=ON
  90     DBUS_ENABLE_ANSI                   enable -ansi -pedantic gcc flags default=OFF
  91     DBUS_ENABLE_DNOTIFY                build with dnotify support (linux only) default=ON
  92     DBUS_ENABLE_VERBOSE_MODE           support verbose debug mode default=ON
  93     DBUS_ENABLE_DOXYGEN_DOCS           build DOXYGEN documentation (requires Doxygen) default=ON
  94     DBUS_GCOV_ENABLED                  compile with coverage profiling instrumentation (gcc only) default=OFF
  95     DBUS_INSTALL_SYSTEM_LIBS           install required system libraries default (windows only) =OFF
  96     DBUS_USE_EXPAT                     Use expat (== ON) or libxml2 (==OFF) default=ON [1]
  97     DBUS_USE_NONCE_TCP_DEFAULT_ADDRESS Use nonce tcp default address default=OFF
  98     DBUS_USE_OUTPUT_DEBUG_STRING       enable win32 debug port for message output default=OFF
  99
 100     [1] requires installed development package of the related dependency
 101
 102
 103 API/ABI Policy
 104 ===
 105
 106 Now that D-Bus has reached version 1.0, the objective is that all
 107 applications dynamically linked to libdbus will continue working
 108 indefinitely with the most recent system and session bus daemons.
 109
 110  - The protocol will never be broken again; any message bus should
 111    work with any client forever. However, extensions are possible
 112    where the protocol is extensible.
 113
 114  - If the library API is modified incompatibly, we will rename it
 115    as in http://ometer.com/parallel.html - in other words,
 116    it will always be possible to compile against and use the older
 117    API, and apps will always get the API they expect.
 118
 119 Interfaces can and probably will be _added_. This means both new
 120 functions and types in libdbus, and new methods exported to
 121 applications by the bus daemon.
 122
 123 The above policy is intended to make D-Bus as API-stable as other
 124 widely-used libraries (such as GTK+, Qt, Xlib, or your favorite
 125 example). If you have questions or concerns they are very welcome on
 126 the D-Bus mailing list.
 127
 128 NOTE ABOUT DEVELOPMENT SNAPSHOTS AND VERSIONING
 129
 130 Odd-numbered minor releases (1.1.x, 1.3.x, 2.1.x, etc. -
 131 major.minor.micro) are devel snapshots for testing, and any new ABI
 132 they introduce relative to the last stable version is subject to
 133 change during the development cycle.
 134
 135 Any ABI found in a stable release, however, is frozen.
 136
 137 ABI will not be added in a stable series if we can help it. i.e. the
 138 ABI of 1.2.0 and 1.2.5 you can expect to be the same, while the ABI of
 139 1.4.x may add more stuff not found in 1.2.x.
 140
 141 NOTE ABOUT STATIC LINKING
 142
 143 We are not yet firmly freezing all runtime dependencies of the libdbus
 144 library. For example, the library may read certain files as part of
 145 its implementation, and these files may move around between versions.
 146
 147 As a result, we don't yet recommend statically linking to
 148 libdbus. Also, reimplementations of the protocol from scratch might
 149 have to work to stay in sync with how libdbus behaves.
 150
 151 To lock things down and declare static linking and reimplementation to
 152 be safe, we'd like to see all the internal dependencies of libdbus
 153 (for example, files read) well-documented in the specification, and
 154 we'd like to have a high degree of confidence that these dependencies
 155 are supportable over the long term and extensible where required.
 156
 157 NOTE ABOUT HIGH-LEVEL BINDINGS
 158
 159 Note that the high-level bindings are _separate projects_ from the
 160 main D-Bus package, and have their own release cycles, levels of
 161 maturity, and ABI stability policies. Please consult the documentation
 162 for your binding.