a547f0dc88135de9812a28d4afcf802487976a5c
[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         - PolicyKit (optional)
35
36 To configure run:
37         ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
38
39 Configure automatically searches for all required components and packages.
40
41 To compile and install run:
42         make && make install
43
44
45 Configuration and options
46 =========================
47
48 For a working system, certain configuration options need to be enabled:
49
50         --enable-ethernet
51
52                 Enable support for Ethernet network cards
53
54         --enable-wifi
55
56                 Enable support for WiFi devices (requires wpa_supplicant)
57
58
59         --enable-bluetooth
60
61                 Enable support for Bluetooth devices (requires BlueZ)
62
63         --enable-dhclient
64
65                 Enable DHCP client support for ISC dhclient based systems
66
67                 The location of the dhclient binary is auto-detected, but it
68                 can be overwritten via --with-dhclient=<path-to-binary>.
69
70                 At least one DHCP client option should be selected. It is
71                 possible to select both and then uDHCP will be tried first
72                 before falling back to dhclient.
73
74         --enable-dnsproxy
75
76                 Enable DNS proxy support for /etc/resolv.conf abstraction
77
78                 The best solution for multiple connections and proper DNS
79                 handling is a DNS proxy server. This binds a DNS proxy
80                 server to port 53 on the loopback interface (127.0.0.1).
81
82                 The /etc/resolv.conf file needs a "nameserver 127.0.0.1"
83                 entry, but can now set the immutable bit or be on a read-only
84                 filesystem. No further modification to that file will be made.
85
86                 It is important that this is not used together with other
87                 DNS proxy solution like dnsmasq.
88
89         --enable-loopback
90
91                 Enable setup of loopback device
92
93                 For distributions with a really minimal init system and no
94                 networking scripts this can take care of setting up the
95                 loopback device and enabling it.
96
97                 It is safe to select this option even if networking scripts
98                 are in place. It detects an already configured loopback
99                 device and leaves it as it is.
100
101         --enable-polkit
102
103                 Enable support for PolicyKit authorization
104
105                 This allows to check every D-Bus access against a security
106                 policy and so restrict access to certain functionality.
107