README 3.5 KB
Newer Older
1
D-BUS is a simple IPC library based on messages.
2

3 4 5 6 7
See also the file HACKING for notes of interest to developers working on D-BUS.

See http://www.freedesktop.org/software/dbus/ for lots of documentation, 
mailing lists, etc.

8 9 10 11 12 13 14 15
Note
===

A core concept of the D-BUS implementation is that "libdbus" is
intended to be a low-level API, similar to Xlib. Most programmers are
intended to use the bindings to GLib, Qt, Python, Mono, Java, or
whatever. These bindings have varying levels of completeness.

16 17 18
Configuration flags
===

19 20
These are the dbus-specific configuration flags that can be given to
the ./configure program.
21

22 23
  --enable-qt      enable Qt-friendly client library
  --enable-glib    enable GLib-friendly client library
24 25
  --enable-mono    enable mono bindings
  --enable-mono-docs build mono documentation (requires monodoc)
26 27 28 29 30 31 32
  --enable-tests   enable unit test code
  --enable-ansi    enable -ansi -pedantic gcc flags
  --enable-verbose-mode support verbose debug mode
  --enable-asserts include assertion checks
  --enable-checks  include sanity checks on public API
  --enable-docs    build documentation (requires Doxygen and jade)
  --enable-gcov    compile with coverage profiling instrumentation (gcc only)
33
  --enable-python  build python bindings (reqires Pyrex >= 0.9)
34

35 36 37 38 39 40
  --with-xml=libxml/expat           XML library to use
  --with-init-scripts=redhat        Style of init scripts to install
  --with-session-socket-dir=dirname Where to put sockets for the per-login-session message bus
  --with-test-socket-dir=dirname    Where to put sockets for make check
  --with-system-pid-file=pidfile    PID file for systemwide daemon
  --with-system-socket=filename     UNIX domain socket for systemwide daemon
41 42


43 44
API/ABI Policy
===
45

46 47 48 49 50 51
D-BUS API/ABI and protocol necessarily remain in flux until we are
sure it will meet the various needs it's intended to meet. This means
we need to see some significant sample usage in the contexts of GNOME,
KDE, desktop applications, and systemwide uses such as print queue
monitoring, hotplug events, or whatever. We need the flexibility to
incorporate feedback from this sample usage.
52

53 54
Once we feel confident in the protocol and the API, we will release a 
version 1.0. At that point, the intent is:
55

56 57 58
 - The protocol will never be broken again; any message bus should 
   work with any client forever. However, extensions are possible
   where the protocol is extensible.
59

60 61 62 63
 - If the library API is modified incompatibly, we will rename it 
   as in http://ometer.com/parallel.html - in other words, 
   it will always be possible to compile against and use the older 
   API, and apps will always get the API they expect.
64

65 66 67
Until 1.0 is released, feedback that requires API changes may be
incorporated into D-BUS. This may break the API, the ABI, the
protocol, or all three.
68

69 70 71
To avoid a huge soname, the plan is to increment the soname only
between official stable releases, not with every development snapshot.
Versions numbered 0.x are considered development snapshots.
72

73 74 75
Until 1.0 is released, you have to define -DDBUS_API_SUBJECT_TO_CHANGE
just as a safety check to be sure everyone is aware of this API/ABI
policy and has the right expectations.
76

77 78 79
We do need people to test the APIs, so please do use the development
snapshots of D-BUS. They are intended to work and we do actively
address bugs.
80

81 82 83 84
However, if you're shipping a commercial binary-only application that
needs to keep running on M future versions of N operating systems, you
might want to include your own copy of D-BUS rather than relying on
the installed copy, for example.