plugins: Add initial code for diagnosis plugin
[bluez:vudentzs-clone.git] / README
1 BlueZ - Bluetooth protocol stack for Linux
2 ******************************************
3
4 Copyright (C) 2000-2001  Qualcomm Incorporated
5 Copyright (C) 2002-2003  Maxim Krasnyansky <maxk@qualcomm.com>
6 Copyright (C) 2002-2010  Marcel Holtmann <marcel@holtmann.org>
7
8
9 Compilation and installation
10 ============================
11
12 In order to compile Bluetooth utilities you need following software packages:
13         - GCC compiler
14         - GLib library
15         - D-Bus library
16         - udev library (optional)
17         - readline (command line clients)
18
19 To configure run:
20         ./configure --prefix=/usr --mandir=/usr/share/man \
21                                 --sysconfdir=/etc --localstatedir=/var
22
23 Configure automatically searches for all required components and packages.
24
25 To compile and install run:
26         make && make install
27
28
29 Configuration and options
30 =========================
31
32 For a working system, certain configuration options need to be enabled:
33
34         --enable-library
35
36                 Enable installation of Bluetooth library
37
38                 By default the Bluetooth library is no longer installed.
39
40                 The user interfaces or command line utilities do not
41                 require an installed Bluetooth library anymore. This
42                 option is provided for legacy third party applications
43                 that still depend on the library.
44
45                 When the library installation is enabled, it is a good
46                 idea to use a separate bluez-library or libbluetooth
47                 package for it.
48
49         --disable-tools
50
51                 Disable support for Bluetooth utilities
52
53                 By default the Bluetooth utilities are built and also
54                 installed. For production systems the tools are not
55                 needed and this option allows to disable them to save
56                 build time and disk space.
57
58                 When the tools are selected, it is a good idea to
59                 use a separate bluez-tools package for them.
60
61         --disable-cups
62
63                 Disable support for CUPS printer backend
64
65                 By default the printer backend for CUPS is build and
66                 also installed. For systems that do not require printing
67                 over Bluetooth, this options allows to disable it.
68
69                 When the CUPS backend is selected, it is a good idea to
70                 use a separate bluez-cups package for it.
71
72         --disable-monitor
73
74                 Disable support for the Bluetooth monitor utility
75
76                 By default the monitor utility is enabled. It provides
77                 support for HCI level tracing and debugging. For systems
78                 that don't require any kind of tracing or debugging
79                 capabilities, this options allows to disable it.
80
81                 The monitor utility should be placed in the main package
82                 along with the daemons. It is universally useful.
83
84         --disable-client
85
86                 Disable support for the command line client
87
88                 By default the command line client is enabled and uses the
89                 readline library. For specific systems where BlueZ is
90                 configured by other means, the command line client can be
91                 disabled and the dependency on readline is removed.
92
93                 The client should be placed in the main package along
94                 with the daemons. It is universally useful.
95
96         --disable-systemd
97
98                 Disable integration with systemd
99
100                 By default the integration with systemd is enabled and
101                 installed. This gives the best integration into all
102                 distributions based on systemd.
103
104                 This option is provided for distributions that do not
105                 support systemd. In that case all integration with the
106                 init system is up to the package.
107
108         --enable-experimental
109
110                 Enable experimental plugins
111
112                 By default all plugins that are still in development
113                 are disabled. This option can be used to enable them.
114
115                 It is not recommended to enable this option for production
116                 systems. The APIs or behavior of the experimental plugins
117                 is unstable and might still change.
118
119
120 Information
121 ===========
122
123 Mailing lists:
124         linux-bluetooth@vger.kernel.org
125
126 For additional information about the project visit BlueZ web site:
127         http://www.bluez.org