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