]> git.pld-linux.org Git - packages/dhcp.git/blame - dhcp-manpages.patch
- patch no-ipv6 - don't require ipv6 support in kernel
[packages/dhcp.git] / dhcp-manpages.patch
CommitLineData
8c878a4c
ER
1diff -up dhcp-4.0.0/server/dhcpd.conf.5.manpages dhcp-4.0.0/server/dhcpd.conf.5
2--- dhcp-4.0.0/server/dhcpd.conf.5.manpages 2007-11-20 08:34:37.000000000 -1000
3+++ dhcp-4.0.0/server/dhcpd.conf.5 2008-01-02 11:26:38.000000000 -1000
4@@ -513,6 +513,9 @@ pool {
5 };
6 .fi
7 .PP
8+Dynamic BOOTP leases are not compatible with failover, and, as such,
9+you need to disallow BOOTP in pools that you are using failover for.
10+.PP
11 The server currently does very little sanity checking, so if you
12 configure it wrong, it will just fail in odd ways. I would recommend
13 therefore that you either do failover or don't do failover, but don't
14@@ -527,9 +530,9 @@ primary server might look like this:
15 failover peer "foo" {
16 primary;
17 address anthrax.rc.vix.com;
18- port 519;
19+ port 647;
20 peer address trantor.rc.vix.com;
21- peer port 520;
22+ peer port 847;
23 max-response-delay 60;
24 max-unacked-updates 10;
25 mclt 3600;
26@@ -588,9 +591,7 @@ statement
27 .B port \fIport-number\fR\fB;\fR
28 .PP
29 The \fBport\fR statement declares the TCP port on which the server
30-should listen for connections from its failover peer. This statement
31-may not currently be omitted, because the failover protocol does not
32-yet have a reserved TCP port number.
33+should listen for connections from its failover peer.
34 .RE
35 .PP
36 The
37@@ -602,10 +603,8 @@ statement
38 .PP
39 The \fBpeer port\fR statement declares the TCP port to which the
40 server should connect to reach its failover peer for failover
41-messages. This statement may not be omitted because the failover
42-protocol does not yet have a reserved TCP port number. The port
43-number declared in the \fBpeer port\fR statement may be the same as
44-the port number declared in the \fBport\fR statement.
45+messages. The port number declared in the \fBpeer port\fR statement
46+may be the same as the port number declared in the \fBport\fR statement.
47 .RE
48 .PP
49 The
50@@ -1272,7 +1271,7 @@ the zone containing PTR records - for IS
51 .PP
52 .nf
53 key DHCP_UPDATER {
54- algorithm HMAC-MD5.SIG-ALG.REG.INT;
55+ algorithm hmac-md5;
56 secret pRP5FapFoJ95JEL06sv4PQ==;
57 };
58
59@@ -1295,7 +1294,7 @@ dhcpd.conf file:
60 .PP
61 .nf
62 key DHCP_UPDATER {
63- algorithm HMAC-MD5.SIG-ALG.REG.INT;
64+ algorithm hmac-md5;
65 secret pRP5FapFoJ95JEL06sv4PQ==;
66 };
67
68@@ -2433,7 +2432,8 @@ statement
69 The \fInext-server\fR statement is used to specify the host address of
70 the server from which the initial boot file (specified in the
71 \fIfilename\fR statement) is to be loaded. \fIServer-name\fR should
72-be a numeric IP address or a domain name.
73+be a numeric IP address or a domain name. If no \fInext-server\fR statement
74+applies to a given client, the address 0.0.0.0 is used.
75 .RE
76 .PP
77 The
78diff -up dhcp-4.0.0/common/dhcp-options.5.manpages dhcp-4.0.0/common/dhcp-options.5
79--- dhcp-4.0.0/common/dhcp-options.5.manpages 2007-09-17 07:52:01.000000000 -1000
80+++ dhcp-4.0.0/common/dhcp-options.5 2008-01-02 11:26:38.000000000 -1000
81@@ -896,6 +896,21 @@ classless IP routing - it does not inclu
82 classless IP routing is now the most widely deployed routing standard,
83 this option is virtually useless, and is not implemented by any of the
84 popular DHCP clients, for example the Microsoft DHCP client.
85+.PP
86+NOTE to @PRODUCTNAME@ dhclient users:
87+.br
88+dhclient-script interprets trailing 0 octets of the target as indicating
89+the subnet class of the route, so for the following static-routes value:
90+.br
91+ option static-routes 172.0.0.0 172.16.2.254,
92+.br
93+ 192.168.0.0 192.168.2.254;
94+.br
95+dhclient-script will create routes:
96+.br
97+ 172/8 via 172.16.2.254 dev $interface
98+.br
99+ 192.168/16 via 192.168.2.254 dev $interface
100 .RE
101 .PP
102 .nf
103diff -up dhcp-4.0.0/client/dhclient-script.8.manpages dhcp-4.0.0/client/dhclient-script.8
104--- dhcp-4.0.0/client/dhclient-script.8.manpages 2006-02-24 13:16:27.000000000 -1000
105+++ dhcp-4.0.0/client/dhclient-script.8 2008-01-02 11:26:38.000000000 -1000
106@@ -47,7 +47,7 @@ customizations are needed, they should b
107 exit hooks provided (see HOOKS for details). These hooks will allow the
108 user to override the default behaviour of the client in creating a
109 .B /etc/resolv.conf
110-file.
111+file, and to handle DHCP options not handled by default.
112 .PP
113 No standard client script exists for some operating systems, even though
114 the actual client may work, so a pioneering user may well need to create
115@@ -91,6 +91,26 @@ present. The
116 .B ETCDIR/dhclient-exit-hooks
117 script can modify the valid of exit_status to change the exit status
118 of dhclient-script.
119+.PP
120+Immediately after dhclient brings an interface UP with a new IP address,
121+subnet mask, and routes, in the REBOOT/BOUND states, it will check for the
122+existence of an executable
123+.B ETCDIR/dhclient-up-hooks
124+script, and source it if found. This script can handle DHCP options in
125+the environment that are not handled by default. A per-interface.
126+.B ETCDIR/dhclient-${IF}-up-hooks
127+script will override the generic script and be sourced when interface
128+$IF has been brought up.
129+.PP
130+Immediately before dhclient brings an interface DOWN, removing its IP
131+address, subnet mask, and routes, in the STOP/RELEASE states, it will
132+check for the existence of an executable
133+.B ETCDIR/dhclient-down-hooks
134+script, and source it if found. This script can handle DHCP options in
135+the environment that are not handled by default. A per-interface
136+.B ETCDIR/dhclient-${IF}-down-hooks
137+script will override the generic script and be sourced when interface
138+$IF is about to be brought down.
139 .SH OPERATION
140 When dhclient needs to invoke the client configuration script, it
141 defines a set of variables in the environment, and then invokes
142diff -up dhcp-4.0.0/client/dhclient.conf.5.manpages dhcp-4.0.0/client/dhclient.conf.5
143--- dhcp-4.0.0/client/dhclient.conf.5.manpages 2007-08-23 06:06:08.000000000 -1000
144+++ dhcp-4.0.0/client/dhclient.conf.5 2008-01-02 11:26:38.000000000 -1000
145@@ -186,9 +186,9 @@ responding to the client send the client
146 options. Only the option names should be specified in the request
147 statement - not option parameters. By default, the DHCP server
148 requests the subnet-mask, broadcast-address, time-offset, routers,
149-domain-name, domain-name-servers and host-name options. Note that if
150-you enter a 'request' statement, you over-ride this default and these
151-options will not be requested.
152+domain-name, domain-name-servers host-name, nis-domain, nis-servers,
153+and ntp-servers options. Note that if you enter a 'request' statement,
154+you over-ride this default and these options will not be requested.
155 .PP
156 In some cases, it may be desirable to send no parameter request list
157 at all. To do this, simply write the request statement but specify
158@@ -626,6 +626,18 @@ database and will record the media type
159 Whenever the client tries to renew the lease, it will use that same
160 media type. The lease must expire before the client will go back to
161 cycling through media types.
162+.PP
163+ \fBbootp-broadcast-always;\fR
164+.PP
165+The
166+.B bootp-broadcast-always
167+statement instructs dhclient to always set the bootp broadcast flag in
168+request packets, so that servers will always broadcast replies.
169+This is equivalent to supplying the dhclient -B argument, and has
170+the same effect as specifying 'always-broadcast' in the server's dhcpd.conf.
171+This option is provided as an extension to enable dhclient to work
172+on IBM s390 Linux guests.
173+.PP
174 .SH SAMPLE
175 The following configuration file is used on a laptop running NetBSD
176 1.3. The laptop has an IP alias of 192.5.5.213, and has one
177diff -up dhcp-4.0.0/client/dhclient.8.manpages dhcp-4.0.0/client/dhclient.8
178--- dhcp-4.0.0/client/dhclient.8.manpages 2007-10-04 07:13:25.000000000 -1000
179+++ dhcp-4.0.0/client/dhclient.8 2008-01-02 11:26:38.000000000 -1000
180@@ -91,6 +91,33 @@ relay
181 .B -w
182 ]
183 [
184+.B -B
185+]
186+[
187+.B -I
188+.I dhcp-client-identifier
189+]
190+[
191+.B -H
192+.I host-name
193+]
194+[
195+.B -F
196+.I fqdn.fqdn
197+]
198+[
199+.B -V
200+.I vendor-class-identifier
201+]
202+[
203+.B -R
204+.I request-option-list
205+]
206+[
207+.B -T
208+.I timeout
209+]
210+[
211 .B -v
212 ]
213 [
214@@ -118,16 +145,6 @@ important details about the network to w
215 the location of a default router, the location of a name server, and
216 so on.
217 .PP
218-If given the -4 command line argument (default), dhclient will use the
219-DHCPv4 protocol to obtain an IPv4 address and configuration parameters.
220-.PP
221-If given the -6 command line argument, dhclient will use the DHCPv6
222-protocol to obtain whatever IPv6 addresses are available along with
223-configuration parameters. Information-request is not yet supported.
224-.PP
225-If given the --version command line argument, dhclient will print its
226-version number and exit.
227-.PP
228 On startup, dhclient reads the
229 .IR dhclient.conf
230 for configuration instructions. It then gets a list of all the
231@@ -181,67 +198,183 @@ file. If interfaces are specified in t
232 only configure interfaces that are either specified in the
233 configuration file or on the command line, and will ignore all other
234 interfaces.
235-.PP
236-If the DHCP client should listen and transmit on a port other than the
237-standard (port 68), the
238-.B -p
239-flag may used. It should be followed by the udp port number that
240-dhclient should use. This is mostly useful for debugging purposes.
241-If a different port is specified for the client to listen on and
242-transmit on, the client will also use a different destination port -
243-one greater than the specified destination port.
244-.PP
245-The DHCP client normally transmits any protocol messages it sends
246-before acquiring an IP address to, 255.255.255.255, the IP limited
247-broadcast address. For debugging purposes, it may be useful to have
248-the server transmit these messages to some other address. This can
249-be specified with the
250-.B -s
251-flag, followed by the IP address or domain name of the destination.
252-.PP
253-For testing purposes, the giaddr field of all packets that the client
254-sends can be set using the
255-.B -g
256-flag, followed by the IP address to send. This is only useful for testing,
257-and should not be expected to work in any consistent or useful way.
258-.PP
259-The DHCP client will normally run in the foreground until it has
260-configured an interface, and then will revert to running in the
261-background. To run force dhclient to always run as a foreground
262-process, the
263-.B -d
264-flag should be specified. This is useful when running the client
265-under a debugger, or when running it out of inittab on System V
266-systems.
267-.PP
268-The dhclient daemon creates its own environment when executing the
269-dhclient-script to do the grunt work of interface configuration.
270-To define extra environment variables and their values, use the
271-.B -e
272-flag, followed by the environment variable name and value assignment,
273-just as one would assign a variable in a shell. Eg:
274-.B -e
275-.I IF_METRIC=1
276-.PP
277-The client normally prints no output during its startup sequence. It
278-can be made to emit verbose messages displaying the startup sequence events
279-until it has acquired an address by supplying the
280-.B -v
281-command line argument. In either case, the client logs messages using
282-the
283-.B syslog (3)
284-facility. A
285-.B -q
286-command line argument is provided for backwards compatibility, but since
287-dhclient is quiet by default, it has no effect.
288-.PP
289-The client normally doesn't release the current lease as it is not
290-required by the DHCP protocol. Some cable ISPs require their clients
291-to notify the server if they wish to release an assigned IP address.
292+.SH OPTIONS
293+.TP
294+.BI \-4
295+Use the DHCPv4 protocol to obtain an IPv4 address and configuration
296+parameters.
297+
298+.TP
299+.BI \-6
300+Use the DHCPv6 protocol to obtain whatever IPv6 addresses are available
301+along with configuration parameters. Information-request is not yet
302+supported.
303+
304+.TP
305+.BI \-p\ <port\ number>
306+The UDP port number the DHCP client should listen and transmit on. If
307+unspecified,
308+.B dhclient
309+uses the default port 68. This option is mostly useful for debugging
310+purposes. If a different port is specified for the client to listen and
311+transmit on, the client will also use a different destination port - one
312+greater than the specified destination port.
313+
314+.TP
315+.BI \-d
316+Force
317+.B dhclient
318+to run as a foreground process. This is useful when running the client
319+under a debugger, or when running it out of inittab on System V systems.
320+
321+.TP
322+.BI \-e\ VAR=value
323+Define additional environment variables for the environment where
324+dhclient-script executes. You may specify multiple
325+.B \-e
326+options on the command line.
327+
328+.TP
329+.BI \-q
330+Suppress all terminal and log output except error messages.
331+
332+.TP
333+.BI \-1
334+Try one to get a lease. On failure, exit with code 2.
335+
336+.TP
337+.BI \-r
338+Tell
339+.B dhclient
340+to release the current lease it has from the server. This is not required
341+by the DHCP protocol, but some ISPs require their clients to notify the
342+server if they wish to release an assigned IP address.
343+
344+.TP
345+.BI \-lf\ <lease-file>
346+Path to the lease database file. If unspecified, the default
347+.B DBDIR/dhclient.leases
348+is used.
349+
350+.TP
351+.BI \-pf\ <pid-file>
352+Path to the process ID file. If unspecified, the default
353+.B RUNDIR/dhclient.pid
354+is used.
355+
356+.TP
357+.BI \-cf\ <config-file>
358+Path to the client configuration file. If unspecified, the default
359+.B ETCDIR/dhclient.conf
360+is used.
361+
362+.TP
363+.BI \-sf\ <script-file>
364+Path to the network configuration script invoked by
365+.B dhclient
366+when it gets a lease. If unspecified, the default
367+.B CLIENTBINDIR/dhclient-script
368+is used.
369+
370+.TP
371+.BI \-s\ <server>
372+Specifiy the server IP address or fully qualified domain name to transmit
373+DHCP protocol messages to. Normally,
374+.B dhclient
375+transmits these messages to 255.255.255.255 (the IP limited broadcast
376+address). Overriding this is mostly useful for debugging purposes.
377+
378+.TP
379+.BI \-g\ <relay>
380+Only for debugging. Set the giaddr field of all packets the client
381+sends to the IP address specified. This should not be expected to work
382+in any consistent or useful way.
383+
384+.TP
385+.BI \-n
386+Do not configure any interfaces. Most useful combined with the
387+.B -w
388+option.
389+
390+.TP
391+.BI \-nw
392+Become a daemon process immediately (nowait) rather than waiting until an IP
393+address has been acquired.
394+
395+.TP
396+.BI \-w
397+Keep running even if no network interfaces are found. The
398+.B omshell
399+program can be used to notify the client when a network interface has been
400+added or removed so it can attempt to configure an IP address on that
401+interface.
402+
403+.TP
404+.BI \-B
405+Set the BOOTP broadcast flag in request packets so servers will always
406+broadcast replies.
407+
408+.TP
409+.BI \-I\ <dhcp-client-identifier>
410+Specify the dhcp-client-identifier option to send to the DHCP server.
411+
412+.TP
413+.BI \-H\ <host-name>
414+Specify the host-name option to send to the DHCP server. The host-name
415+string only contains the client's hostname prefix, to which the server will
416+append the ddns-domainname or domain-name options, if any, to derive the
417+fully qualified domain name of the client. The
418+.B -H
419+option cannot be used with the
420+.B -F
421+option.
422+
423+.TP
424+.BI \-F\ <fqdn.fqdn>
425+Specify the fqdn.fqdn option to send to the DHCP server. This option cannot
426+be used with the
427+.B -H
428+option. The fqdn.fqdn option must specify the complete domain name of the
429+client host, which the server may use for dynamic DNS updates.
430+
431+.TP
432+.BI \-V\ <vendor-class-identifier>
433+Specify the vendor-class-identifier option to send to the DHCP server.
434+
435+.TP
436+.BI \-R\ <option>[,<option>...]
437+Specify the list of options the client is to request from the server. The
438+option list must be a single string consisting of option names separated
439+by at least one command and optional space characters. The default option
440+list is:
441+
442+.BR
443+ subnet-mask, broadcast-address, time-offset, routers,
444+.BR
445+ domain-name, domain-name-servers, host-name, nis-domain,
446+.BR
447+ nis-servers, ntp-servers
448+
449 The
450-.B -r
451-flag explicitly releases the current lease, and once the lease has been
452-released, the client exits.
453+.B -R
454+option does not append options to the default request, it overrides the
455+default request list. Keep this in mind if you want to request an
456+additional option besides the default request list. You will have to
457+specify all option names for the
458+.B -R
459+parameter.
460+
461+.TP
462+.BI \-T\ <timeout>
463+Specify the time after which
464+.B dhclient
465+will decide that no DHCP servers can be contacted when no responses have been
466+received.
467+
468+.TP
469+.BI \-v
470+Enable verbose log messages.
471+
472 .PP
473 If the client is killed by a signal (for example at shutdown or reboot)
474 it won't execute the
475@@ -253,57 +386,7 @@ or
476 it will execute
477 .B dhclient-script (8)
478 at shutdown with the specific reason for calling the script set.
479-.PP
480-The
481-.B -1
482-flag will cause dhclient to try once to get a lease. If it fails, dhclient
483-exits with exit code two.
484-.PP
485-The DHCP client normally gets its configuration information from
486-.B ETCDIR/dhclient.conf,
487-its lease database from
488-.B DBDIR/dhclient.leases,
489-stores its process ID in a file called
490-.B RUNDIR/dhclient.pid,
491-and configures the network interface using
492-.B CLIENTBINDIR/dhclient-script
493-To specify different names and/or locations for these files, use the
494-.B -cf,
495-.B -lf,
496-.B -pf
497-and
498-.B -sf
499-flags, respectively, followed by the name of the file. This can be
500-particularly useful if, for example,
501-.B DBDIR
502-or
503-.B RUNDIR
504-has not yet been mounted when the DHCP client is started.
505-.PP
506-The DHCP client normally exits if it isn't able to identify any
507-network interfaces to configure. On laptop computers and other
508-computers with hot-swappable I/O buses, it is possible that a
509-broadcast interface may be added after system startup. The
510-.B -w
511-flag can be used to cause the client not to exit when it doesn't find
512-any such interfaces. The
513-.B omshell (1)
514-program can then be used to notify the client when a network interface
515-has been added or removed, so that the client can attempt to configure an IP
516-address on that interface.
517-.PP
518-The DHCP client can be directed not to attempt to configure any interfaces
519-using the
520-.B -n
521-flag. This is most likely to be useful in combination with the
522-.B -w
523-flag.
524-.PP
525-The client can also be instructed to become a daemon immediately, rather
526-than waiting until it has acquired an IP address. This can be done by
527-supplying the
528-.B -nw
529-flag.
530+
531 .SH CONFIGURATION
532 The syntax of the dhclient.conf(5) file is discussed separately.
533 .SH OMAPI
This page took 0.155017 seconds and 4 git commands to generate.