Fix command line options for device filtering
[framework/connectivity/connman.git] / README
1 Connection Manager
2 ******************
3
4 Copyright (C) 2007-2009  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         - PPP support (optional)
37
38 To configure run:
39         ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
40
41 Configure automatically searches for all required components and packages.
42
43 To compile and install run:
44         make && make install
45
46
47 Configuration and options
48 =========================
49
50 For a working system, certain configuration options need to be enabled:
51
52         --enable-ethernet
53
54                 Enable support for Ethernet network cards
55
56         --enable-wifi
57
58                 Enable support for WiFi devices (requires wpa_supplicant)
59
60
61         --enable-bluetooth
62
63                 Enable support for Bluetooth devices (requires BlueZ)
64
65         --enable-ppp
66
67                 Enable PPP support for dialup connections (requires pppd)
68
69                 The location of the pppd binary is auto-detected, but it
70                 can be overwritten via --with-pppd=<path-to-binary>.
71
72         --enable-udhcp
73
74                 Enable DHCP client support for BusyBox based systems
75
76                 The location of the udhcpc binary is auto-detected, but it
77                 can be overwritten via --with-udhcpc=<path-to-binary>.
78
79         --enable-dhclient
80
81                 Enable DHCP client support for ISC dhclient based systems
82
83                 The location of the dhclient binary is auto-detected, but it
84                 can be overwritten via --with-dhclient=<path-to-binary>.
85
86                 At least one DHCP client option should be selected. It is
87                 possible to select both and then uDHCP will be tried first
88                 before falling back to dhclient.
89
90         --enable-dnsproxy
91
92                 Enable DNS proxy support for /etc/resolv.conf abstraction
93
94                 The best solution for multiple connections and proper DNS
95                 handling is a DNS proxy server. This binds a DNS proxy
96                 server to port 53 on the loopback interface (127.0.0.1).
97
98                 The /etc/resolv.conf file needs a "nameserver 127.0.0.1"
99                 entry, but can now set the immutable bit or be on a read-only
100                 filesystem. No further modification to that file will be made.
101
102                 It is important that this is not used together with other
103                 DNS proxy solution like dnsmasq.
104
105         --enable-resolvconf
106
107                 Enable resolvconf support for Debian/Ubuntu based systems
108
109                 The resolvconf package from Debian can be used to handle
110                 configuration of the /etc/resolv.conf file.
111
112                 It is safe to select this option even when resolvconf is not
113                 installed. A missing resolvconf will be detected and in that
114                 case it falls back to modifying /etc/resolv.conf directly.
115
116                 The location of the resolvconf binary is auto-detected, but it
117                 can be overwritten via --with-resolvconf=<path-to-binary>.
118
119         --enable-loopback
120
121                 Enable setup of loopback device
122
123                 For distributions with a really minimal init system and no
124                 networking scripts this can take care of setting up the
125                 loopback device and enabling it.
126
127                 It is safe to select this option even if networking scripts
128                 are in place. It detects an already configured loopback
129                 device and leaves it as it is.
130
131         --enable-polkit
132
133                 Enable support for PolicyKit authorization
134
135                 This allows to check every D-Bus access against a security
136                 policy and so restrict access to certain functionality.
137