D-Bus specification and reference implementation, including libdbus and dbus-daemon https://www.freedesktop.org/wiki/Software/dbus/ (LADI project modifications)
Go to file
Nedko Arnaudov 3e10cc7b69 LADI dbus 1.15.4.2 (2023-06-01)
• seat support is now also possible via elogind
2023-06-01 19:17:43 +03:00
.gitlab/issue_templates Add feature template 2022-03-18 08:36:35 +01:00
LICENSES Add SPDX license marker for the FSFULLR license 2023-01-03 19:24:02 +00:00
bus bus/selinux: Move vsnprintf call to avoid va_list reuse 2023-01-09 20:03:29 +00:00
cmake Fix SPDX license reference in FindGLIB2 2022-11-29 20:44:50 +00:00
dbus elogind support 2023-06-01 19:14:47 +03:00
doc Prepare v1.15.4 2023-02-08 12:03:30 +00:00
m4 Add SPDX license marker for the FSFULLR license 2023-01-03 19:24:02 +00:00
maint maint: Make update-authors.sh executable when not going via a shell 2022-09-22 13:52:24 +01:00
subprojects subprojects: Allow expat and GLib to be built as subprojects 2022-07-13 20:36:13 +01:00
test Add test for _dbus_string_skip_blank() 2023-02-08 12:03:19 +00:00
tools CI: Re-run some tests as root or as non-root, as appropriate 2023-02-06 13:24:11 +00:00
.clang-format clang-format: don't align escaped newlines in macro definitions 2022-09-21 11:35:05 +00:00
.editorconfig .editorconfig: Automatically configure multiple text editors 2022-05-20 12:17:48 +00:00
.gitignore m4: Stop shipping our own copy of pkg.m4 2022-10-12 06:20:33 +00:00
.gitlab-ci.yml gitlab-ci: build libdbus as subproject 2023-02-07 09:07:32 +01:00
.mailmap Reduce duplicates from authors list 2011-08-06 00:08:22 +02:00
AUTHORS AUTHORS: Update 2022-09-22 12:27:57 +01:00
CMakeLists.txt build: Put system bus socket in runstatedir by default 2022-10-11 17:14:11 +01:00
CONTRIBUTING.md Move release checklist to its own file 2022-07-23 11:23:06 +01:00
COPYING Fix some stray filename references for GPL-2.0-or-later 2022-11-29 20:43:01 +00:00
Doxyfile.in Doxyfile: browse for build-dir sources 2022-05-18 16:40:30 +01:00
INSTALL dir-watch: remove dnotify backend 2013-06-28 11:53:29 +01:00
Makefile.am Add missing license text for LGPL-2.1-or-later 2022-11-29 20:43:49 +00:00
NEWS LADI dbus 1.15.4.2 (2023-06-01) 2023-06-01 19:17:43 +03:00
NEWS.pre-1-0 * Split NEWS and ChangeLog into a .pre-1-0 file as per HACKING 2007-05-25 20:49:50 +00:00
NEWS.pre-1-2 getting ready for 1.2 stable branch 2008-04-04 15:37:50 -04:00
README README: update for meson build-sys 2022-07-13 20:36:13 +01:00
README.cmake Bump CMake version to 3.4 2022-07-25 14:14:56 -05:00
README.cygwin Clean up cygwin readme 2011-08-06 00:36:42 +02:00
README.launchd Enable launchd. 2010-12-06 21:33:14 +01:00
README.valgrind Add documentation on running clients with Valgrind 2012-11-09 15:27:27 +00:00
README.win NEWS, README.win: Officially drop support for non-C99 compilers 2022-07-19 20:45:24 +01:00
README.wince Add README for Windows CE. 2010-04-13 21:09:09 +02:00
autogen.sh autogen.sh: fail cleanly if autoconf fails 2016-08-15 20:11:49 +01:00
cleanup-man-pages.sh 2006-10-21 Havoc Pennington <hp@redhat.com> 2006-10-22 00:31:08 +00:00
configure.ac elogind support 2023-06-01 19:14:47 +03:00
dbus-1-uninstalled.pc.in Let pkg-config expand directory variables recursively 2014-10-13 13:41:36 +01:00
dbus-1.pc.in cmake: Optionally create relocatable dbus-1.pc file 2017-03-20 14:14:42 +00:00
meson.build Prepare v1.15.4 2023-02-08 12:03:30 +00:00
meson_options.txt meson: Introduce message_bus and tools command line option 2023-01-04 09:35:06 +01:00
meson_post_install.py meson_post_install.py: Correct path to dbus-daemon-launch-helper 2022-07-13 20:36:13 +01:00

README

Sections in this file describe:
 - introduction and overview
 - low-level vs. high-level API
 - version numbers
 - options to the configure script
 - ABI stability policy

Introduction
===

D-Bus is a simple system for interprocess communication and coordination.

The "and coordination" part is important; D-Bus provides a bus daemon that does things like:
 - notify applications when other apps exit
 - start services on demand
 - support single-instance applications

See https://www.freedesktop.org/wiki/Software/dbus/ for lots of documentation,
mailing lists, etc.

See also the file CONTRIBUTING.md for notes of interest to developers
working on D-Bus.

If you're considering D-Bus for use in a project, you should be aware
that D-Bus was designed for a couple of specific use cases, a "system
bus" and a "desktop session bus." These are documented in more detail
in the D-Bus specification and FAQ available on the web site.

If your use-case isn't one of these, D-Bus may still be useful, but
only by accident; so you should evaluate carefully whether D-Bus makes
sense for your project.

