doc: Remove method for handling provisioning
[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         - DNS Proxy
15
16 Various plugins can be enabled for networking support:
17         - Ethernet plugin
18         - WiFi plugin with WEP40/WEP128 and WPA/WPA2 (personal only) support
19         - Bluetooth plugin
20
21 Also plugins with additional features are available:
22         - Loopback setup
23         - PolicyKit support
24
25
26 Compilation and installation
27 ============================
28
29 In order to compile Connection Manager you need following software packages:
30         - GCC compiler
31         - GLib library
32         - D-Bus library
33         - PolicyKit (optional)
34
35 To configure run:
36         ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
37
38 Configure automatically searches for all required components and packages.
39
40 To compile and install run:
41         make && make install
42
43
44 VPN
45 ===
46
47 In order to compile pptp and l2tp VPN plugins, you need ppp development
48 package.
49
50 To run l2tp you will need
51         - xl2tpd, http://www.xelerance.com/services/software/xl2tpd
52
53 To run pptp you will need
54         - pptp client, http://pptpclient.sourceforge.net
55
56 Both l2tp and pptp also need pppd.
57
58
59 Configuration and options
60 =========================
61
62 For a working system, certain configuration options need to be enabled:
63
64         --enable-ethernet
65
66                 Enable support for Ethernet network cards
67
68         --enable-wifi
69
70                 Enable support for WiFi devices (requires wpa_supplicant)
71
72
73         --enable-bluetooth
74
75                 Enable support for Bluetooth devices (requires BlueZ)
76
77         --enable-loopback
78
79                 Enable setup of loopback device
80
81                 For distributions with a really minimal init system and no
82                 networking scripts this can take care of setting up the
83                 loopback device and enabling it.
84
85                 It is safe to select this option even if networking scripts
86                 are in place. It detects an already configured loopback
87                 device and leaves it as it is.
88
89         --enable-polkit
90
91                 Enable support for PolicyKit authorization
92
93                 This allows to check every D-Bus access against a security
94                 policy and so restrict access to certain functionality.
95