Upgrade isc-dhcp, e.g. dhclient.
[dragonfly.git] / contrib / isc-dhcp / client / dhclient.8
1 .\"     dhclient.8
2 .\"
3 .\" Copyright (c) 1996-2002 Internet Software Consortium.
4 .\" Use is subject to license terms which appear in the file named
5 .\" ISC-LICENSE that should have accompanied this file when you
6 .\" received it.   If a file named ISC-LICENSE did not accompany this
7 .\" file, or you are not sure the one you have is correct, you may
8 .\" obtain an applicable copy of the license at:
9 .\"
10 .\"             http://www.isc.org/isc-license-1.0.html. 
11 .\"
12 .\" This file is part of the ISC DHCP distribution.   The documentation
13 .\" associated with this file is listed in the file DOCUMENTATION,
14 .\" included in the top-level directory of this release.
15 .\"
16 .\" Support and other services are available for ISC products - see
17 .\" http://www.isc.org for more information.
18 .\"
19 .\" $Id: dhclient.8,v 1.12.2.7 2002/11/17 02:25:43 dhankins Exp $
20 .\"
21 .\" Portions copyright (c) 2000 David E. O'Brien.
22 .\" All rights reserved.
23 .\" $FreeBSD: src/contrib/isc-dhcp/client/dhclient.8,v 1.14 2003/07/28 08:30:11 mbr Exp $
24 .\" $DragonFly: src/contrib/isc-dhcp/client/Attic/dhclient.8,v 1.3 2003/10/11 21:14:12 dillon Exp $
25 .\"
26 .TH dhclient 8
27 .SH NAME
28 dhclient - Dynamic Host Configuration Protocol Client
29 .SH SYNOPSIS
30 .B dhclient
31 [
32 .B -p
33 .I port
34 ]
35 [
36 .B -D
37 ]
38 [
39 .B -d
40 ]
41 [
42 .B -q
43 ]
44 [
45 .B -v
46 ]
47 [
48 .B -1
49 ]
50 [
51 .B -r
52 ]
53 [
54 .B -lf
55 .I lease-file
56 ]
57 [
58 .B -pf
59 .I pid-file
60 ]
61 [
62 .B -cf
63 .I config-file
64 ]
65 [
66 .B -sf
67 .I script-file
68 ]
69 [
70 .B -s
71 server
72 ]
73 [
74 .B -g
75 relay
76 ]
77 [
78 .B -i
79 interval
80 ]
81 [
82 .B -n
83 ]
84 [
85 .B -nw
86 ]
87 [
88 .B -w
89 ]
90 [
91 .I if0
92 [
93 .I ...ifN
94 ]
95 ]
96 .SH DESCRIPTION
97 The Internet Software Consortium DHCP Client, dhclient, provides a
98 means for configuring one or more network interfaces using the Dynamic
99 Host Configuration Protocol, BOOTP protocol, or if these protocols
100 fail, by statically assigning an address.
101 .SH OPERATION
102 .PP
103 The DHCP protocol allows a host to contact a central server which
104 maintains a list of IP addresses which may be assigned on one or more
105 subnets.   A DHCP client may request an address from this pool, and
106 then use it on a temporary basis for communication on network.   The
107 DHCP protocol also provides a mechanism whereby a client can learn
108 important details about the network to which it is attached, such as
109 the location of a default router, the location of a name server, and
110 so on.
111 .PP
112 On startup, dhclient reads the
113 .IR dhclient.conf
114 for configuration instructions.   It then gets a list of all the
115 network interfaces that are configured in the current system.   For
116 each interface, it attempts to configure the interface using the DHCP
117 protocol.
118 .PP
119 In order to keep track of leases across system reboots and server
120 restarts, dhclient keeps a list of leases it has been assigned in the
121 dhclient.leases(5) file.   On startup, after reading the dhclient.conf
122 file, dhclient reads the dhclient.leases file to refresh its memory
123 about what leases it has been assigned.
124 .PP
125 When a new lease is acquired, it is appended to the end of the
126 dhclient.leases file.   In order to prevent the file from becoming
127 arbitrarily large, from time to time dhclient creates a new
128 dhclient.leases file from its in-core lease database.  The old version
129 of the dhclient.leases file is retained under the name
130 .IR dhclient.leases~
131 until the next time dhclient rewrites the database.
132 .PP
133 Old leases are kept around in case the DHCP server is unavailable when
134 dhclient is first invoked (generally during the initial system boot
135 process).   In that event, old leases from the dhclient.leases file
136 which have not yet expired are tested, and if they are determined to
137 be valid, they are used until either they expire or the DHCP server
138 becomes available.
139 .PP
140 A mobile host which may sometimes need to access a network on which no
141 DHCP server exists may be preloaded with a lease for a fixed
142 address on that network.   When all attempts to contact a DHCP server
143 have failed, dhclient will try to validate the static lease, and if it
144 succeeds, will use that lease until it is restarted.
145 .PP
146 A mobile host may also travel to some networks on which DHCP is not
147 available but BOOTP is.   In that case, it may be advantageous to
148 arrange with the network administrator for an entry on the BOOTP
149 database, so that the host can boot quickly on that network rather
150 than cycling through the list of old leases.
151 .SH COMMAND LINE
152 .PP
153 The names of the network interfaces that dhclient should attempt to
154 configure may be specified on the command line.  If no interface names
155 are specified on the command line dhclient will normally identify all
156 network interfaces, eliminating non-broadcast interfaces if
157 possible, and attempt to configure each interface.
158 .PP
159 It is also possible to specify interfaces by name in the
160 .B dhclient.conf(5)
161 file.   If interfaces are specified in this way, then the client will
162 only configure interfaces that are either specified in the
163 configuration file or on the command line, and will ignore all other
164 interfaces.
165 .PP
166 The
167 .B -D
168 flag causes
169 .B dhclient
170 to save the script it creates for use in conjunction with
171 .B dhclient-script
172 in 
173 .IR /tmp.
174 .PP
175 If the DHCP client should listen and transmit on a port other than the
176 standard (port 68), the
177 .B -p
178 flag may used.  It should be followed by the udp port number that
179 dhclient should use.  This is mostly useful for debugging purposes.
180 If a different port is specified for the client to listen on and
181 transmit on, the client will also use a different destination port -
182 one greater than the specified destination port.
183 .PP
184 The DHCP client normally transmits any protocol messages it sends
185 before acquiring an IP address to, 255.255.255.255, the IP limited
186 broadcast address.   For debugging purposes, it may be useful to have
187 the server transmit these messages to some other address.   This can
188 be specified with the 
189 .B -s
190 flag, followed by the IP address or domain name of the destination.
191 .PP
192 For testing purposes, the giaddr field of all packets that the client
193 sends can be set using the
194 .B -g
195 flag, followed by the IP address to send.   This is only useful for testing,
196 and should not be expected to work in any consistent or useful way.
197 .PP
198 On FreeBSD, dhclient can be enabled to automatically handle the
199 link status of the network card. Normally polling is done every
200 five seconds. The polling interval can be set using the
201 .B -i
202 flag, followed by the numbers of seconds. Minimum is one second.
203 .PP
204 The DHCP client will normally run in the foreground until it has
205 configured an interface, and then will revert to running in the
206 background.   To run force dhclient to always run as a foreground
207 process, the
208 .B -d
209 flag should be specified.  This is useful when running the client
210 under a debugger, or when running it out of inittab on System V
211 systems.
212 .PP
213 The client normally prints a startup message and displays the
214 protocol sequence to the standard error descriptor until it has
215 acquired an address, and then only logs messages using the
216 .B syslog (3)
217 facility.   The
218 .B -q
219 flag prevents any messages other than errors from being printed to the
220 standard error descriptor.
221 .B -v
222 flag turns on all messages.
223 Opposite of
224 .B -q .
225 .PP
226 The client normally doesn't release the current lease as it is not
227 required by the DHCP protocol.  Some cable ISPs require their clients
228 to notify the server if they wish to release an assigned IP address.
229 The
230 .B -r
231 flag explicitly releases the current lease, and once the lease has been
232 released, the client exits.
233 .PP
234 The
235 .B -1
236 flag cause dhclient to try once to get a lease.  If it fails, dhclient exits
237 with exit code two.
238 .PP
239 The DHCP client normally gets its configuration information from
240 .B ETCDIR/dhclient.conf,
241 its lease database from
242 .B DBDIR/dhclient.leases,
243 stores its process ID in a file called
244 .B RUNDIR/dhclient.pid,
245 and configures the network interface using
246 .B CLIENTBINDIR/dhclient-script
247 To specify different names and/or locations for these files, use the
248 .B -cf,
249 .B -lf,
250 .B -pf
251 and
252 .B -sf
253 flags, respectively, followed by the name of the file.   This can be
254 particularly useful if, for example,
255 .B DBDIR
256 or
257 .B RUNDIR
258 has not yet been mounted when the DHCP client is started.
259 .PP
260 The DHCP client normally exits if it isn't able to identify any
261 network interfaces to configure.   On laptop computers and other
262 computers with hot-swappable I/O buses, it is possible that a
263 broadcast interface may be added after system startup.   The
264 .B -w
265 flag can be used to cause the client not to exit when it doesn't find
266 any such interfaces.   The
267 .B omshell (8)
268 program can then be used to notify the client when a network interface
269 has been added or removed, so that the client can attempt to configure an IP
270 address on that interface.
271 .PP
272 The DHCP client can be directed not to attempt to configure any interfaces
273 using the
274 .B -n
275 flag.   This is most likely to be useful in combination with the
276 .B -w
277 flag.
278 .PP
279 The client can also be instructed to become a daemon immediately, rather
280 than waiting until it has acquired an IP address.   This can be done by
281 supplying the
282 .B -nw
283 flag.
284 .SH CONFIGURATION
285 The syntax of the dhclient.conf(5) file is discussed separately.
286 .SH OMAPI
287 The DHCP client provides some ability to control it while it is
288 running, without stopping it.  This capability is provided using OMAPI,
289 an API for manipulating remote objects.  OMAPI clients connect to the
290 client using TCP/IP, authenticate, and can then examine the client's
291 current status and make changes to it. 
292 .PP
293 Rather than implementing the underlying OMAPI protocol directly, user
294 programs should use the dhcpctl API or OMAPI itself.   Dhcpctl is a
295 wrapper that handles some of the housekeeping chores that OMAPI does
296 not do automatically.   Dhcpctl and OMAPI are documented in \fBdhcpctl(3)\fR
297 and \fBomapi(3)\fR.   Most things you'd want to do with the client can
298 be done directly using the \fBomshell(1)\fR command, rather than
299 having to write a special program.
300 .SH THE CONTROL OBJECT
301 The control object allows you to shut the client down, releasing all
302 leases that it holds and deleting any DNS records it may have added.
303 It also allows you to pause the client - this unconfigures any
304 interfaces the client is using.   You can then restart it, which
305 causes it to reconfigure those interfaces.   You would normally pause
306 the client prior to going into hibernation or sleep on a laptop
307 computer.   You would then resume it after the power comes back.
308 This allows PC cards to be shut down while the computer is hibernating
309 or sleeping, and then reinitialized to their previous state once the
310 computer comes out of hibernation or sleep.
311 .PP
312 The control object has one attribute - the state attribute.   To shut
313 the client down, set its state attribute to 2.   It will automatically
314 do a DHCPRELEASE.   To pause it, set its state attribute to 3.   To
315 resume it, set its state attribute to 4.
316 .PP
317 .SH FILES
318 .B CLIENTBINDIR/dhclient-script,
319 .B ETCDIR/dhclient.conf, DBDIR/dhclient.leases, RUNDIR/dhclient.pid,
320 .B DBDIR/dhclient.leases~.
321 .SH SEE ALSO
322 dhclient.conf(5), dhclient.leases(5), dhclient-script(8).
323 .SH AUTHOR
324 .B dhclient(8)
325 has been written for the Internet Software Consortium
326 by Ted Lemon in cooperation with Vixie
327 Enterprises.  To learn more about the Internet Software Consortium,
328 see
329 .B http://www.isc.org
330 To learn more about Vixie
331 Enterprises, see
332 .B http://www.vix.com.
333 .PP
334 This client was substantially modified and enhanced by Elliot Poger
335 for use on Linux while he was working on the MosquitoNet project at
336 Stanford.
337 .PP
338 The current version owes much to Elliot's Linux enhancements, but
339 was substantially reorganized and partially rewritten by Ted Lemon
340 so as to use the same networking framework that the Internet Software
341 Consortium DHCP server uses.   Much system-specific configuration code
342 was moved into a shell script so that as support for more operating
343 systems is added, it will not be necessary to port and maintain
344 system-specific configuration code to these operating systems - instead,
345 the shell script can invoke the native tools to accomplish the same
346 purpose.
347 .PP