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