Dmitry Shmidt | a3a2260 | 2012-07-23 16:45:46 -0700 | [diff] [blame] | 1 | .\" Copyright (c) 2006-2012 Roy Marples |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 2 | .\" All rights reserved |
| 3 | .\" |
| 4 | .\" Redistribution and use in source and binary forms, with or without |
| 5 | .\" modification, are permitted provided that the following conditions |
| 6 | .\" are met: |
| 7 | .\" 1. Redistributions of source code must retain the above copyright |
| 8 | .\" notice, this list of conditions and the following disclaimer. |
| 9 | .\" 2. Redistributions in binary form must reproduce the above copyright |
| 10 | .\" notice, this list of conditions and the following disclaimer in the |
| 11 | .\" documentation and/or other materials provided with the distribution. |
| 12 | .\" |
| 13 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND |
| 14 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 15 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 16 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE |
| 17 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| 18 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| 19 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| 20 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
| 21 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
| 22 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| 23 | .\" SUCH DAMAGE. |
| 24 | .\" |
Dmitry Shmidt | a3a2260 | 2012-07-23 16:45:46 -0700 | [diff] [blame] | 25 | .Dd March 19, 2012 |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 26 | .Dt DHCPCD.CONF 5 SMM |
Dmitry Shmidt | 938bc38 | 2010-01-08 10:47:26 -0800 | [diff] [blame] | 27 | .Os |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 28 | .Sh NAME |
| 29 | .Nm dhcpcd.conf |
Dmitry Shmidt | e86eee1 | 2011-01-24 16:27:51 -0800 | [diff] [blame] | 30 | .Nd dhcpcd configuration file |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 31 | .Sh DESCRIPTION |
| 32 | Although |
| 33 | .Nm dhcpcd |
| 34 | can do everything from the command line, there are cases where it's just easier |
| 35 | to do it once in a configuration file. |
| 36 | Most of the options found in |
| 37 | .Xr dhcpcd 8 |
| 38 | can be used here. |
| 39 | The first word on the line is the option and the rest of the line is the value. |
| 40 | Leading and trailing whitespace for the option and value are trimmed. |
| 41 | You can escape characters in the value using the \\ character. |
| 42 | .Pp |
| 43 | Blank lines and lines starting with # are ignored. |
| 44 | .Pp |
| 45 | Here's a list of available options: |
| 46 | .Bl -tag -width indent |
Dmitry Shmidt | e86eee1 | 2011-01-24 16:27:51 -0800 | [diff] [blame] | 47 | .It Ic allowinterfaces Ar pattern |
| 48 | When discovering interfaces, the interface name must match |
| 49 | .Ar pattern |
| 50 | which is a space or comma separated list of patterns passed to |
| 51 | .Xr fnmatch 3 . |
| 52 | If the same interface is matched in |
| 53 | .Ic denyinterfaces |
| 54 | then it is still denied. |
| 55 | .It Ic denyinterfaces Ar pattern |
| 56 | When discovering interfaces, the interface name must not match |
| 57 | .Ar pattern |
| 58 | which is a space or comma separated list of patterns passed to |
| 59 | .Xr fnmatch 3 . |
| 60 | .It Ic arping Ar address Op address |
| 61 | .Nm dhcpcd |
| 62 | will arping each address in order before attempting DHCP. |
| 63 | If an address is found, we will select the replying hardware address as the |
| 64 | profile, otherwise the ip address. |
| 65 | Example: |
| 66 | .Pp |
| 67 | .D1 interface bge0 |
| 68 | .D1 arping 192.168.0.1 |
| 69 | .Pp |
| 70 | .D1 profile 192.168.0.1 |
| 71 | .D1 static ip_address=192.168.0.10/24 |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 72 | .It Ic background |
| 73 | Background immediately. |
| 74 | This is useful for startup scripts which don't disable link messages for |
| 75 | carrier status. |
Dmitry Shmidt | e86eee1 | 2011-01-24 16:27:51 -0800 | [diff] [blame] | 76 | .It Ic blacklist Ar address Ns Op /cidr |
| 77 | Ignores all packets from |
| 78 | .Ar address Ns Op /cidr . |
| 79 | .It Ic whitelist Ar address Ns Op /cidr |
| 80 | Only accept packets from |
| 81 | .Ar address Ns Op /cidr . |
| 82 | .Ic blacklist |
| 83 | is ignored if |
| 84 | .Ic whitelist |
| 85 | is set. |
| 86 | .It Ic broadcast |
| 87 | Instructs the DHCP server to broadcast replies back to the client. |
| 88 | Normally this is only set for non Ethernet interfaces, |
| 89 | such as FireWire and InfiniBand. |
| 90 | In most cases, |
| 91 | .Nm dhcpcd |
| 92 | will set this automatically. |
| 93 | .It Ic env Ar value |
| 94 | Push |
| 95 | .Ar value |
| 96 | to the environment for use in |
| 97 | .Xr dhcpcd-run-hooks 8 . |
| 98 | For example, you can force the hostname hook to always set the hostname with |
| 99 | .Ic env |
| 100 | .Va force_hostname=YES . |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 101 | .It Ic clientid Ar string |
Dmitry Shmidt | 938bc38 | 2010-01-08 10:47:26 -0800 | [diff] [blame] | 102 | Send the |
| 103 | .Ar clientid . |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 104 | If the string is of the format 01:02:03 then it is encoded as hex. |
Dmitry Shmidt | 938bc38 | 2010-01-08 10:47:26 -0800 | [diff] [blame] | 105 | For interfaces whose hardware address is longer than 8 bytes, or if the |
| 106 | .Ar clientid |
| 107 | is an empty string then |
| 108 | .Nm dhcpcd |
| 109 | sends a default |
| 110 | .Ar clientid |
| 111 | of the hardware family and the hardware address. |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 112 | .It Ic duid |
| 113 | Generate an |
| 114 | .Rs |
| 115 | .%T "RFC 4361" |
| 116 | .Re |
| 117 | compliant clientid. |
| 118 | This requires persistent storage and not all DHCP servers work with it so it's |
| 119 | not enabled by default. |
| 120 | The duid generated will be held in |
| 121 | .Pa @SYSCONFDIR@/dhcpcd.duid |
| 122 | and should not be copied to other hosts. |
Dmitry Shmidt | e86eee1 | 2011-01-24 16:27:51 -0800 | [diff] [blame] | 123 | .It Ic fallback Ar profile |
| 124 | Fallback to using this profile if DHCP fails. |
| 125 | This allows you to configure a static profile instead of using ZeroConf. |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 126 | .It Ic hostname Ar name |
Dmitry Shmidt | e86eee1 | 2011-01-24 16:27:51 -0800 | [diff] [blame] | 127 | Sends |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 128 | .Ar hostname |
Dmitry Shmidt | e86eee1 | 2011-01-24 16:27:51 -0800 | [diff] [blame] | 129 | to the DHCP server so it can be registered in DNS. |
| 130 | If |
| 131 | .Ar hostname |
| 132 | is an empty string then the current system hostname is sent. |
| 133 | If |
| 134 | .Ar hostname |
| 135 | is a FQDN (ie, contains a .) then it will be encoded as such. |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 136 | .It Ic fqdn Op none | ptr | both |
| 137 | none disables FQDN encoding, ptr just asks the DHCP server to update the PTR |
| 138 | record of the host in DNS whereas both also updates the A record. |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 139 | .Nm dhcpcd |
| 140 | itself never does any DNS updates. |
| 141 | .Nm dhcpcd |
| 142 | encodes the FQDN hostname as specified in |
| 143 | .Li RFC1035 . |
| 144 | .It Ic interface Ar interface |
| 145 | Subsequent options are only parsed for this |
| 146 | .Ar interface . |
Dmitry Shmidt | a3a2260 | 2012-07-23 16:45:46 -0700 | [diff] [blame] | 147 | .It Ic ipv6ra_fork |
| 148 | By default, when |
| 149 | .Nm dhcpcd |
| 150 | receives an IPv6 RA, |
| 151 | .Nm dhcpcd |
| 152 | will only fork to the background if the RA contains at least one unexpired |
| 153 | RDNSS option. |
| 154 | Set this option so to make |
| 155 | .Nm dhcpcd |
| 156 | always fork on an RA. |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 157 | .It Ic leasetime Ar seconds |
| 158 | Request a leasetime of |
| 159 | .Ar seconds . |
Dmitry Shmidt | e86eee1 | 2011-01-24 16:27:51 -0800 | [diff] [blame] | 160 | .It Ic metric Ar metric |
| 161 | Metrics are used to prefer an interface over another one, lowest wins. |
| 162 | .Nm dhcpcd |
| 163 | will supply a default metric of 200 + |
| 164 | .Xr if_nametoindex 3 . |
| 165 | An extra 100 will be added for wireless interfaces. |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 166 | .It Ic noarp |
| 167 | Don't send any ARP requests. |
| 168 | This also disables IPv4LL. |
| 169 | .It Ic nogateway |
| 170 | Don't install any default routes. |
| 171 | .It Ic nohook Ar script |
| 172 | Don't run this hook script. |
| 173 | Matches full name, or prefixed with 2 numbers optionally ending with |
| 174 | .Pa .sh . |
Dmitry Shmidt | e86eee1 | 2011-01-24 16:27:51 -0800 | [diff] [blame] | 175 | .Pp |
| 176 | So to stop |
| 177 | .Nm dhcpcd |
| 178 | from touching your DNS or MTU settings you would do:- |
| 179 | .D1 nohook resolv.conf, mtu |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 180 | .It Ic noipv4ll |
| 181 | Don't attempt to obtain an IPv4LL address if we failed to get one via DHCP. |
| 182 | See |
| 183 | .Rs |
| 184 | .%T "RFC 3927" |
| 185 | .Re |
Dmitry Shmidt | a3a2260 | 2012-07-23 16:45:46 -0700 | [diff] [blame] | 186 | .It Ic noipv6rs |
| 187 | Disable solicition of IPv6 Router Advertisements. |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 188 | .It Ic nolink |
| 189 | Don't receive link messages about carrier status. |
| 190 | You should only set this for buggy interface drivers. |
| 191 | .It Ic option Ar option |
| 192 | Requests the |
| 193 | .Ar option |
| 194 | from the server. |
| 195 | It can be a variable to be used in |
| 196 | .Xr dhcpcd-run-hooks 8 |
| 197 | or the numerical value. |
Dmitry Shmidt | e86eee1 | 2011-01-24 16:27:51 -0800 | [diff] [blame] | 198 | You can specify more options separated by commas, spaces or more option lines. |
| 199 | .It Ic nooption Ar option |
| 200 | Remove the option from the DHCP message. |
| 201 | This should only be used when a DHCP server sends a non requested option |
| 202 | that should not be processed. |
| 203 | .It Ic destination Ar option |
| 204 | If |
| 205 | .Nm |
| 206 | detects an address added to a point to point interface (PPP, TUN, etc) then |
| 207 | it will set the listed DHCP options to the destination address of the |
| 208 | interface. |
| 209 | .It Ic profile Ar name |
| 210 | Subsequent options are only parsed for this profile |
| 211 | .Ar name . |
| 212 | .It Ic quiet |
| 213 | Suppress any dhcpcd output to the console, except for errors. |
| 214 | .It Ic reboot Ar seconds |
| 215 | Allow |
| 216 | .Ar reboot |
| 217 | seconds before moving to the discover phase if we have an old lease to use. |
Dmitry Shmidt | a3a2260 | 2012-07-23 16:45:46 -0700 | [diff] [blame] | 218 | The default is 5 seconds. |
Dmitry Shmidt | e86eee1 | 2011-01-24 16:27:51 -0800 | [diff] [blame] | 219 | A setting if 0 seconds causes |
| 220 | .Nm dhcpcd |
| 221 | to skip the reboot phase and go straight into discover. |
| 222 | .It Ic release |
| 223 | .Nm dhcpcd |
| 224 | will release the lease prior to stopping the interface. |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 225 | .It Ic require Ar option |
| 226 | Requires the |
| 227 | .Ar option |
| 228 | to be present in all DHCP messages, otherwise the message is ignored. |
| 229 | It can be a variable to be used in |
| 230 | .Xr dhcpcd-run-hooks 8 |
| 231 | or the numerical value. |
Dmitry Shmidt | e86eee1 | 2011-01-24 16:27:51 -0800 | [diff] [blame] | 232 | You can specify more options separated by commas, spaces or more require lines. |
| 233 | To enforce that |
| 234 | .Nm dhcpcd |
| 235 | only responds to DHCP servers and not BOOTP servers, you can |
| 236 | .Ic require |
| 237 | .Ar dhcp_message_type . |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 238 | .It Ic script Ar script |
| 239 | Use |
| 240 | .Ar script |
| 241 | instead of the default |
| 242 | .Pa @SCRIPT@ . |
Dmitry Shmidt | e86eee1 | 2011-01-24 16:27:51 -0800 | [diff] [blame] | 243 | .It Ic ssid Ar ssid |
| 244 | Subsequent options are only parsed for this wireless |
| 245 | .Ar ssid . |
| 246 | .It Ic static Ar value |
| 247 | Configures a static |
| 248 | .Ar value . |
| 249 | If you set |
| 250 | .Ic ip_address |
| 251 | then |
| 252 | .Nm dhcpcd |
| 253 | will not attempt to obtain a lease and just use the value for the address with |
| 254 | an infinite lease time. |
| 255 | .Pp |
| 256 | Here is an example which configures a static address, routes and dns. |
| 257 | .D1 interface eth0 |
| 258 | .D1 static ip_address=192.168.0.10/24 |
| 259 | .D1 static routers=192.168.0.1 |
| 260 | .D1 static domain_name_servers=192.168.0.1 |
| 261 | .Pp |
| 262 | Here is an example for PPP which gives the destination a default route. |
| 263 | It uses the special destination keyword to insert the destination address |
| 264 | into the value. |
| 265 | .D1 interface ppp0 |
| 266 | .D1 static ip_address= |
| 267 | .D1 destination routers |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 268 | .It Ic timeout Ar seconds |
| 269 | The default timeout for waiting for a DHCP response is 30 seconds which may |
| 270 | be too long or too short and can be changed here. |
| 271 | .It Ic userclass Ar string |
| 272 | Tag the DHCP messages with the userclass. |
| 273 | You can specify more than one. |
| 274 | .It Ic vendor Ar code , Ns Ar value |
Dmitry Shmidt | e86eee1 | 2011-01-24 16:27:51 -0800 | [diff] [blame] | 275 | Add an encapsulated vendor option. |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 276 | .Ar code |
| 277 | should be between 1 and 254 inclusive. |
Dmitry Shmidt | e86eee1 | 2011-01-24 16:27:51 -0800 | [diff] [blame] | 278 | To add a raw vendor string, omit |
| 279 | .Ar code |
| 280 | but keep the comma. |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 281 | Examples. |
| 282 | .Pp |
| 283 | Set the vendor option 01 with an IP address. |
| 284 | .D1 vendor 01,192.168.0.2 |
| 285 | Set the vendor option 02 with a hex code. |
| 286 | .D1 vendor 02,01:02:03:04:05 |
| 287 | Set the vendor option 03 with an IP address as a string. |
| 288 | .D1 vendor 03,\e"192.168.0.2\e" |
Dmitry Shmidt | e86eee1 | 2011-01-24 16:27:51 -0800 | [diff] [blame] | 289 | Set un-encapsulated vendor option to hello world. |
| 290 | .D1 vendor ,"hello world" |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 291 | .It Ic vendorclassid Ar string |
| 292 | Change the default vendorclassid sent from dhcpcd-version. |
| 293 | If not set then none is sent. |
Dmitry Shmidt | e86eee1 | 2011-01-24 16:27:51 -0800 | [diff] [blame] | 294 | .It Ic waitip |
| 295 | Wait for an address to be assigned before forking to the background. |
| 296 | .It Ic xidhwaddr |
| 297 | Use the last four bytes of the hardware address as the DHCP xid instead |
| 298 | of a randomly generated number. |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 299 | .El |
| 300 | .Sh SEE ALSO |
| 301 | .Xr dhcpcd-run-hooks 8 , |
Dmitry Shmidt | e86eee1 | 2011-01-24 16:27:51 -0800 | [diff] [blame] | 302 | .Xr dhcpcd 8 , |
| 303 | .Xr if_nametoindex 3 , |
| 304 | .Xr fnmatch 3 |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 305 | .Sh AUTHORS |
Dmitry Shmidt | e86eee1 | 2011-01-24 16:27:51 -0800 | [diff] [blame] | 306 | .An Roy Marples Aq roy@marples.name |
The Android Open Source Project | f7c5421 | 2009-03-03 19:29:22 -0800 | [diff] [blame] | 307 | .Sh BUGS |
Dmitry Shmidt | a3a2260 | 2012-07-23 16:45:46 -0700 | [diff] [blame] | 308 | Please report them to |
| 309 | .Lk http://roy.marples.name/projects/dhcpcd |