1.\" Copyright 2006-2008 Roy Marples 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.\" 25.Dd November 18, 2008 26.Dt DHCPCD.CONF 5 SMM 27.Os 28.Sh NAME 29.Nm dhcpcd.conf 30.Nd dhcpcd configuration file 31.Sh DESCRIPTION 32Although 33.Nm dhcpcd 34can do everything from the command line, there are cases where it's just easier 35to do it once in a configuration file. 36Most of the options found in 37.Xr dhcpcd 8 38can be used here. 39The first word on the line is the option and the rest of the line is the value. 40Leading and trailing whitespace for the option and value are trimmed. 41You can escape characters in the value using the \\ character. 42.Pp 43Blank lines and lines starting with # are ignored. 44.Pp 45Here's a list of available options: 46.Bl -tag -width indent 47.It Ic background 48Background immediately. 49This is useful for startup scripts which don't disable link messages for 50carrier status. 51.It Ic blacklist Ar address 52Ignores all DHCP messages which have this 53.Ar address 54as the server ID. 55This may be expanded in future releases to ignore all packets 56matching either the IP or hardware 57.Ar address . 58.It Ic clientid Ar string 59Send the 60.Ar clientid . 61If the string is of the format 01:02:03 then it is encoded as hex. 62For interfaces whose hardware address is longer than 8 bytes, or if the 63.Ar clientid 64is an empty string then 65.Nm dhcpcd 66sends a default 67.Ar clientid 68of the hardware family and the hardware address. 69.It Ic duid 70Generate an 71.Rs 72.%T "RFC 4361" 73.Re 74compliant clientid. 75This requires persistent storage and not all DHCP servers work with it so it's 76not enabled by default. 77The duid generated will be held in 78.Pa @SYSCONFDIR@/dhcpcd.duid 79and should not be copied to other hosts. 80.It Ic hostname Ar name 81Sends specified 82.Ar hostname 83to the DHCP server so it can be registered in DNS. If 84.Ar hostname 85if a FQDN (ie, contains a .) then it will be encoded as such. 86.It Ic fqdn Op none | ptr | both 87none disables FQDN encoding, ptr just asks the DHCP server to update the PTR 88record of the host in DNS whereas both also updates the A record. 89The current hostname or the hostname specified using the 90.Ic hostname 91option must be a FQDN. 92.Nm dhcpcd 93itself never does any DNS updates. 94.Nm dhcpcd 95encodes the FQDN hostname as specified in 96.Li RFC1035 . 97.It Ic interface Ar interface 98Subsequent options are only parsed for this 99.Ar interface . 100.It Ic leasetime Ar seconds 101Request a leasetime of 102.Ar seconds . 103.It Ic noarp 104Don't send any ARP requests. 105This also disables IPv4LL. 106.It Ic nogateway 107Don't install any default routes. 108.It Ic nohook Ar script 109Don't run this hook script. 110Matches full name, or prefixed with 2 numbers optionally ending with 111.Pa .sh . 112.It Ic noipv4ll 113Don't attempt to obtain an IPv4LL address if we failed to get one via DHCP. 114See 115.Rs 116.%T "RFC 3927" 117.Re 118.It Ic nolink 119Don't receive link messages about carrier status. 120You should only set this for buggy interface drivers. 121.It Ic option Ar option 122Requests the 123.Ar option 124from the server. 125It can be a variable to be used in 126.Xr dhcpcd-run-hooks 8 127or the numerical value. 128You can specify more options seperated by commas, spaces or more option lines. 129.Ic quiet 130Supress any dhcpcd output to the console, except for errors. 131.It Ic require Ar option 132Requires the 133.Ar option 134to be present in all DHCP messages, otherwise the message is ignored. 135It can be a variable to be used in 136.Xr dhcpcd-run-hooks 8 137or the numerical value. 138You can specify more options seperated by commas, spaces or more require lines. 139.It Ic script Ar script 140Use 141.Ar script 142instead of the default 143.Pa @SCRIPT@ . 144.It Ic timeout Ar seconds 145The default timeout for waiting for a DHCP response is 30 seconds which may 146be too long or too short and can be changed here. 147.It Ic userclass Ar string 148Tag the DHCP messages with the userclass. 149You can specify more than one. 150.It Ic vendor Ar code , Ns Ar value 151Add an enscapulated vendor option. 152.Ar code 153should be between 1 and 254 inclusive. 154Examples. 155.Pp 156Set the vendor option 01 with an IP address. 157.D1 vendor 01,192.168.0.2 158Set the vendor option 02 with a hex code. 159.D1 vendor 02,01:02:03:04:05 160Set the vendor option 03 with an IP address as a string. 161.D1 vendor 03,\e"192.168.0.2\e" 162.It Ic vendorclassid Ar string 163Change the default vendorclassid sent from dhcpcd-version. 164If not set then none is sent. 165.El 166.Sh SEE ALSO 167.Xr dhcpcd-run-hooks 8 , 168.Xr dhcpcd 8 169.Sh AUTHORS 170.An Roy Marples <roy@marples.name> 171.Sh BUGS 172Please report them to http://roy.marples.name/projects/dhcpcd 173