technology: return already enabled when tethering is enabled
[framework/connectivity/connman.git] / README
diff --git a/README b/README
index 043f18d..6215e96 100644 (file)
--- a/README
+++ b/README
@@ -39,8 +39,8 @@ In order to compile Connection Manager you need following software packages:
        - GCC compiler
        - GLib library
        - D-Bus library
-       - GnuTLS library
        - IP-Tables library
+       - GnuTLS library (optional)
        - PolicyKit (optional)
 
 To configure run:
@@ -52,21 +52,6 @@ To compile and install run:
        make && make install
 
 
-VPN
-===
-
-In order to compile pptp and l2tp VPN plugins, you need ppp development
-package.
-
-To run l2tp you will need
-       - xl2tpd, http://www.xelerance.com/services/software/xl2tpd
-
-To run pptp you will need
-       - pptp client, http://pptpclient.sourceforge.net
-
-Both l2tp and pptp also need pppd.
-
-
 Configuration and options
 =========================
 
@@ -103,7 +88,7 @@ For a working system, certain configuration options need to be enabled:
 
                It is safe to build a daemon with Bluetooth support and no
                running bluetoothd. The start of bluetoothd is automatically
-               detected and only a runtime depedency. It is not needed to
+               detected and only a runtime dependency. It is not needed to
                build ConnMan.
 
        --disable-ofono
@@ -116,7 +101,20 @@ For a working system, certain configuration options need to be enabled:
 
                It is safe to build a daemon with oFono support and no
                running ofonod. That start of ofonod is automatically
-               detected and only a runtime dependecy. it is not needed to
+               detected and only a runtime dependency. It is not needed to
+               build ConnMan.
+
+       --disable-dundee
+
+               Disable support for Bluetooth DUN devices
+
+               By default Bluetooth DUN technology (dundee) support is
+               built-in and enabled. This option can be used to build a
+               small daemon for a specific system where dundee is not used.
+
+               It is safe to build a daemon with dundee support and no
+               running dundee. That start of dundee is automatically
+               detected and only a runtime dependency. It is not needed to
                build ConnMan.
 
        --disable-pacrunner
@@ -144,6 +142,24 @@ For a working system, certain configuration options need to be enabled:
                scripts are in place. It detects an already configured
                loopback device and leaves it as it is.
 
+       --disable-wispr
+
+               Disable support for WISPr hotspot logins
+
+               For systems with really minimal memory requirements, this
+               will disable the support for WISPr hotspot logins. The code
+               for WISPr will be still compiled into the daemon, but its
+               requirement on GnuTLS for secure connections will be lifted.
+
+               The missing GnuTLS support shrinks the memory requirements
+               by about 30% and for systems that are more stationary and do
+               not log into hotspots this might be a better trade off.
+
+               Disabling WISPr support is not disabling the portal detection
+               support. A portal will still be detected, but instead of being
+               asked for login credentials, the request for a browser session
+               will be made through the agent.
+
        --enable-polkit
 
                Enable support for PolicyKit authorization
@@ -164,15 +180,53 @@ For a working system, certain configuration options need to be enabled:
 wpa_supplicant configuration
 ============================
 
-In order to get wpa_supplicant and Connman working properly together you should
-edit wpa_supplicant .config file and set:
+In order to get wpa_supplicant and Connection Manager working properly
+together you should edit wpa_supplicant .config file and set:
 
 CONFIG_WPS=y
 CONFIG_AP=y
 CONFIG_CTRL_IFACE_DBUS_NEW=y
 
 and, add:
+
 CONFIG_BGSCAN_SIMPLE=y
 
 This last option will enable the support of background scanning while being
 connected, which is necessary when roaming on wifi.
+
+It is recommended to use wpa_supplicant 0.8.x or 1.x or later.
+
+
+VPN
+===
+
+In order to compile pptp and l2tp VPN plugins, you need ppp development
+package.
+
+To run l2tp you will need
+       - xl2tpd, http://www.xelerance.com/services/software/xl2tpd
+
+To run pptp you will need
+       - pptp client, http://pptpclient.sourceforge.net
+
+Both l2tp and pptp also need pppd.
+
+
+OpenVPN
+=======
+
+Up to version 2.2 of OpenVPN, pushing additional routes from the
+server will not always work. Some of the symptons are that additional
+routes will not be set by ConnMan if the uplink is a cellular
+network. While the same setup works well for a WiFi or ethernet
+uplink.
+
+
+Information
+===========
+
+Mailing list:
+       connman@connman.net
+
+For additional information about the project visit ConnMan web site:
+       http://www.connman.net