annotate src/dhcpcd.conf.5.in @ 5574:2a519da0f1a2 draft

DHCP: Split hardware address randomisation out of anonymous option A 3rd party might want to control the randomisation.
author Roy Marples <roy@marples.name>
date Mon, 28 Dec 2020 00:02:26 +0000
parents 0c4608a6cc2a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4548
c7df03794de3 Add SPDX identifiers to all dhcpcd source files.
Yegor Yefremov <yegorslists@googlemail.com>
parents: 4511
diff changeset
1 .\" SPDX-License-Identifier: BSD-2-Clause
c7df03794de3 Add SPDX identifiers to all dhcpcd source files.
Yegor Yefremov <yegorslists@googlemail.com>
parents: 4511
diff changeset
2 .\"
4922
555d7d1a4939 Welcome to 2020!
Roy Marples <roy@marples.name>
parents: 4837
diff changeset
3 .\" Copyright (c) 2006-2020 Roy Marples
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
4 .\" All rights reserved
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
5 .\"
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
6 .\" Redistribution and use in source and binary forms, with or without
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
7 .\" modification, are permitted provided that the following conditions
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
8 .\" are met:
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
9 .\" 1. Redistributions of source code must retain the above copyright
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
10 .\" notice, this list of conditions and the following disclaimer.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
11 .\" 2. Redistributions in binary form must reproduce the above copyright
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
12 .\" notice, this list of conditions and the following disclaimer in the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
13 .\" documentation and/or other materials provided with the distribution.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
14 .\"
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
18 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
25 .\" SUCH DAMAGE.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
26 .\"
5574
2a519da0f1a2 DHCP: Split hardware address randomisation out of anonymous option
Roy Marples <roy@marples.name>
parents: 5551
diff changeset
27 .Dd December 27, 2020
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
28 .Dt DHCPCD.CONF 5
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
29 .Os
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
30 .Sh NAME
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
31 .Nm dhcpcd.conf
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
32 .Nd dhcpcd configuration file
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
33 .Sh DESCRIPTION
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
34 Although
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
35 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
36 can do everything from the command line, there are cases where it's just easier
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
37 to do it once in a configuration file.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
38 Most of the options found in
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
39 .Xr dhcpcd 8
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
40 can be used here.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
41 The first word on the line is the option and the rest of the line is the value.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
42 Leading and trailing whitespace for the option and value are trimmed.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
43 You can escape characters in the value using the \\ character.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
44 Comments can be prefixed with the # character.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
45 String values should be quoted with the " character.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
46 .Pp
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
47 Here's a list of available options:
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
48 .Bl -tag -width indent
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
49 .It Ic allowinterfaces Ar pattern
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
50 When discovering interfaces, the interface name must match
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
51 .Ar pattern
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
52 which is a space or comma separated list of patterns passed to
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
53 .Xr fnmatch 3 .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
54 If the same interface is matched in
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
55 .Ic denyinterfaces
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
56 then it is still denied.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
57 .It Ic denyinterfaces Ar pattern
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
58 When discovering interfaces, the interface name must not match
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
59 .Ar pattern
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
60 which is a space or comma separated list of patterns passed to
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
61 .Xr fnmatch 3 .
4958
a120f447fe74 Implement Anonymity Profiles for DHCP Clients, RFC 7844
Roy Marples <roy@marples.name>
parents: 4922
diff changeset
62 .It Ic anonymous
a120f447fe74 Implement Anonymity Profiles for DHCP Clients, RFC 7844
Roy Marples <roy@marples.name>
parents: 4922
diff changeset
63 Enables Anonymity Profiles for DHCP, RFC 7844.
5574
2a519da0f1a2 DHCP: Split hardware address randomisation out of anonymous option
Roy Marples <roy@marples.name>
parents: 5551
diff changeset
64 Any DUID is ignored and ClientID is set to LL only.
4958
a120f447fe74 Implement Anonymity Profiles for DHCP Clients, RFC 7844
Roy Marples <roy@marples.name>
parents: 4922
diff changeset
65 All non essential options are then masked at this point,
a120f447fe74 Implement Anonymity Profiles for DHCP Clients, RFC 7844
Roy Marples <roy@marples.name>
parents: 4922
diff changeset
66 but they could be unmasked by explicitly requesting the option
a120f447fe74 Implement Anonymity Profiles for DHCP Clients, RFC 7844
Roy Marples <roy@marples.name>
parents: 4922
diff changeset
67 .Sy after
a120f447fe74 Implement Anonymity Profiles for DHCP Clients, RFC 7844
Roy Marples <roy@marples.name>
parents: 4922
diff changeset
68 the
a120f447fe74 Implement Anonymity Profiles for DHCP Clients, RFC 7844
Roy Marples <roy@marples.name>
parents: 4922
diff changeset
69 .Ic anonymous
a120f447fe74 Implement Anonymity Profiles for DHCP Clients, RFC 7844
Roy Marples <roy@marples.name>
parents: 4922
diff changeset
70 option is processed.
a120f447fe74 Implement Anonymity Profiles for DHCP Clients, RFC 7844
Roy Marples <roy@marples.name>
parents: 4922
diff changeset
71 As such, the
a120f447fe74 Implement Anonymity Profiles for DHCP Clients, RFC 7844
Roy Marples <roy@marples.name>
parents: 4922
diff changeset
72 .Ic anonymous
a120f447fe74 Implement Anonymity Profiles for DHCP Clients, RFC 7844
Roy Marples <roy@marples.name>
parents: 4922
diff changeset
73 option
a120f447fe74 Implement Anonymity Profiles for DHCP Clients, RFC 7844
Roy Marples <roy@marples.name>
parents: 4922
diff changeset
74 .Sy should
a120f447fe74 Implement Anonymity Profiles for DHCP Clients, RFC 7844
Roy Marples <roy@marples.name>
parents: 4922
diff changeset
75 be the last option in the configuration unless you really want to
a120f447fe74 Implement Anonymity Profiles for DHCP Clients, RFC 7844
Roy Marples <roy@marples.name>
parents: 4922
diff changeset
76 send something which could identify you.
a120f447fe74 Implement Anonymity Profiles for DHCP Clients, RFC 7844
Roy Marples <roy@marples.name>
parents: 4922
diff changeset
77 .Nm dhcpcd
a120f447fe74 Implement Anonymity Profiles for DHCP Clients, RFC 7844
Roy Marples <roy@marples.name>
parents: 4922
diff changeset
78 will not try and reboot an old lease, it will go straight into
a120f447fe74 Implement Anonymity Profiles for DHCP Clients, RFC 7844
Roy Marples <roy@marples.name>
parents: 4922
diff changeset
79 DISCOVER/SOLICIT.
5574
2a519da0f1a2 DHCP: Split hardware address randomisation out of anonymous option
Roy Marples <roy@marples.name>
parents: 5551
diff changeset
80 .It Ic randomise_hwaddr
2a519da0f1a2 DHCP: Split hardware address randomisation out of anonymous option
Roy Marples <roy@marples.name>
parents: 5551
diff changeset
81 Forces a hardware address randomisation when the interface is brought up
2a519da0f1a2 DHCP: Split hardware address randomisation out of anonymous option
Roy Marples <roy@marples.name>
parents: 5551
diff changeset
82 or when the carrier is lost.
2a519da0f1a2 DHCP: Split hardware address randomisation out of anonymous option
Roy Marples <roy@marples.name>
parents: 5551
diff changeset
83 This is generally used in tandem with the anonymous option.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
84 .It Ic arping Ar address Op address
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
85 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
86 will arping each address in order before attempting DHCP.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
87 If an address is found, we will select the replying hardware address as the
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
88 profile, otherwise the IP address.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
89 Example:
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
90 .Pp
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
91 .D1 interface bge0
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
92 .D1 arping 192.168.0.1
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
93 .Pp
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
94 .D1 # My specific 192.168.0.1 network
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
95 .D1 profile dd:ee:aa:dd:bb:ee
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
96 .D1 static ip_address=192.168.0.10/24
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
97 .Pp
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
98 .D1 # A generic 192.168.0.1 network
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
99 .D1 profile 192.168.0.1
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
100 .D1 static ip_address=192.168.0.98/24
4266
bd15cb1af330 auth: allow different tokens for send and receive
Roy Marples <roy@marples.name>
parents: 4218
diff changeset
101 .It Ic authprotocol Ar protocol Op Ar algorithm Op Ar rdm
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
102 Authenticate DHCP messages.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
103 See the Supported Authentication Protocols section.
4266
bd15cb1af330 auth: allow different tokens for send and receive
Roy Marples <roy@marples.name>
parents: 4218
diff changeset
104 If
bd15cb1af330 auth: allow different tokens for send and receive
Roy Marples <roy@marples.name>
parents: 4218
diff changeset
105 .Ar protocol
bd15cb1af330 auth: allow different tokens for send and receive
Roy Marples <roy@marples.name>
parents: 4218
diff changeset
106 is
bd15cb1af330 auth: allow different tokens for send and receive
Roy Marples <roy@marples.name>
parents: 4218
diff changeset
107 .Ar token
bd15cb1af330 auth: allow different tokens for send and receive
Roy Marples <roy@marples.name>
parents: 4218
diff changeset
108 then
bd15cb1af330 auth: allow different tokens for send and receive
Roy Marples <roy@marples.name>
parents: 4218
diff changeset
109 .Ar algorithm is
4825
c8d76614bcd0 Spelling fixes
Sascha Wildner <swildner@dragonflybsd.org>
parents: 4705
diff changeset
110 snd_secretid/rcv_secretid so you can send and receive different tokens.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
111 .It Ic authtoken Ar secretid Ar realm Ar expire Ar key
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
112 Define a shared key for use in authentication.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
113 .Ar realm
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
114 can be "" to for use with the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
115 .Ar delayed
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
116 protocol.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
117 .Ar expire
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
118 is the date the token expires and should be formatted "yyy-mm-dd HH:MM".
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
119 You can use the keyword
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
120 .Ar forever
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
121 or
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
122 .Ar 0
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
123 which means the token never expires.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
124 For the token protocol,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
125 .Ar secretid
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
126 needs to be 0 and
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
127 .Ar realm
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
128 needs to be "".
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
129 If
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
130 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
131 has the error
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
132 .D1 dhcp_auth_encode: Invalid argument
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
133 then it means that
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
134 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
135 could not find the correct authentication token in your configuration.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
136 .It Ic background
4318
f532ae553fd1 dhcpcd.conf.5.in: One more minor grammar fix
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4317
diff changeset
137 Fork to the background immediately.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
138 This is useful for startup scripts which don't disable link messages for
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
139 carrier status.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
140 .It Ic blacklist Ar address Ns Op /cidr
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
141 Ignores all packets from
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
142 .Ar address Ns Op /cidr .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
143 .It Ic whitelist Ar address Ns Op /cidr
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
144 Only accept packets from
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
145 .Ar address Ns Op /cidr .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
146 .Ic blacklist
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
147 is ignored if
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
148 .Ic whitelist
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
149 is set.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
150 .It Ic bootp
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
151 Be a BOOTP client.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
152 Basically, this just doesn't send a DHCP Message Type option and will only
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
153 interact with a BOOTP server.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
154 All other DHCP options still work.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
155 .It Ic broadcast
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
156 Instructs the DHCP server to broadcast replies back to the client.
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
157 Normally this is only set for non-Ethernet interfaces,
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
158 such as FireWire and InfiniBand.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
159 In most cases,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
160 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
161 will set this automatically.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
162 .It Ic controlgroup Ar group
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
163 Sets the group ownership of
4837
4938c2c3080e Correct path for dhcpcd socket.
Roy Marples <roy@marples.name>
parents: 4825
diff changeset
164 .Pa @RUNDIR@/sock
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
165 so that users other than root can connect to
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
166 .Nm dhcpcd .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
167 .It Ic debug
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
168 Echo debug messages to the stderr and syslog.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
169 .It Ic dev Ar value
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
170 Load the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
171 .Ar value
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
172 .Pa /dev
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
173 management module.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
174 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
175 will load the first one found to work, if any.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
176 .It Ic env Ar value
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
177 Push
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
178 .Ar value
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
179 to the environment for use in
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
180 .Xr dhcpcd-run-hooks 8 .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
181 For example, you can force the hostname hook to always set the hostname with
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
182 .Ic env
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
183 .Va force_hostname=YES .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
184 Or set which driver
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
185 .Xr wpa_supplicant 8
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
186 should use with
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
187 .Ic env
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
188 .Va wpa_supplicant_driver=nl80211
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
189 .Pp
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
190 If the hostname is set, it will be will set to the FQDN if possible as per
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
191 RFC 4702, section 3.1.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
192 If the FQDN option is missing,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
193 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
194 will still try and set a FQDN from the hostname and domain options for
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
195 consistency.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
196 To override this, set
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
197 .Ic env
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
198 .Va hostname_fqdn=[YES|NO|SERVER] .
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
199 A value of
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
200 .Va SERVER
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
201 means just what the server says, don't manipulate it.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
202 This could lead to an inconsistent hostname on a DHCPv4 and DHCPv6 network
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
203 where the DHCPv4 hostname is short and the DHCPv6 has an FQDN.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
204 DHCPv6 has no hostname option.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
205 .It Ic clientid Ar string
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
206 Send the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
207 .Ar clientid .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
208 If the string is of the format 01:02:03 then it is encoded as hex.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
209 For interfaces whose hardware address is longer than 8 bytes, or if the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
210 .Ar clientid
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
211 is an empty string then
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
212 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
213 sends a default
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
214 .Ar clientid
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
215 of the hardware family and the hardware address.
5551
0c4608a6cc2a options: Allow duid to take a value
Roy Marples <roy@marples.name>
parents: 5522
diff changeset
216 .It Ic duid Op ll | lt | uuid | value
4288
0bd4f5b53051 duid: Implement RFC 6355
Roy Marples <roy@marples.name>
parents: 4272
diff changeset
217 Use a DHCP Unique Identifier.
0bd4f5b53051 duid: Implement RFC 6355
Roy Marples <roy@marples.name>
parents: 4272
diff changeset
218 If a system UUID is available, that will be used to create a DUID-UUID,
0bd4f5b53051 duid: Implement RFC 6355
Roy Marples <roy@marples.name>
parents: 4272
diff changeset
219 otheriwse if persistent storage is available then a DUID-LLT
0bd4f5b53051 duid: Implement RFC 6355
Roy Marples <roy@marples.name>
parents: 4272
diff changeset
220 (link local address + time) is generated,
0bd4f5b53051 duid: Implement RFC 6355
Roy Marples <roy@marples.name>
parents: 4272
diff changeset
221 otherwise DUID-LL is generated (link local address).
5456
9203603adc76 duid: Allow optional argument to specify ll or llt alongside uuid
Roy Marples <roy@marples.name>
parents: 5435
diff changeset
222 The DUID type can be hinted as an optional parameter if the file
9203603adc76 duid: Allow optional argument to specify ll or llt alongside uuid
Roy Marples <roy@marples.name>
parents: 5435
diff changeset
223 .Pa @DBDIR@/duid
9203603adc76 duid: Allow optional argument to specify ll or llt alongside uuid
Roy Marples <roy@marples.name>
parents: 5435
diff changeset
224 does not exist.
5551
0c4608a6cc2a options: Allow duid to take a value
Roy Marples <roy@marples.name>
parents: 5522
diff changeset
225 If not
0c4608a6cc2a options: Allow duid to take a value
Roy Marples <roy@marples.name>
parents: 5522
diff changeset
226 .Va ll ,
0c4608a6cc2a options: Allow duid to take a value
Roy Marples <roy@marples.name>
parents: 5522
diff changeset
227 .Va lt
0c4608a6cc2a options: Allow duid to take a value
Roy Marples <roy@marples.name>
parents: 5522
diff changeset
228 or
0c4608a6cc2a options: Allow duid to take a value
Roy Marples <roy@marples.name>
parents: 5522
diff changeset
229 .Va uuid
0c4608a6cc2a options: Allow duid to take a value
Roy Marples <roy@marples.name>
parents: 5522
diff changeset
230 then
0c4608a6cc2a options: Allow duid to take a value
Roy Marples <roy@marples.name>
parents: 5522
diff changeset
231 .Va value
0c4608a6cc2a options: Allow duid to take a value
Roy Marples <roy@marples.name>
parents: 5522
diff changeset
232 will be converted from 00:11:22:33 format.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
233 This, plus the IAID will be used as the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
234 .Ic clientid .
4288
0bd4f5b53051 duid: Implement RFC 6355
Roy Marples <roy@marples.name>
parents: 4272
diff changeset
235 The DUID generated will be held in
3995
329cbac97d4c Fix my silly mistake in a prior commit.
Roy Marples <roy@marples.name>
parents: 3987
diff changeset
236 .Pa @DBDIR@/duid
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
237 and should not be copied to other hosts.
5551
0c4608a6cc2a options: Allow duid to take a value
Roy Marples <roy@marples.name>
parents: 5522
diff changeset
238 This file also takes precedence over the above rules except for setting a value.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
239 .It Ic iaid Ar iaid
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
240 Set the Interface Association Identifier to
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
241 .Ar iaid .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
242 This option must be used in an
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
243 .Ic interface
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
244 block.
4052
08038b46c0f5 Detect VLANID to use in IAID.
Roy Marples <roy@marples.name>
parents: 4020
diff changeset
245 This defaults to the VLANID (prefixed with 0xff) for the interface if set,
08038b46c0f5 Detect VLANID to use in IAID.
Roy Marples <roy@marples.name>
parents: 4020
diff changeset
246 otherwise the last 4 bytes of the hardware address assigned to the
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
247 interface.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
248 Each instance of this should be unique within the scope of the client and
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
249 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
250 warns if a conflict is detected.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
251 If there is a conflict, it is only a problem if the conflicted IAIDs are
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
252 used on the same network.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
253 .It Ic dhcp
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
254 Enable DHCP on the interface, on by default.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
255 .It Ic dhcp6
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
256 Enable DHCPv6 on the interface, on by default.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
257 .It Ic ipv4
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
258 Enable IPv4 on the interface, on by default.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
259 .It Ic ipv6
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
260 Enable IPv6 on the interface, on by default.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
261 .It Ic request Op Ar address
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
262 Request the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
263 .Ar address
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
264 in the DHCP DISCOVER message.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
265 There is no guarantee this is the address the DHCP server will actually give.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
266 If no
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
267 .Ar address
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
268 is given then the first address currently assigned to the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
269 .Ar interface
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
270 is used.
4207
d9c3c7008d20 ipv4: allow configuration of static broadcast address
Roy Marples <roy@marples.name>
parents: 4197
diff changeset
271 .It Ic inform Op Ar address Ns Op Ar /cidr Ns Op Ar /broadcast_address
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
272 Behaves like
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
273 .Ic request
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
274 as above, but sends a DHCP INFORM instead of DISCOVER/REQUEST.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
275 This does not get a lease as such, just notifies the DHCP server of the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
276 .Ar address
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
277 in use.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
278 You should also include the optional
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
279 .Ar cidr
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
280 network number in case the address is not already configured on the interface.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
281 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
282 remains running and pretends it has an infinite lease.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
283 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
284 will not de-configure the interface when it exits.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
285 If
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
286 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
287 fails to contact a DHCP server then it returns a failure instead of falling
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
288 back on IPv4LL.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
289 .It Ic inform6
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
290 Performs a DHCPv6 Information Request.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
291 No address is requested or specified, but all other DHCPv6 options are allowed.
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
292 This is normally performed automatically when an IPv6 Router Advertisement
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
293 indicates that the client should perform this operation.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
294 This option is only needed when
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
295 .Nm dhcpcd
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
296 is not processing IPv6 RA messages and the need for a DHCPv6 Information Request
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
297 exists.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
298 .It Ic persistent
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
299 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
300 normally de-configures the interface and configuration when it exits.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
301 Sometimes, this isn't desirable if, for example, you have root mounted over
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
302 NFS or SSH clients connect to this host and they need to be notified of
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
303 the host shutting down.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
304 You can use this option to stop this from happening.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
305 .It Ic fallback Ar profile
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
306 Fall back to using this profile if DHCP fails.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
307 This allows you to configure a static profile instead of using ZeroConf.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
308 .It Ic hostname Ar name
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
309 Sends the hostname
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
310 .Ar name
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
311 to the DHCP server so it can be registered in DNS.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
312 If
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
313 .Ar name
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
314 is an empty string then the current system hostname is sent.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
315 If
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
316 .Ar name
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
317 is a FQDN (i.e., contains a .) then it will be encoded as such.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
318 .It Ic hostname_short
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
319 Sends the short hostname to the DHCP server instead of the FQDN.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
320 This is useful because DHCP servers will not register the FQDN in their
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
321 DNS if the domain part does not match theirs.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
322 .Pp
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
323 Also, see the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
324 .Ic env
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
325 option above to control how the hostname is set on the host.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
326 .It Ic ia_na Op Ar iaid Op / address
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
327 Request a DHCPv6 Normal Address for
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
328 .Ar iaid .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
329 .Ar iaid
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
330 defaults to the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
331 .Ic iaid
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
332 option as described above.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
333 You can request more than one ia_na by specifying a unique
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
334 .Ar iaid
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
335 for each one.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
336 .It Ic ia_ta Op Ar iaid
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
337 Request a DHCPv6 Temporary Address for
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
338 .Ar iaid .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
339 You can request more than one ia_ta by specifying a unique
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
340 .Ar iaid
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
341 for each one.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
342 .It Ic ia_pd Op Ar iaid Oo / Ar prefix / Ar prefix_len Oc Op Ar interface Op / Ar sla_id Op / Ar prefix_len Op / Ar suffix
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
343 Request a DHCPv6 Delegated Prefix for
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
344 .Ar iaid .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
345 This option must be used in an
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
346 .Ic interface
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
347 block.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
348 Unless a
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
349 .Ar sla_id
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
350 of 0 is assigned with the same resultant prefix length as the delegation,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
351 a reject route is installed for the Delegated Prefix to
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
352 stop unallocated addresses being resolved upstream.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
353 If no
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
354 .Ar interface
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
355 is given then we will assign a prefix to every other interface with a
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
356 .Ar sla_id
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
357 equivalent to the interface index assigned by the OS.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
358 Otherwise addresses are only assigned for each
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
359 .Ar interface
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
360 and
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
361 .Ar sla_id .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
362 Each assigned address will have a
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
363 .Ar suffix ,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
364 defaulting to 1.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
365 If the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
366 .Ar suffix
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
367 is 0 then a SLAAC address is assigned.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
368 You cannot assign a prefix to the requesting interface unless the
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
369 DHCPv6 server supports the
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
370 .Li RFC 6603
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
371 Prefix Exclude Option.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
372 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
373 has to be running for all the interfaces it is delegating to.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
374 A default
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
375 .Ar prefix_len
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
376 of 64 is assumed, unless the maximum
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
377 .Ar sla_id
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
378 does not fit.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
379 In this case
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
380 .Ar prefix_len
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
381 is increased to the highest multiple of 8 that can accommodate the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
382 .Ar sla_id .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
383 .Ar sla_id
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
384 is an integer which must be unique inside the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
385 .Ar iaid
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
386 and is added to the prefix which must fit inside
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
387 .Ar prefix_len
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
388 less the length of the delegated prefix.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
389 You can specify multiple
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
390 .Ar interface /
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
391 .Ar sla_id /
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
392 .Ar prefix_len
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
393 per
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
394 .Ic ia_pd ,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
395 space separated.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
396 IPv6RS should be disabled globally when requesting a Prefix Delegation.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
397 .Pp
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
398 In the following example eth0 is the externally facing interface to be
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
399 configured for both IPv4 and IPv6.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
400 The DHCPv4 server will provide us with an IPv4 address and a default route.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
401 The DHCPv6 server is going to provide us with an IPv6 address, a default
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
402 route and a /64 subnet to be delegated to the internal interface.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
403 The eth1 interface will be automatically configured
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
404 for IPv6 using the first address (::1) from the delegated prefix.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
405 A second prefix is requested and assigned to two other interfaces.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
406 .Xr rtadvd 8
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
407 can be used with an empty configuration file on eth1, eth2 and eth3,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
408 to provide automatic
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
409 IPv6 address configuration for the internal network.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
410 .Bd -literal
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
411 noipv6rs # disable routing solicitation
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
412 denyinterfaces eth2 # Don't touch eth2 at all
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
413 interface eth0
4479
7cd8c57f33a0 dhcpcd.conf: Fix wording about ipv6rs
Roy Marples <roy@marples.name>
parents: 4333
diff changeset
414 ipv6rs # enable routing solicitation for eth0
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
415 ia_na 1 # request an IPv6 address
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
416 ia_pd 2 eth1/0 # request a PD and assign it to eth1
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
417 ia_pd 3 eth2/1 eth3/2 # req a PD and assign it to eth2 and eth3
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
418 .Ed
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
419 .It Ic ipv4only
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
420 Only configure IPv4.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
421 .It Ic ipv6only
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
422 Only configure IPv6.
4272
f1720bb9e425 Document fqdn none.
Roy Marples <roy@marples.name>
parents: 4266
diff changeset
423 .It Ic fqdn Op disable | none | ptr | both
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
424 .Ar none
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
425 will not ask the DHCP server to update DNS.
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
426 .Ar ptr
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
427 just asks the DHCP server to update the PTR
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
428 record of the host in DNS, whereas
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
429 .Ar both
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
430 also updates the A record.
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
431 .Ar disable
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
432 will disable the FQDN option.
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
433 The default is
4317
f5f4a88c5224 dhcpcd.conf.5.in: A couple more minor tweaks
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4316
diff changeset
434 .Ar both .
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
435 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
436 itself never does any DNS updates.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
437 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
438 encodes the FQDN hostname as specified in
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
439 .Li RFC 1035 .
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
440 .It Ic interface Ar interface
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
441 Subsequent options are only parsed for this
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
442 .Ar interface .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
443 .It Ic ipv6ra_autoconf
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
444 Generate SLAAC addresses for each Prefix advertised by an IPv6
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
445 Router Advertisement message with the Auto flag set.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
446 On by default.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
447 .It Ic ipv6ra_noautoconf
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
448 Disables the above option.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
449 .It Ic ipv6ra_fork
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
450 By default, when
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
451 .Nm dhcpcd
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
452 receives an IPv6 Router Advertisement,
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
453 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
454 will only fork to the background if the RA contains at least one unexpired
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
455 RDNSS option and a valid prefix or no DHCPv6 instruction.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
456 Set this option so to make
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
457 .Nm dhcpcd
5153
8248b3a04908 inet6: Add 'temporary' directive to the slaac option
Roy Marples <roy@marples.name>
parents: 5076
diff changeset
458 always fork on a RA.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
459 .It Ic ipv6rs
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
460 Enables IPv6 Router Advertisement solicitation.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
461 This is on by default, but is documented here in the case where it is disabled
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
462 globally but needs to be enabled for one interface.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
463 .It Ic leasetime Ar seconds
5435
557a3f9f2be4 DHCP: allow leasetime -1 to represent infinity
Roy Marples <roy@marples.name>
parents: 5376
diff changeset
464 Request a lease time of
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
465 .Ar seconds .
5435
557a3f9f2be4 DHCP: allow leasetime -1 to represent infinity
Roy Marples <roy@marples.name>
parents: 5376
diff changeset
466 .Ar -1
557a3f9f2be4 DHCP: allow leasetime -1 to represent infinity
Roy Marples <roy@marples.name>
parents: 5376
diff changeset
467 represents an infinite lease time.
557a3f9f2be4 DHCP: allow leasetime -1 to represent infinity
Roy Marples <roy@marples.name>
parents: 5376
diff changeset
468 By default
557a3f9f2be4 DHCP: allow leasetime -1 to represent infinity
Roy Marples <roy@marples.name>
parents: 5376
diff changeset
469 .Nm dhcpcd
557a3f9f2be4 DHCP: allow leasetime -1 to represent infinity
Roy Marples <roy@marples.name>
parents: 5376
diff changeset
470 does not request any lease time and leaves it in the hands of the
557a3f9f2be4 DHCP: allow leasetime -1 to represent infinity
Roy Marples <roy@marples.name>
parents: 5376
diff changeset
471 DHCP server.
4415
4eb8ce6f854c options: add link_rcvbuf variable
Roy Marples <roy@marples.name>
parents: 4333
diff changeset
472 .It Ic link_rcvbuf Ar size
4eb8ce6f854c options: add link_rcvbuf variable
Roy Marples <roy@marples.name>
parents: 4333
diff changeset
473 Override the size of the link receive buffer from the kernel default.
4eb8ce6f854c options: add link_rcvbuf variable
Roy Marples <roy@marples.name>
parents: 4333
diff changeset
474 While
4eb8ce6f854c options: add link_rcvbuf variable
Roy Marples <roy@marples.name>
parents: 4333
diff changeset
475 .Nm dhcpcd
4eb8ce6f854c options: add link_rcvbuf variable
Roy Marples <roy@marples.name>
parents: 4333
diff changeset
476 will recover from link buffer overflows,
4eb8ce6f854c options: add link_rcvbuf variable
Roy Marples <roy@marples.name>
parents: 4333
diff changeset
477 this may not be desirable on heavily loaded systems.
4010
746684127581 logerr: errx with logging
Roy Marples <roy@marples.name>
parents: 3995
diff changeset
478 .It Ic logfile Ar logfile
746684127581 logerr: errx with logging
Roy Marples <roy@marples.name>
parents: 3995
diff changeset
479 Writes to the specified
4997
774f445ed677 logging: Always log to syslog(3).
Roy Marples <roy@marples.name>
parents: 4958
diff changeset
480 .Ar logfile .
774f445ed677 logging: Always log to syslog(3).
Roy Marples <roy@marples.name>
parents: 4958
diff changeset
481 .Nm dhcpcd
774f445ed677 logging: Always log to syslog(3).
Roy Marples <roy@marples.name>
parents: 4958
diff changeset
482 still writes to
4010
746684127581 logerr: errx with logging
Roy Marples <roy@marples.name>
parents: 3995
diff changeset
483 .Xr syslog 3 .
746684127581 logerr: errx with logging
Roy Marples <roy@marples.name>
parents: 3995
diff changeset
484 The
746684127581 logerr: errx with logging
Roy Marples <roy@marples.name>
parents: 3995
diff changeset
485 .Ar logfile
4020
96edd7b26cff Note that the logfile is nolonger truncated by dhcpcd.
Roy Marples <roy@marples.name>
parents: 4010
diff changeset
486 is reopened when
4010
746684127581 logerr: errx with logging
Roy Marples <roy@marples.name>
parents: 3995
diff changeset
487 .Nm dhcpcd
746684127581 logerr: errx with logging
Roy Marples <roy@marples.name>
parents: 3995
diff changeset
488 receives the
746684127581 logerr: errx with logging
Roy Marples <roy@marples.name>
parents: 3995
diff changeset
489 .Dv SIGUSR2
746684127581 logerr: errx with logging
Roy Marples <roy@marples.name>
parents: 3995
diff changeset
490 signal.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
491 .It Ic metric Ar metric
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
492 Metrics are used to prefer an interface over another one, lowest wins.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
493 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
494 will supply a default metric of 200 +
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
495 .Xr if_nametoindex 3 .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
496 An extra 100 will be added for wireless interfaces.
4705
0547b88164b4 man: Fix lint errors.
Roy Marples <roy@marples.name>
parents: 4652
diff changeset
497 .It Ic mudurl Ar url
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
498 Specifies the URL for a Manufacturer Usage Description (MUD).
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
499 The description is used by upstream network devices to instantiate any
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
500 desired access lists.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
501 See draft-ietf-opsawg-mud for more information.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
502 .It Ic noalias
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
503 Any pre-existing IPv4 addresses will be removed from the interface when
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
504 adding a new IPv4 address.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
505 .It Ic noarp
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
506 Don't send any ARP requests.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
507 This also disables IPv4LL.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
508 .It Ic noauthrequired
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
509 Don't require authentication even though we requested it.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
510 Also allows FORCERENEW and RECONFIGURE messages without authentication.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
511 .It Ic nodelay
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
512 Don't delay for an initial randomised time when starting protocols.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
513 .It Ic nodev
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
514 Don't load
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
515 .Pa /dev
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
516 management modules.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
517 .It Ic nodhcp
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
518 Don't start DHCP or listen to DHCP messages.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
519 This is only useful when allowing IPv4LL.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
520 .It Ic nodhcp6
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
521 Don't start DHCPv6 or listen to DHCPv6 messages.
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
522 Normally DHCPv6 is started by an IPv6 Router Advertisement instruction or
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
523 configuration.
4067
1c2136f8886d Restore -G, --nogateway.
Roy Marples <roy@marples.name>
parents: 4053
diff changeset
524 .It Ic nogateway
1c2136f8886d Restore -G, --nogateway.
Roy Marples <roy@marples.name>
parents: 4053
diff changeset
525 Don't install any default routes.
1c2136f8886d Restore -G, --nogateway.
Roy Marples <roy@marples.name>
parents: 4053
diff changeset
526 .It Ic gateway
1c2136f8886d Restore -G, --nogateway.
Roy Marples <roy@marples.name>
parents: 4053
diff changeset
527 Install a default route if available (default).
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
528 .It Ic nohook Ar script
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
529 Don't run this hook script.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
530 Matches full name, or prefixed with 2 numbers optionally ending with
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
531 .Pa .sh .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
532 .Pp
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
533 So to stop
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
534 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
535 from touching your DNS settings or starting wpa_supplicant you would do:-
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
536 .D1 nohook resolv.conf, wpa_supplicant
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
537 .It Ic noipv4
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
538 Don't attempt to configure an IPv4 address.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
539 .It Ic noipv4ll
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
540 Don't attempt to obtain an IPv4LL address if we failed to get one via DHCP.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
541 See
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
542 .Rs
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
543 .%T "RFC 3927"
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
544 .Re
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
545 .It Ic noipv6
4218
f618f850efdc inet6: simplify setup of kernel
Roy Marples <roy@marples.name>
parents: 4209
diff changeset
546 Don't solicit or accept IPv6 Router Advertisements and DHCPv6.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
547 .It Ic noipv6rs
4218
f618f850efdc inet6: simplify setup of kernel
Roy Marples <roy@marples.name>
parents: 4209
diff changeset
548 Don't solicit or accept IPv6 Router Advertisements.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
549 .It Ic nolink
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
550 Don't receive link messages about carrier status.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
551 You should only set this for buggy interface drivers.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
552 .It Ic noup
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
553 Don't bring the interface up when in master mode.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
554 .It Ic option Ar option
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
555 Requests the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
556 .Ar option
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
557 from the server.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
558 It can be a variable to be used in
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
559 .Xr dhcpcd-run-hooks 8
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
560 or the numerical value.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
561 You can specify more
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
562 .Ar option Ns s
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
563 separated by commas, spaces or more
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
564 .Ic option
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
565 lines.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
566 Prepend dhcp6_ to
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
567 .Ar option
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
568 to request a DHCPv6 option.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
569 If no DHCPv6 options are configured,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
570 then DHCPv4 options are mapped to equivalent DHCPv6 options.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
571 .Pp
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
572 Prepend nd_ to
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
573 .Ar option
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
574 to handle ND options, but this only works for the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
575 .Ic nooption ,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
576 .Ic reject
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
577 and
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
578 .Ic require
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
579 options.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
580 .Pp
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
581 To see a list of options you can use, call
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
582 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
583 with the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
584 .Fl V , Fl Fl variables
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
585 argument.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
586 .It Ic nooption Ar option
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
587 Remove the option from the message before it's processed.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
588 .It Ic require Ar option
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
589 Requires the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
590 .Ar option
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
591 to be present in all messages, otherwise the message is ignored.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
592 To enforce that
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
593 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
594 only responds to DHCP servers and not BOOTP servers, you can
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
595 .Ic require
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
596 .Ar dhcp_message_type .
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
597 This isn't an exact science though because a BOOTP server can send DHCP-like
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
598 options.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
599 .It Ic reject Ar option
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
600 Reject a message that contains the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
601 .Ar option .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
602 This is useful when you cannot use
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
603 .Ic require
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
604 to select / de-select BOOTP messages.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
605 .It Ic destination Ar option
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
606 If
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
607 .Nm
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
608 detects an address added to a point to point interface (PPP, TUN, etc) then
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
609 it will set the listed DHCP options to the destination address of the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
610 interface.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
611 .It Ic profile Ar name
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
612 Subsequent options are only parsed for this profile
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
613 .Ar name .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
614 .It Ic quiet
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
615 Suppress any dhcpcd output to the console, except for errors.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
616 .It Ic reboot Ar seconds
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
617 Allow
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
618 .Ar reboot
5521
4396ae1267a0 dhcpcd.conf(5): mention fallback for the reboot option
Roy Marples <roy@marples.name>
parents: 5486
diff changeset
619 seconds before moving to the DISCOVER phase if we have an old lease to use.
4396ae1267a0 dhcpcd.conf(5): mention fallback for the reboot option
Roy Marples <roy@marples.name>
parents: 5486
diff changeset
620 Allow
4396ae1267a0 dhcpcd.conf(5): mention fallback for the reboot option
Roy Marples <roy@marples.name>
parents: 5486
diff changeset
621 .Ar reboot
4396ae1267a0 dhcpcd.conf(5): mention fallback for the reboot option
Roy Marples <roy@marples.name>
parents: 5486
diff changeset
622 seconds before starting fallback states from the DISCOVER phase.
4396ae1267a0 dhcpcd.conf(5): mention fallback for the reboot option
Roy Marples <roy@marples.name>
parents: 5486
diff changeset
623 IPv4LL is started when the first
4396ae1267a0 dhcpcd.conf(5): mention fallback for the reboot option
Roy Marples <roy@marples.name>
parents: 5486
diff changeset
624 .Ar reboot
4396ae1267a0 dhcpcd.conf(5): mention fallback for the reboot option
Roy Marples <roy@marples.name>
parents: 5486
diff changeset
625 timeout is reached.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
626 The default is 5 seconds.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
627 A setting of 0 seconds causes
5521
4396ae1267a0 dhcpcd.conf(5): mention fallback for the reboot option
Roy Marples <roy@marples.name>
parents: 5486
diff changeset
628 .Nm
4396ae1267a0 dhcpcd.conf(5): mention fallback for the reboot option
Roy Marples <roy@marples.name>
parents: 5486
diff changeset
629 to skip the reboot phase and go straight into DISCOVER.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
630 This is desirable for mobile users because if you change from network A to
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
631 network B and they use the same subnet and the address from network A isn't
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
632 in use on network B, then the DHCP server will remain silent even if
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
633 authoritative which means
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
634 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
635 will timeout before moving back to the DISCOVER phase.
5521
4396ae1267a0 dhcpcd.conf(5): mention fallback for the reboot option
Roy Marples <roy@marples.name>
parents: 5486
diff changeset
636 This has no effect on DHCPv6 other than skipping the reboot phase.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
637 .It Ic release
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
638 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
639 will release the lease prior to stopping the interface.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
640 .It Ic script Ar script
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
641 Use
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
642 .Ar script
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
643 instead of the default
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
644 .Pa @SCRIPT@ .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
645 .It Ic ssid Ar ssid
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
646 Subsequent options are only parsed for this wireless
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
647 .Ar ssid .
5153
8248b3a04908 inet6: Add 'temporary' directive to the slaac option
Roy Marples <roy@marples.name>
parents: 5076
diff changeset
648 .It Ic slaac Ar hwaddr | Ar private Op Ar temp | Ar temporary
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
649 Selects the interface identifier used for SLAAC generated IPv6 addresses.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
650 If
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
651 .Ar private
5153
8248b3a04908 inet6: Add 'temporary' directive to the slaac option
Roy Marples <roy@marples.name>
parents: 5076
diff changeset
652 is used, a RFC 7217 address is generated.
8248b3a04908 inet6: Add 'temporary' directive to the slaac option
Roy Marples <roy@marples.name>
parents: 5076
diff changeset
653 The
8248b3a04908 inet6: Add 'temporary' directive to the slaac option
Roy Marples <roy@marples.name>
parents: 5076
diff changeset
654 .Ar temporary
8248b3a04908 inet6: Add 'temporary' directive to the slaac option
Roy Marples <roy@marples.name>
parents: 5076
diff changeset
655 directive will create a temporary address for the prefix as well.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
656 .It Ic static Ar value
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
657 Configures a static
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
658 .Ar value .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
659 If you set
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
660 .Ic ip_address
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
661 then
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
662 .Nm dhcpcd
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
663 will not attempt to obtain a lease and will just use the value for the address
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
664 with an infinite lease time.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
665 If you set
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
666 .Ic ip6_address ,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
667 .Nm dhcpcd
4652
fd05ef5cb087 Man page improvements.
Sascha Wildner <swildner@dragonflybsd.org>
parents: 4548
diff changeset
668 will continue auto-configuration as normal.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
669 .Pp
4207
d9c3c7008d20 ipv4: allow configuration of static broadcast address
Roy Marples <roy@marples.name>
parents: 4197
diff changeset
670 Here is an example which configures two static address, overriding the default
d9c3c7008d20 ipv4: allow configuration of static broadcast address
Roy Marples <roy@marples.name>
parents: 4197
diff changeset
671 IPv4 broadcast address, an IPv4 router, DNS and disables IPv6 auto-configuration.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
672 You could also use the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
673 .Ic inform6
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
674 command here if you wished to obtain more information via DHCPv6.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
675 For IPv4, you should use the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
676 .Ic inform Ar ipaddress
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
677 option instead of setting a static address.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
678 .D1 interface eth0
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
679 .D1 noipv6rs
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
680 .D1 static ip_address=192.168.0.10/24
4207
d9c3c7008d20 ipv4: allow configuration of static broadcast address
Roy Marples <roy@marples.name>
parents: 4197
diff changeset
681 .D1 static broadcast_address=192.168.0.63
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
682 .D1 static ip6_address=fd51:42f8:caae:d92e::ff/64
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
683 .D1 static routers=192.168.0.1
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
684 .D1 static domain_name_servers=192.168.0.1 fd51:42f8:caae:d92e::1
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
685 .Pp
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
686 Here is an example for PPP which gives the destination a default route.
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
687 It uses the special
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
688 .Ar destination
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
689 keyword to insert the destination address
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
690 into the value.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
691 .D1 interface ppp0
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
692 .D1 static ip_address=
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
693 .D1 destination routers
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
694 .It Ic timeout Ar seconds
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
695 Time out after
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
696 .Ar seconds ,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
697 instead of the default 30.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
698 A setting of 0
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
699 .Ar seconds
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
700 causes
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
701 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
702 to wait forever to get a lease.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
703 If
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
704 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
705 is working on a single interface then
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
706 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
707 will exit when a timeout occurs, otherwise
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
708 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
709 will fork into the background.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
710 If using IPv4LL then
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
711 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
712 start the IPv4LL process after the timeout and then wait a little longer
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
713 before really timing out.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
714 .It Ic userclass Ar string
5076
1d53edf5bdaa DHCP: Add support for the Microsoft User Class option
Roy Marples <roy@marples.name>
parents: 4997
diff changeset
715 Tag the DHCPv4 message with the userclass.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
716 You can specify more than one.
5076
1d53edf5bdaa DHCP: Add support for the Microsoft User Class option
Roy Marples <roy@marples.name>
parents: 4997
diff changeset
717 .It Ic msuserclass Ar string
1d53edf5bdaa DHCP: Add support for the Microsoft User Class option
Roy Marples <roy@marples.name>
parents: 4997
diff changeset
718 Tag the DHCPv4 mesasge with the Microsoft userclass.
1d53edf5bdaa DHCP: Add support for the Microsoft User Class option
Roy Marples <roy@marples.name>
parents: 4997
diff changeset
719 Unlike the
1d53edf5bdaa DHCP: Add support for the Microsoft User Class option
Roy Marples <roy@marples.name>
parents: 4997
diff changeset
720 .Ic userclass
1d53edf5bdaa DHCP: Add support for the Microsoft User Class option
Roy Marples <roy@marples.name>
parents: 4997
diff changeset
721 option, this one can only be added once.
1d53edf5bdaa DHCP: Add support for the Microsoft User Class option
Roy Marples <roy@marples.name>
parents: 4997
diff changeset
722 It should only be used for Microsoft DHCP servers and the
1d53edf5bdaa DHCP: Add support for the Microsoft User Class option
Roy Marples <roy@marples.name>
parents: 4997
diff changeset
723 .Ic vendorclassid
1d53edf5bdaa DHCP: Add support for the Microsoft User Class option
Roy Marples <roy@marples.name>
parents: 4997
diff changeset
724 should be set to "MSFT 98" or "MSFT 5.0".
1d53edf5bdaa DHCP: Add support for the Microsoft User Class option
Roy Marples <roy@marples.name>
parents: 4997
diff changeset
725 This option is not RFC compliant.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
726 .It Ic vendor Ar code , Ns Ar value
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
727 Add an encapsulated vendor option.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
728 .Ar code
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
729 should be between 1 and 254 inclusive.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
730 To add a raw vendor string, omit
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
731 .Ar code
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
732 but keep the comma.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
733 Examples.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
734 .Pp
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
735 Set the vendor option 01 with an IP address.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
736 .D1 vendor 01,192.168.0.2
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
737 Set the vendor option 02 with a hex code.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
738 .D1 vendor 02,01:02:03:04:05
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
739 Set the vendor option 03 with an IP address as a string.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
740 .D1 vendor 03,\e"192.168.0.2\e"
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
741 Set un-encapsulated vendor option to hello world.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
742 .D1 vendor ,"hello world"
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
743 .It Ic vendorclassid Ar string
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
744 Set the DHCP Vendor Class.
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
745 DHCPv6 has its own option as shown below.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
746 The default is
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
747 dhcpcd-<version>:<os>:<machine>:<platform>.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
748 For example
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
749 .D1 dhcpcd-5.5.6:NetBSD-6.99.5:i386:i386
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
750 If not set then none is sent.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
751 Some badly configured DHCP servers reject unknown vendorclassids.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
752 To work around it, try and impersonate Windows by using the MSFT vendorclassid.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
753 .It Ic vendclass Ar en Ar data
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
754 Add the DHCPv6 Vendor Indetifying Vendor Class with the IANA assigned Enterprise
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
755 Number
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
756 .Ar en
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
757 with the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
758 .Ar data .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
759 This option can be set more than once to add more data, but the behaviour,
4652
fd05ef5cb087 Man page improvements.
Sascha Wildner <swildner@dragonflybsd.org>
parents: 4548
diff changeset
760 as per RFC 3925 is undefined if the Enterprise Number differs.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
761 .It Ic waitip Op 4 | 6
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
762 Wait for an address to be assigned before forking to the background.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
763 4 means wait for an IPv4 address to be assigned.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
764 6 means wait for an IPv6 address to be assigned.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
765 If no argument is given,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
766 .Nm
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
767 will wait for any address protocol to be assigned.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
768 It is possible to wait for more than one address protocol and
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
769 .Nm
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
770 will only fork to the background when all waiting conditions are satisfied.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
771 .It Ic xidhwaddr
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
772 Use the last four bytes of the hardware address as the DHCP xid instead
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
773 of a randomly generated number.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
774 .El
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
775 .Ss Defining new options
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
776 DHCP, ND and DHCPv6 allow for the use of custom options, and RFC 3925 vendor
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
777 options for DHCP can also be supplied.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
778 Each option needs to be started with the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
779 .Ic define ,
4705
0547b88164b4 man: Fix lint errors.
Roy Marples <roy@marples.name>
parents: 4652
diff changeset
780 .Ic definend ,
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
781 .Ic define6
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
782 or
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
783 .Ic vendopt
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
784 directive.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
785 This can optionally be followed by both
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
786 .Ic embed
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
787 or
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
788 .Ic encap
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
789 options.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
790 Both can be specified more than once and
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
791 .Ic embed
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
792 must come before
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
793 .Ic encap .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
794 .Bl -tag -width indent
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
795 .It Ic define Ar code Ar type Ar variable
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
796 Defines the DHCP option
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
797 .Ar code
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
798 of
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
799 .Ar type
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
800 with a name of
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
801 .Ar variable
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
802 exported to
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
803 .Xr dhcpcd-run-hooks 8 .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
804 .It Ic definend Ar code Ar type Ar variable
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
805 Defines the ND option
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
806 .Ar code
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
807 of
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
808 .Ar type
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
809 with a name of
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
810 .Ar variable
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
811 exported to
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
812 .Xr dhcpcd-run-hooks 8 ,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
813 with a prefix of
5219
dc62219c044c Fix neighbor discovery option parsing (#16)
Andrew Childs <lorne@cons.org.nz>
parents: 5153
diff changeset
814 .Va nd_ .
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
815 .It Ic define6 Ar code Ar type Ar variable
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
816 Defines the DHCPv6 option
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
817 .Ar code
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
818 of
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
819 .Ar type
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
820 with a name of
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
821 .Ar variable
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
822 exported to
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
823 .Xr dhcpcd-run-hooks 8 ,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
824 with a prefix of
5219
dc62219c044c Fix neighbor discovery option parsing (#16)
Andrew Childs <lorne@cons.org.nz>
parents: 5153
diff changeset
825 .Va dhcp6_ .
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
826 .It Ic vendopt Ar code Ar type Ar variable
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
827 Defines the Vendor-Identifying Vendor Options.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
828 The
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
829 .Ar code
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
830 is the IANA Enterprise Number which will uniquely describe the encapsulated
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
831 options.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
832 .Ar type
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
833 is normally
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
834 .Ar encap .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
835 .Ar variable
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
836 names the Vendor option to be exported.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
837 .It Ic embed Ar type Ar variable
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
838 Defines an embedded variable within the defined option.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
839 The length is determined by the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
840 .Ar type .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
841 If the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
842 .Ar variable
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
843 is not the same as defined in the parent option,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
844 it is prefixed with the parent
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
845 .Ar variable
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
846 first with an underscore.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
847 If the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
848 .Ar variable
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
849 has the name of
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
850 .Ar reserved
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
851 then it is not processed.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
852 .It Ic encap Ar code Ar type Ar variable
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
853 Defines an encapsulated variable within the defined option.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
854 The length is determined by the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
855 .Ar type .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
856 If the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
857 .Ar variable
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
858 is not the same as defined in the parent option,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
859 it is prefixed with the parent
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
860 .Ar variable
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
861 first with an underscore.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
862 .El
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
863 .Ss Type prefix
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
864 These keywords come before the type itself, to describe it more fully.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
865 You can use more than one, but they must appear in the order listed below.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
866 .Bl -tag -width -indent
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
867 .It Ic request
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
868 Requests the option by default without having to be specified in user
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
869 configuration.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
870 .It Ic norequest
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
871 This option cannot be requested, regardless of user configuration.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
872 .It Ic optional
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
873 This option is optional.
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
874 Only makes sense for embedded options like the client FQDN option, where
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
875 the FQDN string itself is optional.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
876 .It Ic index
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
877 The option can appear more than once and will be indexed.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
878 .It Ic array
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
879 The option data is split into a space separated array, each element being
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
880 the same type.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
881 .El
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
882 .Ss Types to define
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
883 The type directly affects the length of data consumed inside the option.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
884 Any remaining data is normally discarded.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
885 Lengths can be specified for string and binhex types, but this is generally
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
886 with other data embedded afterwards in the same option.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
887 .Bl -tag -width indent
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
888 .It Ic ipaddress
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
889 An IPv4 address, 4 bytes.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
890 .It Ic ip6address
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
891 An IPv6 address, 16 bytes.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
892 .It Ic string Op : Ic length
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
893 A NVT ASCII string of printable characters.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
894 .It Ic byte
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
895 A byte.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
896 .It Ic bitflags : Ic flags
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
897 A byte represented as a string of flags, most significant bit first.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
898 For example, using ABCDEFGH then A would equal 10000000, B 01000000,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
899 C 00100000, etc.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
900 If the bit is not set, the flag is not printed.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
901 A flag of 0 is not printed even if the bit position is set.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
902 This is to allow reservation of the first bits while assigning the last bits.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
903 .It Ic int16
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
904 A signed 16bit integer, 2 bytes.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
905 .It Ic uint16
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
906 An unsigned 16bit integer, 2 bytes.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
907 .It Ic int32
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
908 A signed 32bit integer, 4 bytes.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
909 .It Ic uint32
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
910 An unsigned 32bit integer, 4 bytes.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
911 .It Ic flag
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
912 A fixed value (1) to indicate that the option is present, 0 bytes.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
913 .It Ic domain
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
914 An RFC 3397 encoded string.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
915 .It Ic dname
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
916 An RFC 1035 validated string.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
917 .It Ic binhex Op : Ic length
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
918 Binary data expressed as hexadecimal.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
919 .It Ic embed
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
920 Contains embedded options (implies encap as well).
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
921 .It Ic encap
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
922 Contains encapsulated options (implies embed as well).
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
923 .It Ic option
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
924 References an option from the global definition.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
925 .El
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
926 .Ss Example definition
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
927 .D1 # DHCP option 81, Fully Qualified Domain Name, RFC 4702
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
928 .D1 define 81 embed fqdn
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
929 .D1 embed byte flags
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
930 .D1 embed byte rcode1
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
931 .D1 embed byte rcode2
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
932 .D1 embed domain fqdn
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
933 .Pp
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
934 .D1 # DHCP option 125, Vendor Specific Information Option, RFC 3925
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
935 .D1 define 125 encap vsio
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
936 .D1 embed uint32 enterprise_number
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
937 .D1 # Options defined for the enterprise number
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
938 .D1 encap 1 ipaddress ipaddress
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
939 .Ss Supported Authentication Protocols
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
940 .Bl -tag -width -indent
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
941 .It Ic token
4266
bd15cb1af330 auth: allow different tokens for send and receive
Roy Marples <roy@marples.name>
parents: 4218
diff changeset
942 Sends a plain text token the server expects and matches a token sent by
bd15cb1af330 auth: allow different tokens for send and receive
Roy Marples <roy@marples.name>
parents: 4218
diff changeset
943 the server.
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
944 The tokens do not have to be the same.
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
945 If unspecified, the token with a
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
946 .Ar secretid
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
947 of 0 will be used in sending messages
4266
bd15cb1af330 auth: allow different tokens for send and receive
Roy Marples <roy@marples.name>
parents: 4218
diff changeset
948 and validating received messages.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
949 .It Ic delayedrealm
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
950 Delayed Authentication.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
951 .Nm dhcpcd
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
952 will send an authentication option with no key or MAC.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
953 The server will see this option, and select a key for
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
954 .Nm , writing the
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
955 .Ar realm
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
956 and
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
957 .Ar secretid
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
958 in it.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
959 .Nm dhcpcd
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
960 will then look for an unexpired token with a matching
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
961 .Ar realm
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
962 and
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
963 .Ar secretid .
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
964 This token is used to authenticate all other messages.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
965 .It Ic delayed
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
966 Same as above, but without a realm.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
967 .El
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
968 .Ss Supported Authentication Algorithms
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
969 If none specified,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
970 .Ic hmac-md5
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
971 is the default.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
972 .Bl -tag -width -indent
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
973 .It Ic hmac-md5
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
974 .El
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
975 .Ss Supported Replay Detection Mechanisms
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
976 If none specified,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
977 .Ic monotonic
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
978 is the default.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
979 If this is changed from what was previously used,
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
980 or the means of calculating or storing it is broken, then the DHCP server
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
981 will probably have to have its notion of the client's Replay Detection Value
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
982 reset.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
983 .Bl -tag -width -indent
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
984 .It Ic monocounter
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
985 Read the number in the file
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
986 .Pa @DBDIR@/dhcpcd-rdm.monotonic
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
987 and add one to it.
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
988 .It Ic monotime
4316
4c5d6bcd36e0 dhcpcd.conf.5.in: Fix various typos, add more markup, etc.
David H. Gutteridge <dhgutteridge@hotmail.com>
parents: 4288
diff changeset
989 Create an NTP timestamp from the system time.
3932
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
990 .It Ic monotonic
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
991 Same as
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
992 .Ic monotime .
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
993 .El
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
994 .Sh SEE ALSO
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
995 .Xr fnmatch 3 ,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
996 .Xr if_nametoindex 3 ,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
997 .Xr dhcpcd 8 ,
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
998 .Xr dhcpcd-run-hooks 8
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
999 .Sh AUTHORS
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
1000 .An Roy Marples Aq Mt roy@marples.name
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
1001 .Sh BUGS
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
1002 Please report them to
e802a4235d75 Move the source files along with dev, crypt and comapt into src dir.
Roy Marples <roy@marples.name>
parents:
diff changeset
1003 .Lk http://roy.marples.name/projects/dhcpcd