Security
==

If you find a security vulnerability that is not known to the public,
please report it privately to dbus-security@lists.freedesktop.org
or by reporting a Gitlab issue at
https://gitlab.freedesktop.org/dbus/dbus/issues/new and marking it
as "confidential".

On Unix systems, the system bus (dbus-daemon --system) is designed
to be a security boundary between users with different privileges.

On Unix systems, the session bus (dbus-daemon --session) is designed
to be used by a single user, and only accessible by that user.

We do not currently consider D-Bus on Windows to be security-supported,
and we do not recommend allowing untrusted users to access Windows
D-Bus via TCP.

Note: low-level API vs. high-level binding APIs
===

A core concept of the D-Bus implementation is that "libdbus" is
intended to be a low-level API. Most programmers are intended to use
the bindings to GLib, Qt, Python, Mono, Java, or whatever. These
bindings have varying levels of completeness and are maintained as
separate projects from the main D-Bus package. The main D-Bus package
contains the low-level libdbus, the bus daemon, and a few command-line
tools such as dbus-launch.

If you use the low-level API directly, you're signing up for some
pain. Think of the low-level API as analogous to Xlib or GDI, and the
high-level API as analogous to Qt/GTK+/HTML.

Version numbers
===

D-Bus uses the common "Linux kernel" versioning system, where
even-numbered minor versions are stable and odd-numbered minor
versions are development snapshots.

So for example, development snapshots: 1.1.1, 1.1.2, 1.1.3, 1.3.4
Stable versions: 1.0, 1.0.1, 1.0.2, 1.2.1, 1.2.3

All pre-1.0 versions were development snapshots.

Development snapshots make no ABI stability guarantees for new ABI
introduced since the last stable release. Development snapshots are
likely to have more bugs than stable releases, obviously.

Configuration
===

This branch of dbus can be built by using Autotools, CMake or Meson.
The Meson build system is currently considered experimental, but is
likely to become the recommended build system in future.

Older versions of dbus required Autotools or CMake, with Autotools
recommended for Unix systems and CMake recommended for Windows systems.

When using Autotools, the configure step is initiated by running ./configure
with or without additional configuration flags. dbus requires GNU Make
(on BSD systems, this is typically called gmake) or a "make" implementation
with compatible extensions.

When using CMake, the configure step is initiated by running the cmake
program with or without additional configuration flags.

Meson only supports out-of-tree builds, and must be passed a directory to put
built and generated sources into. We'll call that directory "build" here. It's
recommended to create a separate build directory for each configuration you
might want to use.

Basic configuration is done with:

``` sh
meson build/
```

This will create the build directory. If any dependencies are missing, you can
install them, or try to remove the dependency with a Meson configuration option
(see below).

Configuration flags
===

When using Autotools, run "./configure --help" to see the possible
configuration options and environment variables.

When using CMake, inspect README.cmake to see the possible
configuration options and environment variables.

When using Meson, to review the options which Meson chose, run:

``` sh
meson configure build/
```

With additional arguments meson configure can be used to change options for a
previously configured build directory. All options passed to this command are in
the form `-D "option"="value"`. For example:

``` sh
meson configure build/ -Dprefix=/tmp/install
```

API/ABI Policy
===

Now that D-Bus has reached version 1.0, the objective is that all
applications dynamically linked to libdbus will continue working
indefinitely with the most recent system and session bus daemons.

 - 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.

 - 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.

Interfaces can and probably will be _added_. This means both new
functions and types in libdbus, and new methods exported to
applications by the bus daemon.

The above policy is intended to make D-Bus as API-stable as other
widely-used libraries (such as GTK+, Qt, Xlib, or your favorite
example). If you have questions or concerns they are very welcome on
the D-Bus mailing list.

NOTE ABOUT DEVELOPMENT SNAPSHOTS AND VERSIONING

Odd-numbered minor releases (1.1.x, 1.3.x, 2.1.x, etc. -
major.minor.micro) are devel snapshots for testing, and any new ABI
they introduce relative to the last stable version is subject to
change during the development cycle.

Any ABI found in a stable release, however, is frozen.

ABI will not be added in a stable series if we can help it. i.e. the
ABI of 1.2.0 and 1.2.5 you can expect to be the same, while the ABI of
1.4.x may add more stuff not found in 1.2.x.

NOTE ABOUT STATIC LINKING

We are not yet firmly freezing all runtime dependencies of the libdbus
library. For example, the library may read certain files as part of
its implementation, and these files may move around between versions.

As a result, we don't yet recommend statically linking to
libdbus. Also, reimplementations of the protocol from scratch might
have to work to stay in sync with how libdbus behaves.

To lock things down and declare static linking and reimplementation to
be safe, we'd like to see all the internal dependencies of libdbus
(for example, files read) well-documented in the specification, and
we'd like to have a high degree of confidence that these dependencies
are supportable over the long term and extensible where required.

NOTE ABOUT HIGH-LEVEL BINDINGS

Note that the high-level bindings are _separate projects_ from the
main D-Bus package, and have their own release cycles, levels of
maturity, and ABI stability policies. Please consult the documentation
for your binding.

Bootstrapping D-Bus on new platforms
===

A full build of dbus, with all regression tests enabled and run, depends
on GLib. A full build of GLib, with all regression tests enabled and run,
depends on dbus.

To break this cycle, don't enable full test coverage (for at least one
of those projects) during bootstrapping. You can rebuild with full test
coverage after you have built both dbus and GLib at least once.