Imported Upstream version 1.29
[platform/upstream/connman.git] / doc / connman.conf.5
1 .\" connman.conf(5) manual page
2 .\"
3 .\" Copyright (C) 2012 Intel Corporation
4 .\"
5 .TH "connman.conf" "5" "21 August 2012" ""
6 .SH NAME
7 main.conf \- ConnMan configuration file
8 .SH SYNOPSIS
9 /etc/connman/main.conf
10 .br
11 or
12 .br
13 \fI<SYSCONFDIR>\fP/connman/main.conf
14 .br
15 where <SYSCONFDIR> depends on your distribution or build.
16 .SH DESCRIPTION
17 .P
18 .I main.conf
19 is a configuration file for ConnMan. The configuration file is
20 optional but it can be used to set up various aspects of ConnMan's
21 behavior. The location of the file may be changed through use of
22 the "\-\-config=" argument for \fBconnman\fP (8).
23 .SH "FILE FORMAT"
24 .P
25 The configuration file format is key file format.
26 It consists of sections (groups) of key-value pairs.
27 Lines beginning with a '#' and blank lines are considered comments.
28 Sections are started by a header line containing the section enclosed
29 in '[' and ']', and ended implicitly by the start of the next section
30 or the end of the file. Each key-value pair must be contained in a section.
31 .P
32 Description of sections and available keys follows:
33 .SS [General]
34 This section is the only mandatory section of the configuration file.
35 .TP
36 .B InputRequestTimeout=\fPsecs\fP
37 Set input request timeout. Default is 120 seconds
38 The request for inputs like passphrase will timeout
39 after certain amount of time. Use this setting to
40 increase the value in case of different user
41 interface designs.
42 .TP
43 .B BrowserLaunchTimeout=\fPsecs\fP
44 Set browser launch timeout. Default is 300 seconds
45 The request for launching a browser for portal pages
46 will timeout after certain amount of time. Use this
47 setting to increase the value in case of different
48 user interface designs.
49 .TP
50 .B BackgroundScanning=\fPtrue|false\fP
51 Enable background scanning. Default is true.
52 Background scanning will start every 5 minutes unless
53 the scan list is empty. In that case, a simple backoff
54 mechanism starting from 10s up to 5 minutes will run.
55 .TP
56 .B FallbackTimeservers=\fPserver1,server2,...\fP
57 List of Fallback timeservers separated by ",".
58 These timeservers are used for NTP sync when there are
59 no timeserver set by the user or by the service.
60 These can contain mixed combination of fully qualified
61 domain names, IPv4 and IPv6 addresses.
62 .TP
63 .B FallbackNameservers=\fPserver1,server2,...\fP
64 List of fallback nameservers separated by "," appended
65 to the list of nameservers given by the service. The
66 nameserver entries must be in numeric format, host
67 names are ignored.
68 .TP
69 .B DefaultAutoConnectTechnologies=\fPtechnology1,technology2,...\fP
70 List of technologies that are marked autoconnectable
71 by default, separated by commas ",". The default value
72 for this entry when empty is ethernet,wifi,cellular.
73 Services that are automatically connected must have been
74 set up and saved to storage beforehand.
75 .TP
76 .B PreferredTechnologies=\fPtechnology1,technology2,...\fP
77 List of preferred technologies from the most preferred
78 one to the least preferred one separated by commas ",".
79 Services of the listed technology type will be tried one
80 by one in the order given, until one of them gets connected
81 or they are all tried. A service of a preferred technology
82 type in state 'ready' will get the default route when
83 compared to another preferred type further down the list
84 with state 'ready' or with a non-preferred type; a service
85 of a preferred technology type in state 'online' will get
86 the default route when compared to either a non-preferred
87 type or a preferred type further down in the list.
88 .TP
89 .B NetworkInterfaceBlacklist=\fPinterface1,interface2,...\fP
90 List of blacklisted network interfaces separated by ",".
91 Found interfaces will be compared to the list and will
92 not be handled by connman, if their first characters
93 match any of the list entries. Default value is
94 vmnet,vboxnet,virbr,ifb.
95 .TP
96 .B AllowHostnameUpdates=\fPtrue|false\fP
97 Allow connman to change the system hostname. This can
98 happen for example if we receive DHCP hostname option.
99 Default value is true.
100 .TP
101 .B SingleConnectedTechnology=\fPtrue|false\fP
102 Keep only a single connected technology at any time. When a new
103 service is connected by the user or a better one is found according
104 to PreferredTechnologies, the new service is kept connected and all
105 the other previously connected services are disconnected. With this
106 setting it does not matter whether the previously connected services
107 are in 'online' or 'ready' states, the newly connected service is
108 the only one that will be kept connected. A service connected by the
109 user will be used until going out of network coverage. With this
110 setting enabled applications will notice more network breaks than
111 normal. Default value is false.
112 .TP
113 .B TetheringTechnologies=\fPtechnology1,technology2,...\fP
114 List of technologies that are allowed to enable tethering separated by ",".
115 The default value is wifi,bluetooth,gadget. Only those technologies listed
116 here are used for tethering. If one wants to tether ethernet,
117 then add "ethernet" in the list.
118 NOTE that if ethernet tethering is enabled, then a DHCP server is
119 started on all ethernet interfaces. Tethered ethernet should
120 never be connected to corporate or home network as it will disrupt
121 normal operation of these networks. Due to this ethernet is not
122 tethered by default. Do not activate ethernet tethering unless you
123 really know what you are doing.
124 .TP
125 .B PersistentTetheringMode=\fPtrue|false\fP
126 Restore earlier tethering status when returning from offline mode,
127 re-enabling a technology, and after restarts and reboots.
128 Default value is false.
129 .SH "SEE ALSO"
130 .BR Connman (8)