163cef92a4e4e52a22044edfd1a32fb5bb0a6f7c
[platform/upstream/connman.git] / README
1 Connection Manager
2 ******************
3
4 Copyright (C) 2007-2010  Intel Corporation. All rights reserved.
5
6
7 Functionality and features
8 ==========================
9
10 The following features are built-in into Connection Manager:
11         - Generic plugin infrastructure
12         - Device and network abstraction (with basic storage support)
13         - IPv4, routing and DNS configuration
14
15 Various plugins can be enabled for networking support:
16         - Ethernet plugin
17         - WiFi plugin with WEP40/WEP128 and WPA/WPA2 (personal only) support
18         - Bluetooth plugin
19
20 Also plugins with additional features are available:
21         - DHCP plugins (uDHCP and dhclient)
22         - Resolver plugins (resolvconf and DNS proxy)
23         - Loopback setup
24         - PolicyKit support
25
26
27 Compilation and installation
28 ============================
29
30 In order to compile Connection Manager you need following software packages:
31         - GCC compiler
32         - GLib library
33         - D-Bus library
34         - udev library (optional)
35         - PolicyKit (optional)
36
37 To configure run:
38         ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
39
40 Configure automatically searches for all required components and packages.
41
42 To compile and install run:
43         make && make install
44
45
46 Configuration and options
47 =========================
48
49 For a working system, certain configuration options need to be enabled:
50
51         --enable-ethernet
52
53                 Enable support for Ethernet network cards
54
55         --enable-wifi
56
57                 Enable support for WiFi devices (requires wpa_supplicant)
58
59
60         --enable-bluetooth
61
62                 Enable support for Bluetooth devices (requires BlueZ)
63
64         --enable-udhcp
65
66                 Enable DHCP client support for BusyBox based systems
67
68                 The location of the udhcpc binary is auto-detected, but it
69                 can be overwritten via --with-udhcpc=<path-to-binary>.
70
71         --enable-dhclient
72
73                 Enable DHCP client support for ISC dhclient based systems
74
75                 The location of the dhclient binary is auto-detected, but it
76                 can be overwritten via --with-dhclient=<path-to-binary>.
77
78                 At least one DHCP client option should be selected. It is
79                 possible to select both and then uDHCP will be tried first
80                 before falling back to dhclient.
81
82         --enable-dnsproxy
83
84                 Enable DNS proxy support for /etc/resolv.conf abstraction
85
86                 The best solution for multiple connections and proper DNS
87                 handling is a DNS proxy server. This binds a DNS proxy
88                 server to port 53 on the loopback interface (127.0.0.1).
89
90                 The /etc/resolv.conf file needs a "nameserver 127.0.0.1"
91                 entry, but can now set the immutable bit or be on a read-only
92                 filesystem. No further modification to that file will be made.
93
94                 It is important that this is not used together with other
95                 DNS proxy solution like dnsmasq.
96
97         --enable-resolvconf
98
99                 Enable resolvconf support for Debian/Ubuntu based systems
100
101                 The resolvconf package from Debian can be used to handle
102                 configuration of the /etc/resolv.conf file.
103
104                 It is safe to select this option even when resolvconf is not
105                 installed. A missing resolvconf will be detected and in that
106                 case it falls back to modifying /etc/resolv.conf directly.
107
108                 The location of the resolvconf binary is auto-detected, but it
109                 can be overwritten via --with-resolvconf=<path-to-binary>.
110
111         --enable-loopback
112
113                 Enable setup of loopback device
114
115                 For distributions with a really minimal init system and no
116                 networking scripts this can take care of setting up the
117                 loopback device and enabling it.
118
119                 It is safe to select this option even if networking scripts
120                 are in place. It detects an already configured loopback
121                 device and leaves it as it is.
122
123         --enable-polkit
124
125                 Enable support for PolicyKit authorization
126
127                 This allows to check every D-Bus access against a security
128                 policy and so restrict access to certain functionality.
129