Remove udhcp plugin
[framework/connectivity/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 plugin (dhclient)
22         - Resolver plugin (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-dhclient
65
66                 Enable DHCP client support for ISC dhclient based systems
67
68                 The location of the dhclient binary is auto-detected, but it
69                 can be overwritten via --with-dhclient=<path-to-binary>.
70
71                 At least one DHCP client option should be selected. It is
72                 possible to select both and then uDHCP will be tried first
73                 before falling back to dhclient.
74
75         --enable-dnsproxy
76
77                 Enable DNS proxy support for /etc/resolv.conf abstraction
78
79                 The best solution for multiple connections and proper DNS
80                 handling is a DNS proxy server. This binds a DNS proxy
81                 server to port 53 on the loopback interface (127.0.0.1).
82
83                 The /etc/resolv.conf file needs a "nameserver 127.0.0.1"
84                 entry, but can now set the immutable bit or be on a read-only
85                 filesystem. No further modification to that file will be made.
86
87                 It is important that this is not used together with other
88                 DNS proxy solution like dnsmasq.
89
90         --enable-loopback
91
92                 Enable setup of loopback device
93
94                 For distributions with a really minimal init system and no
95                 networking scripts this can take care of setting up the
96                 loopback device and enabling it.
97
98                 It is safe to select this option even if networking scripts
99                 are in place. It detects an already configured loopback
100                 device and leaves it as it is.
101
102         --enable-polkit
103
104                 Enable support for PolicyKit authorization
105
106                 This allows to check every D-Bus access against a security
107                 policy and so restrict access to certain functionality.
108