doc/connman.conf.5.in

   1 .\" connman.conf(5) manual page
   2 .\"
   3 .\" Copyright (C) 2012,2015 Intel Corporation
   4 .\"
   5 .TH "connman.conf" "5" "2015-10-15" ""
   6 .SH NAME
   7 main.conf \- ConnMan configuration file
   8 .SH SYNOPSIS
   9 .B @sysconfdir@/connman/main.conf
  10 .SH DESCRIPTION
  11 .P
  12 .B main.conf
  13 is a configuration file for ConnMan. The configuration file is
  14 optional but it can be used to set up various aspects of ConnMan's
  15 behavior. The location of the file may be changed through use of
  16 the \fB\-\-config= \fRargument for \fBconnman\fP(8).
  17 .SH "FILE FORMAT"
  18 .P
  19 The configuration file format is key file format.
  20 It consists of sections (groups) of key-value pairs.
  21 Lines beginning with a '#' and blank lines are considered comments.
  22 Sections are started by a header line containing the section enclosed
  23 in '[' and ']', and ended implicitly by the start of the next section
  24 or the end of the file. Each key-value pair must be contained in a section.
  25 .P
  26 Description of sections and available keys follows:
  27 .SS [General]
  28 This section is the only mandatory section of the configuration file.
  29 .TP
  30 .BI InputRequestTimeout= secs
  31 Set input request timeout. Default is 120 seconds
  32 The request for inputs like passphrase will timeout
  33 after certain amount of time. Use this setting to
  34 increase the value in case of different user
  35 interface designs.
  36 .TP
  37 .BI BrowserLaunchTimeout= secs
  38 Set browser launch timeout. Default is 300 seconds
  39 The request for launching a browser for portal pages
  40 will timeout after certain amount of time. Use this
  41 setting to increase the value in case of different
  42 user interface designs.
  43 .TP
  44 .BI BackgroundScanning=true\ \fR|\fB\ false
  45 Enable background scanning. Default is true.
  46 Background scanning will start every 5 minutes unless
  47 the scan list is empty. In that case, a simple backoff
  48 mechanism starting from 10s up to 5 minutes will run.
  49 .TP
  50 .BI FallbackTimeservers= server\fR[,...]
  51 List of Fallback timeservers separated by ",".
  52 These timeservers are used for NTP sync when there are
  53 no timeserver set by the user or by the service.
  54 These can contain mixed combination of fully qualified
  55 domain names, IPv4 and IPv6 addresses.
  56 .TP
  57 .BI FallbackNameservers= server\fR[,...]
  58 List of fallback nameservers separated by "," appended
  59 to the list of nameservers given by the service. The
  60 nameserver entries must be in numeric format, host
  61 names are ignored.
  62 .TP
  63 .BI DefaultAutoConnectTechnologies= technology\fR[,...]
  64 List of technologies that are marked autoconnectable
  65 by default, separated by commas ",". The default value
  66 for this entry when empty is ethernet,wifi,cellular.
  67 Services that are automatically connected must have been
  68 set up and saved to storage beforehand.
  69 .TP
  70 .BI AlwaysConnectedTechnologies= technology\fR[,...]
  71 List of technoolgies which are always connected regardless
  72 of PreferredTechnologies setting (AutoConnect = true). The
  73 default value is empty and this feature is disabled unless
  74 explicitely enabled in the config file.
  75 .TP
  76 .BI PreferredTechnologies= technology\fR[,...]
  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 .BI NetworkInterfaceBlacklist= interface\fR[,...]
  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 .BI AllowHostnameUpdates=true\ \fR|\fB\ false
  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 .BI SingleConnectedTechnology=true\ \fR|\fB\ false
 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 .BI TetheringTechnologies= technology\fR[,...]
 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 .BI PersistentTetheringMode=true\ \fR|\fB\ false
 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 .TP
 130 .BI Enable6to4=true\ \fR|\fB\ false
 131 Automatically enable Anycast 6to4 if possible. This is not recommended, as the
 132 use of 6to4 will generally lead to a severe degradation of connection quality.
 133 See RFC6343.  Default value is false (as recommended by RFC6343 section 4.1).
 134 .TP
 135 .BI VendorClassID= string
 136 Set DHCP option 60 (Vendor Class ID) to the given string. This option can
 137 be used by DHCP servers to identify specific clients without having to
 138 rely on MAC address ranges, etc
 139 .TP
 140 .BI EnableOnlineCheck=true\ \fR|\fB\ false
 141 Enable or disable use of HTTP GET as on online status check.
 142 When a service is in a READY state, and is selected as default,
 143 ConnMan will issue an HTTP GET request to verify that end-to-end
 144 connectivity is successful. Only then the service will be
 145 transitioned to ONLINE state.
 146 If this setting is false, the default service will remain in READY state.
 147 Default value is true.
 148 .SH "EXAMPLE"
 149 The following example configuration disables hostname updates and enables
 150 ethernet tethering.
 151 .PP
 152 .nf
 153 [General]
 154 AllowHostnameUpdates = false
 155 TetheringTechnologies = ethernet,wifi,bluetooth,gadget
 156 .fi
 157 .SH "SEE ALSO"
 158 .BR connman (8)