README

   1 D-BUS is a simple IPC library based on messages.
   2
   3 See also the file HACKING for notes of interest to developers working on D-BUS.
   4
   5 See http://www.freedesktop.org/software/dbus/ for lots of documentation,
   6 mailing lists, etc.
   7
   8 Note
   9 ===
  10
  11 A core concept of the D-BUS implementation is that "libdbus" is
  12 intended to be a low-level API, similar to Xlib. Most programmers are
  13 intended to use the bindings to GLib, Qt, Python, Mono, Java, or
  14 whatever. These bindings have varying levels of completeness.
  15
  16 Configuration flags
  17 ===
  18
  19 These are the dbus-specific configuration flags that can be given to
  20 the ./configure program.
  21
  22   --enable-tests          enable unit test code
  23   --enable-ansi           enable -ansi -pedantic gcc flags
  24   --enable-verbose-mode   support verbose debug mode
  25   --enable-asserts        include assertion checks
  26   --enable-checks         include sanity checks on public API
  27   --enable-xml-docs       build XML documentation (requires xmlto)
  28   --enable-doxygen-docs   build DOXYGEN documentation (requires Doxygen)
  29   --enable-gcov           compile with coverage profiling instrumentation (gcc only)
  30   --enable-abstract-sockets
  31                           use abstract socket namespace (linux only)
  32   --enable-selinux        build with SELinux support
  33   --enable-dnotify        build with dnotify support (linux only)
  34
  35   --with-xml=libxml/expat           XML library to use
  36   --with-init-scripts=redhat        Style of init scripts to install
  37   --with-session-socket-dir=dirname Where to put sockets for the per-login-session message bus
  38   --with-test-socket-dir=dirname    Where to put sockets for make check
  39   --with-system-pid-file=pidfile    PID file for systemwide daemon
  40   --with-system-socket=filename     UNIX domain socket for systemwide daemon
  41   --with-console-auth-dir=dirname   directory to check for console ownerhip
  42   --with-dbus-user=<user>           User for running the DBUS daemon (messagebus)
  43   --with-gnu-ld                     assume the C compiler uses GNU ld [default=no]
  44   --with-tags[=TAGS]                include additional configurations [automatic]
  45   --with-x                          use the X Window System
  46
  47
  48 API/ABI Policy
  49 ===
  50
  51 D-BUS API/ABI and protocol necessarily remain in flux until we are
  52 sure it will meet the various needs it's intended to meet. This means
  53 we need to see some significant sample usage in the contexts of GNOME,
  54 KDE, desktop applications, and systemwide uses such as print queue
  55 monitoring, hotplug events, or whatever. We need the flexibility to
  56 incorporate feedback from this sample usage.
  57
  58 Once we feel confident in the protocol and the API, we will release a
  59 version 1.0. At that point, the intent is:
  60
  61  - The protocol will never be broken again; any message bus should
  62    work with any client forever. However, extensions are possible
  63    where the protocol is extensible.
  64
  65  - If the library API is modified incompatibly, we will rename it
  66    as in http://ometer.com/parallel.html - in other words,
  67    it will always be possible to compile against and use the older
  68    API, and apps will always get the API they expect.
  69
  70 Until 1.0 is released, feedback that requires API changes may be
  71 incorporated into D-BUS. This may break the API, the ABI, the
  72 protocol, or all three.
  73
  74 To avoid a huge soname, the plan is to increment the soname only
  75 between official stable releases, not with every development snapshot.
  76 Versions numbered 0.x are considered development snapshots.
  77
  78 Until 1.0 is released, you have to define -DDBUS_API_SUBJECT_TO_CHANGE
  79 just as a safety check to be sure everyone is aware of this API/ABI
  80 policy and has the right expectations.
  81
  82 We do need people to test the APIs, so please do use the development
  83 snapshots of D-BUS. They are intended to work and we do actively
  84 address bugs.
  85
  86 However, if you're shipping a commercial binary-only application that
  87 needs to keep running on M future versions of N operating systems, you
  88 might want to include your own copy of D-BUS rather than relying on
  89 the installed copy, for example.