summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2012-12-11 14:09:25 +0100
committerMarcel Holtmann <marcel@holtmann.org>2012-12-11 14:09:25 +0100
commit225f6a4257b687dc310e4536aec284cdc06b7b16 (patch)
tree1f4cf842cbbdf274f037b3218976108e0a3feaad /README
parent878ef74ef387ec945322b2e925a3985fd159d1cb (diff)
downloadbluez-225f6a4257b687dc310e4536aec284cdc06b7b16.tar.gz
README: Add descriptions for configure options
Diffstat (limited to 'README')
-rw-r--r--README64
1 files changed, 64 insertions, 0 deletions
diff --git a/README b/README
index c7dc5e114..8e1118feb 100644
--- a/README
+++ b/README
@@ -27,6 +27,70 @@ To compile and install run:
make && make install
+Configuration and options
+=========================
+
+For a working system, certain configuration options need to be enabled:
+
+ --enable-library
+
+ Enable installation of Bluetooth library
+
+ By default the Bluetooth library is no longer installed.
+
+ The user interfaces or command line utilities do not
+ require an installed Bluetooth library anymore. This
+ option is provided for legacy third party applications
+ that still depend on the library.
+
+ When the library installation is enabled, it is a good
+ idea to use a separate bluez-library or libbluetooth
+ package for it.
+
+ --disable-tools
+
+ Disable support for Bluetooth utilities
+
+ By default the Bluetooth utilities are built and also
+ installed. For production systems the tools are not
+ needed and this option allows to disable them to save
+ build time and disk space.
+
+ When the tools are selected, it is a good idea to
+ use a separate bluez-tools package for them.
+
+ --disable-cups
+
+ Disable support for CUPS printer backend
+
+ By default the printer backend for CUPS is build and
+ also installed. For systems that do not require printing
+ over Bluetooth, this options allows to disable it.
+
+ When the CUPS backend is selected, it is a good idea to
+ use a separate bluez-cups package for it.
+
+ --disable-client
+
+ Disable support for the command line client
+
+ By default the command line client is enabled and uses the
+ readline library. For specific systems where BlueZ is
+ configured by other means, the command line client can be
+ disabled and the dependency on readline is removed.
+
+ --enable-experimental
+
+ Enable experimental plugins
+
+ By default all plugins that are still in development
+ are disabled. This option can be used to enable them.
+
+ It is not recommended to enable this option for production
+ systems. The APIs or behavior of the experimental plugins
+ is unstable and might still change.
+
+
Information
===========