1.8.2
[platform/upstream/dbus.git] / README.win
1 -----------------------------------------
2 Windows port of the freedesktop.org D-Bus
3 -----------------------------------------
4
5 Features and completeness
6 -------------------------
7 The windows port of dbus provides the dbus-1 library and mostly
8 applications which are already available on unix. These applications
9 are: dbus-daemon, dbus-launch, dbus-monitor and dbus-send.
10 DBus comes with a test suite which is used on unix to guarantate
11 production quality and this test suite runs mostly. There are some
12 test not running yet and there is help needed to get them running.
13
14 Supported compilers
15 -------------------
16 On windows Microsoft Visual Studio 2010 (Express and professional variants) 
17 and mingw-w64|32 are known to work.
18
19 Building
20 --------
21 DBus can be built on windows using automake or cmake. See the
22 file INSTALL for more information.
23
24 windbus and dbus4win Ports
25 --------------------------
26 The Windows ports from the windbus and dbus4win projects has been merged
27 into the freedesktop git master branch, as applicable. The spec has been
28 updated with windows specific stuff.
29
30
31 Tests
32 -----
33  - dbus library check
34     bin\test-dbus.exe <build-root>\test\data
35
36  - bus daemon check
37     bin\test-bus.exe <build-root>\test\data
38
39  - check available names
40     bin\test_names.exe
41
42  - check if dbus-daemon is accessable
43     bin\dbus-send.exe --session --type=method_call --print-reply --dest=org.freedesktop.DBus / org.freedesktop.DBus.ListNames method return sender=org.freedesktop.DBus -> dest=:1.4 array [ string "org.freedesktop.DBus"string ":1.4"]
44
45  - start session dbus-daemon
46     either by running
47         bin\dbus-launch
48     or
49         start bin\dbus-daemon --session
50
51     Before running these commands you may execute
52         set DBUS_VERBOSE=1
53     for getting debug infos
54
55
56  - call function registerd in dbus
57     bin\dbus-send.exe  --dest=org.freedesktop.DBus --print-reply --type=method_call / org.freedesktop.DBus.StartServiceByName string:org.freedesktop.DBus.TestSuiteEchoService  uint32:455 method return sender=org.freedesktop.DBus -> dest=:1.8 uint32 2
58
59     note: When building with the Visual C++ IDE the *.exe files are in
60           the bin/Debug and bin/Release folder, not in the bin folder.
61
62
63 FAQ
64 ---
65
66 - How far is WinDBus from being usable for production ?
67
68   dbus comes with a test suite which is used on unix to guarantate
69   production quality and this test suite runs mostly. There are some
70   test not running and we need help to get them running.
71   In the pratice I and some other people are using dbus for at least more
72   than four years in conjunction with kde on windows without any problems.
73
74 - On UNIX D-Bus uses UNIX sockets to communicate (correct me if I'm wrong).
75   What is used on Windows ?
76
77   tcp sockets, there are some efforts to get named pipe running, but some
78   design problems of the win32 api, we are not able to solve without
79   bigger changes to the dbus code base let us stop this effort.
80
81 - Do you have any clue if dbus-win32 can run in a Windows CE environment?
82
83   dbus has been ported to wince, see README.wince for more information
84
85 - Do you know if the C++ binding made by OpenWengo will be easily portable to Windows?
86
87   The OpenWengo dbus-c++ binding has been ported to windows see in WinDBus svn
88   (http://sf.net/projects/windbus)
89   The related test applications are running well.
90
91
92 TODO
93 ----
94
95 October 2010:
96
97 - the code wrapped with DBUS_WIN_FIXME should be inspected if it required for windows
98
99 - create a dbus setup installer
100
101 - implement system bus and system bus service starter
102   see http://windbus.svn.sourceforge.net/viewvc/windbus/trunk/bus/bus-service-win.c
103   for a starting point
104
105 - implement a real login session bus
106   The scope parameter of the autolaunch meta protocol could be extended to support user
107   specific session busses (like already done with the amarok bundled dbus which use a
108   shared memory area named "DBusDaemonAddressInfo:<username>".
109   Also the dbus installer should start a session bus on user login.