2003-04-13 Havoc Pennington <hp@pobox.com>
[platform/upstream/dbus.git] / README
1 D-BUS is a simple IPC library based on messages.
2
3 Configuration flags
4 ===
5
6 These are the configuration flags that can be given to the ./configure program.
7
8 --enable-qt             enable Qt-friendly client library
9 --enable-glib           enable GLib-friendly client library
10 --enable-tests          enable unit test code
11 --enable-ansi           enable -ansi -pedantic gcc flags
12 --enable-verbose-mode   support verbose debug mode
13 --enable-asserts        include assertion checks
14 --enable-gcov           compile with coverage profiling instrumentation (gcc only)
15
16
17 Environment variables
18 ===
19
20 These are the environment variables that are used by the D-BUS client library
21
22 DBUS_VERBOSE=1
23 Turns on printing verbose messages. This only works if D-BUS has been
24 compiled with --enable-verbose-mode
25
26 DBUS_MALLOC_FAIL_NTH=n
27 Can be set to a number, causing every nth call to dbus_alloc or
28 dbus_realloc to fail. This only works if D-BUS has been compiled with
29 --enable-tests.
30
31 DBUS_MALLOC_FAIL_GREATER_THAN=n
32 Can be set to a number, causing every call to dbus_alloc or
33 dbus_realloc to fail if the number of bytes to be allocated is greater
34 than the specified number. This only works if D-BUS has been compiled with
35 --enable-tests.
36
37
38 Tests
39 ===
40
41 These are the test programs that are built if dbus is compiled using
42 --enable-tests.
43
44 dbus/dbus-test
45 This is the main unit test program that tests all aspects of the D-BUS
46 client library.
47
48 test/break-loader
49 A test that tries to break the message loader by passing it invalid messages.
50
51 test/bus-test
52 A test that simulates a bus daemon and tests it.