From: Ted Lemon Date: Sat, 22 Feb 1997 10:19:20 +0000 (+0000) Subject: New manual pages X-Git-Tag: DHCP_970222~36 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=0e7affc72c3497e67b69e408857c73afa87cd1b3;p=thirdparty%2Fdhcp.git New manual pages --- diff --git a/client/dhclient.8 b/client/dhclient.8 new file mode 100644 index 000000000..6edd6a31c --- /dev/null +++ b/client/dhclient.8 @@ -0,0 +1,163 @@ +.\" dhclient.8 +.\" +.\" Copyright (c) 1997 The Internet Software Consortium. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of The Internet Software Consortium nor the names +.\" of its contributors may be used to endorse or promote products derived +.\" from this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE INTERNET SOFTWARE CONSORTIUM AND +.\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, +.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +.\" DISCLAIMED. IN NO EVENT SHALL THE INTERNET SOFTWARE CONSORTIUM OR +.\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF +.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +.\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" This software has been written for the Internet Software Consortium +.\" by Ted Lemon in cooperation with Vixie +.\" Enterprises. To learn more about the Internet Software Consortium, +.\" see ``http://www.isc.org/isc''. To learn more about Vixie +.\" Enterprises, see ``http://www.vix.com''. +.TH dhclient 8 +.SH NAME +dhcpd - Dynamic Host Configuration Protocol Client +.SH SYNOPSIS +.B dhclient +[ +.B -p +.I port +] +[ +.B -d +] +[ +.I if0 +[ +.I ...ifN +] +] +.SH DESCRIPTION +The Internet Software Consortium DHCP Client, dhclient, provides a +means for configuring one or more network interfaces using the Dynamic +Host Configuration Protocol, BOOTP protocol, or if these protocols +fail, by statically assigning an address. +.SH OPERATION +.PP +The DHCP protocol allows a host to contact a central server which +maintains a list of IP addresses which may be assigned on one or more +subnets. A DHCP client may request an address from this pool, and +then use it on a temporary basis for communication on network. The +DHCP protocol also provides a mechanism whereby a client can learn +important details about the network to which it is attached, such as +the location of a default router, the location of a name server, and +so on. +.PP +On startup, dhclient reads the +.IR dhclient.conf +for configuration instructions. It then gets a list of all the +network interfaces that are configured in the current system. For +each interface, it attempts to configure the interface using the DHCP +protocol. +.PP +In order to keep track of leases across system reboots and server +restarts, dhclient keeps a list of leases it has been assigned in the +dhclient.leases(5) file. On startup, after reading the dhclient.conf +file, dhclient reads the dhclient.leases file to refresh its memory +about what leases it has been assigned. +.PP +When a new lease is acquired, it is appended to the end of the +dhclient.leases file. In order to prevent the file from becoming +arbitrarily large, from time to time dhclient creates a new +dhclient.leases file from its in-core lease database. The old version +of the dhclient.leases file is retained under the name +.IR dhcpd.leases~ +until the next time dhclient rewrites the database. +.PP +Old leases are kept around in case the DHCP server is unavailable when +dhclient is first invoked (generally during the initial system boot +process). In that event, old leases from the dhclient.leases file +which have not yet expired are tested, and if they are determined to +be valid, they are used until either they expire or the DHCP server +becomes available. +.PP +A mobile host which may sometimes need to access a network on which no +DHCP server exists may be preloaded with a lease for a fixed +address on that network. When all attempts to contact a DHCP server +have failed, dhclient will try to validate the static lease, and if it +succeeds, will use that lease until it is restarted. +.PP +A mobile host may also travel to some networks on which DHCP is not +available but BOOTP is. In that case, it may be advantageous to +arrange with the network administrator for an entry on the BOOTP +database, so that the host can boot quickly on that network rather +than cycling through the list of old leases. +.SH COMMAND LINE +.PP +The names of the network interfaces that dhclient should attempt to +configure may be specified on the command line. If no interface names +are specified on the command line dhclient will identify all network +interfaces, elimininating non-broadcast interfaces if possible, and +attempt to configure each interface. +.PP +If dhclient should listen and transmit on a port other than the +standard (port 68), the +.B -p +flag may used. It should be followed by the udp port number that +dhclient should use. This is mostly useful for debugging purposes. +.PP +Dhclient will normally run in the foreground until it has configured +an interface, and then will revert to running in the background. +To run force dhclient to always run as a foreground process, the +.B -d +flag should be specified. This is useful when running dhclient under +a debugger, or when running it out of inittab on System V systems. +.PP +.SH CONFIGURATION +The syntax of the dhclient.conf(8) file is discussed seperately. +.SH FILES +.B ETCDIR/dhclient.conf, DBDIR/dhclient.leases, RUNDIR/dhclient.pid, +.B DBDIR/dhclient.leases~. +.SH SEE ALSO +dhcpd(8), dhcrelay(8), dhclient.conf(5), dhclient.leases(5) +.SH AUTHOR +.B dhclient(8) +has been written for the Internet Software Consortium +by Ted Lemon in cooperation with Vixie +Enterprises. To learn more about the Internet Software Consortium, +see +.B http://www.vix.com/isc. +To learn more about Vixie +Enterprises, see +.B http://www.vix.com. +.PP +This client was substantially modified and enhanced by Elliot Poger +for use on Linux while he was working on the MosquitoNet project at +Stanford. +.PP +The current version owes much to Elliot's Linux enhancements, but +was substantially reorganized and partially rewritten by Ted Lemon +so as to use the same networking framework that the Internet Software +Consortium DHCP server uses. Much system-specific configuration code +was moved into a shell script so that as support for more operating +systems is added, it will not be necessary to port and maintain +system-specific configuration code to these operating systems - instead, +the shell script can invoke the native tools to accomplish the same +purpose. +.PP diff --git a/client/dhclient.cat8 b/client/dhclient.cat8 new file mode 100644 index 000000000..af8ac0415 --- /dev/null +++ b/client/dhclient.cat8 @@ -0,0 +1,198 @@ + + + +dhclient(8) dhclient(8) + + +NNAAMMEE + dhcpd - Dynamic Host Configuration Protocol Client + +SSYYNNOOPPSSIISS + ddhhcclliieenntt [ --pp _p_o_r_t ] [ --dd ] [ _i_f_0 [ _._._._i_f_N ] ] + +DDEESSCCRRIIPPTTIIOONN + The Internet Software Consortium DHCP Client, dhclient, + provides a means for configuring one or more network + interfaces using the Dynamic Host Configuration Protocol, + BOOTP protocol, or if these protocols fail, by statically + assigning an address. + +OOPPEERRAATTIIOONN + The DHCP protocol allows a host to contact a central + server which maintains a list of IP addresses which may be + assigned on one or more subnets. A DHCP client may + request an address from this pool, and then use it on a + temporary basis for communication on network. The DHCP + protocol also provides a mechanism whereby a client can + learn important details about the network to which it is + attached, such as the location of a default router, the + location of a name server, and so on. + + On startup, dhclient reads the _d_h_c_l_i_e_n_t_._c_o_n_f for configu- + ration instructions. It then gets a list of all the net- + work interfaces that are configured in the current system. + For each interface, it attempts to configure the interface + using the DHCP protocol. + + In order to keep track of leases across system reboots and + server restarts, dhclient keeps a list of leases it has + been assigned in the dhclient.leases(5) file. On + startup, after reading the dhclient.conf file, dhclient + reads the dhclient.leases file to refresh its memory about + what leases it has been assigned. + + When a new lease is acquired, it is appended to the end of + the dhclient.leases file. In order to prevent the file + from becoming arbitrarily large, from time to time + dhclient creates a new dhclient.leases file from its in- + core lease database. The old version of the + dhclient.leases file is retained under the name + _d_h_c_p_d_._l_e_a_s_e_s_~ until the next time dhclient rewrites the + database. + + Old leases are kept around in case the DHCP server is + unavailable when dhclient is first invoked (generally dur- + ing the initial system boot process). In that event, old + leases from the dhclient.leases file which have not yet + expired are tested, and if they are determined to be + valid, they are used until either they expire or the DHCP + server becomes available. + + + + + 1 + + + + + +dhclient(8) dhclient(8) + + + A mobile host which may sometimes need to access a network + on which no DHCP server exists may be preloaded with a + lease for a fixed address on that network. When all + attempts to contact a DHCP server have failed, dhclient + will try to validate the static lease, and if it succeeds, + will use that lease until it is restarted. + + A mobile host may also travel to some networks on which + DHCP is not available but BOOTP is. In that case, it may + be advantageous to arrange with the network administrator + for an entry on the BOOTP database, so that the host can + boot quickly on that network rather than cycling through + the list of old leases. + +CCOOMMMMAANNDD LLIINNEE + The names of the network interfaces that dhclient should + attempt to configure may be specified on the command line. + If no interface names are specified on the command line + dhclient will identify all network interfaces, elimininat- + ing non-broadcast interfaces if possible, and attempt to + configure each interface. + + If dhclient should listen and transmit on a port other + than the standard (port 68), the --pp flag may used. It + should be followed by the udp port number that dhclient + should use. This is mostly useful for debugging purposes. + + Dhclient will normally run in the foreground until it has + configured an interface, and then will revert to running + in the background. To run force dhclient to always run as + a foreground process, the --dd flag should be specified. + This is useful when running dhclient under a debugger, or + when running it out of inittab on System V systems. + + +CCOONNFFIIGGUURRAATTIIOONN + The syntax of the dhclient.conf(8) file is discussed + seperately. + +FFIILLEESS + //eettcc//ddhhcclliieenntt..ccoonnff,, //vvaarr//ddbb//ddhhcclliieenntt..lleeaasseess,, + //vvaarr//rruunn//ddhhcclliieenntt..ppiidd,, //vvaarr//ddbb//ddhhcclliieenntt..lleeaasseess~~.. + +SSEEEE AALLSSOO + dhcpd(8), dhcrelay(8), dhclient.conf(5), + dhclient.leases(5) + +AAUUTTHHOORR + ddhhcclliieenntt((88)) has been written for the Internet Software + Consortium by Ted Lemon in cooperation + with Vixie Enterprises. To learn more about the Internet + Software Consortium, see hhttttpp::////wwwwww..vviixx..ccoomm//iisscc.. To learn + more about Vixie Enterprises, see hhttttpp::////wwwwww..vviixx..ccoomm.. + + + + + 2 + + + + + +dhclient(8) dhclient(8) + + + This client was substantially modified and enhanced by + Elliot Poger for use on Linux while he was working on the + MosquitoNet project at Stanford. + + The current version owes much to Elliot's Linux enhance- + ments, but was substantially reorganized and partially + rewritten by Ted Lemon so as to use the same networking + framework that the Internet Software Consortium DHCP + server uses. Much system-specific configuration code was + moved into a shell script so that as support for more + operating systems is added, it will not be necessary to + port and maintain system-specific configuration code to + these operating systems - instead, the shell script can + invoke the native tools to accomplish the same purpose. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 3 + + diff --git a/client/dhclient.conf.5 b/client/dhclient.conf.5 new file mode 100644 index 000000000..25d5d8f22 --- /dev/null +++ b/client/dhclient.conf.5 @@ -0,0 +1,63 @@ +.\" dhclient.conf.5 +.\" +.\" Copyright (c) 1997 The Internet Software Consortium. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of The Internet Software Consortium nor the names +.\" of its contributors may be used to endorse or promote products derived +.\" from this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE INTERNET SOFTWARE CONSORTIUM AND +.\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, +.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +.\" DISCLAIMED. IN NO EVENT SHALL THE INTERNET SOFTWARE CONSORTIUM OR +.\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF +.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +.\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" This software has been written for the Internet Software Consortium +.\" by Ted Lemon in cooperation with Vixie +.\" Enterprises. To learn more about the Internet Software Consortium, +.\" see ``http://www.isc.org/isc''. To learn more about Vixie +.\" Enterprises, see ``http://www.vix.com''. +.TH dhcpd.conf 5 +.SH NAME +dhclient.conf - DHCP client configuration file +.SH DESCRIPTION +The dhclient.conf file contains configuration information for +.IR dhclient, +the Internet Software Consortium DHCP Client. +.PP +The dhclient.conf file is a free-form ASCII text file. It is parsed by +the recursive-descent parser built into dhclient. The file may contain +extra tabs and newlines for formatting purposes. Keywords in the file +are case-insensitive. Comments may be placed anywhere within the +file (except within quotes). Comments begin with the # character and +end at the end of the line. +.PP + \fBTHIS DOCUMENTATION IS NOT YET COMPLETE - SORRY\fR +.SH SEE ALSO +dhcpd.conf(5), dhclient.leases(5), +draft-ietf-dhc-options-1533update-04.txt, draft-ietf-dhc-dhcp-07.txt. +.SH AUTHOR +.B dhclient(8) +was written by Ted Lemon +under a contract with Vixie Labs. Funding +for this project was provided by the Internet Software Corporation. +Information about the Internet Software Consortium can be found at +.B http://www.isc.org/isc. diff --git a/dhclient.8 b/dhclient.8 new file mode 100644 index 000000000..6edd6a31c --- /dev/null +++ b/dhclient.8 @@ -0,0 +1,163 @@ +.\" dhclient.8 +.\" +.\" Copyright (c) 1997 The Internet Software Consortium. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of The Internet Software Consortium nor the names +.\" of its contributors may be used to endorse or promote products derived +.\" from this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE INTERNET SOFTWARE CONSORTIUM AND +.\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, +.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +.\" DISCLAIMED. IN NO EVENT SHALL THE INTERNET SOFTWARE CONSORTIUM OR +.\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF +.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +.\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" This software has been written for the Internet Software Consortium +.\" by Ted Lemon in cooperation with Vixie +.\" Enterprises. To learn more about the Internet Software Consortium, +.\" see ``http://www.isc.org/isc''. To learn more about Vixie +.\" Enterprises, see ``http://www.vix.com''. +.TH dhclient 8 +.SH NAME +dhcpd - Dynamic Host Configuration Protocol Client +.SH SYNOPSIS +.B dhclient +[ +.B -p +.I port +] +[ +.B -d +] +[ +.I if0 +[ +.I ...ifN +] +] +.SH DESCRIPTION +The Internet Software Consortium DHCP Client, dhclient, provides a +means for configuring one or more network interfaces using the Dynamic +Host Configuration Protocol, BOOTP protocol, or if these protocols +fail, by statically assigning an address. +.SH OPERATION +.PP +The DHCP protocol allows a host to contact a central server which +maintains a list of IP addresses which may be assigned on one or more +subnets. A DHCP client may request an address from this pool, and +then use it on a temporary basis for communication on network. The +DHCP protocol also provides a mechanism whereby a client can learn +important details about the network to which it is attached, such as +the location of a default router, the location of a name server, and +so on. +.PP +On startup, dhclient reads the +.IR dhclient.conf +for configuration instructions. It then gets a list of all the +network interfaces that are configured in the current system. For +each interface, it attempts to configure the interface using the DHCP +protocol. +.PP +In order to keep track of leases across system reboots and server +restarts, dhclient keeps a list of leases it has been assigned in the +dhclient.leases(5) file. On startup, after reading the dhclient.conf +file, dhclient reads the dhclient.leases file to refresh its memory +about what leases it has been assigned. +.PP +When a new lease is acquired, it is appended to the end of the +dhclient.leases file. In order to prevent the file from becoming +arbitrarily large, from time to time dhclient creates a new +dhclient.leases file from its in-core lease database. The old version +of the dhclient.leases file is retained under the name +.IR dhcpd.leases~ +until the next time dhclient rewrites the database. +.PP +Old leases are kept around in case the DHCP server is unavailable when +dhclient is first invoked (generally during the initial system boot +process). In that event, old leases from the dhclient.leases file +which have not yet expired are tested, and if they are determined to +be valid, they are used until either they expire or the DHCP server +becomes available. +.PP +A mobile host which may sometimes need to access a network on which no +DHCP server exists may be preloaded with a lease for a fixed +address on that network. When all attempts to contact a DHCP server +have failed, dhclient will try to validate the static lease, and if it +succeeds, will use that lease until it is restarted. +.PP +A mobile host may also travel to some networks on which DHCP is not +available but BOOTP is. In that case, it may be advantageous to +arrange with the network administrator for an entry on the BOOTP +database, so that the host can boot quickly on that network rather +than cycling through the list of old leases. +.SH COMMAND LINE +.PP +The names of the network interfaces that dhclient should attempt to +configure may be specified on the command line. If no interface names +are specified on the command line dhclient will identify all network +interfaces, elimininating non-broadcast interfaces if possible, and +attempt to configure each interface. +.PP +If dhclient should listen and transmit on a port other than the +standard (port 68), the +.B -p +flag may used. It should be followed by the udp port number that +dhclient should use. This is mostly useful for debugging purposes. +.PP +Dhclient will normally run in the foreground until it has configured +an interface, and then will revert to running in the background. +To run force dhclient to always run as a foreground process, the +.B -d +flag should be specified. This is useful when running dhclient under +a debugger, or when running it out of inittab on System V systems. +.PP +.SH CONFIGURATION +The syntax of the dhclient.conf(8) file is discussed seperately. +.SH FILES +.B ETCDIR/dhclient.conf, DBDIR/dhclient.leases, RUNDIR/dhclient.pid, +.B DBDIR/dhclient.leases~. +.SH SEE ALSO +dhcpd(8), dhcrelay(8), dhclient.conf(5), dhclient.leases(5) +.SH AUTHOR +.B dhclient(8) +has been written for the Internet Software Consortium +by Ted Lemon in cooperation with Vixie +Enterprises. To learn more about the Internet Software Consortium, +see +.B http://www.vix.com/isc. +To learn more about Vixie +Enterprises, see +.B http://www.vix.com. +.PP +This client was substantially modified and enhanced by Elliot Poger +for use on Linux while he was working on the MosquitoNet project at +Stanford. +.PP +The current version owes much to Elliot's Linux enhancements, but +was substantially reorganized and partially rewritten by Ted Lemon +so as to use the same networking framework that the Internet Software +Consortium DHCP server uses. Much system-specific configuration code +was moved into a shell script so that as support for more operating +systems is added, it will not be necessary to port and maintain +system-specific configuration code to these operating systems - instead, +the shell script can invoke the native tools to accomplish the same +purpose. +.PP diff --git a/dhclient.cat8 b/dhclient.cat8 new file mode 100644 index 000000000..af8ac0415 --- /dev/null +++ b/dhclient.cat8 @@ -0,0 +1,198 @@ + + + +dhclient(8) dhclient(8) + + +NNAAMMEE + dhcpd - Dynamic Host Configuration Protocol Client + +SSYYNNOOPPSSIISS + ddhhcclliieenntt [ --pp _p_o_r_t ] [ --dd ] [ _i_f_0 [ _._._._i_f_N ] ] + +DDEESSCCRRIIPPTTIIOONN + The Internet Software Consortium DHCP Client, dhclient, + provides a means for configuring one or more network + interfaces using the Dynamic Host Configuration Protocol, + BOOTP protocol, or if these protocols fail, by statically + assigning an address. + +OOPPEERRAATTIIOONN + The DHCP protocol allows a host to contact a central + server which maintains a list of IP addresses which may be + assigned on one or more subnets. A DHCP client may + request an address from this pool, and then use it on a + temporary basis for communication on network. The DHCP + protocol also provides a mechanism whereby a client can + learn important details about the network to which it is + attached, such as the location of a default router, the + location of a name server, and so on. + + On startup, dhclient reads the _d_h_c_l_i_e_n_t_._c_o_n_f for configu- + ration instructions. It then gets a list of all the net- + work interfaces that are configured in the current system. + For each interface, it attempts to configure the interface + using the DHCP protocol. + + In order to keep track of leases across system reboots and + server restarts, dhclient keeps a list of leases it has + been assigned in the dhclient.leases(5) file. On + startup, after reading the dhclient.conf file, dhclient + reads the dhclient.leases file to refresh its memory about + what leases it has been assigned. + + When a new lease is acquired, it is appended to the end of + the dhclient.leases file. In order to prevent the file + from becoming arbitrarily large, from time to time + dhclient creates a new dhclient.leases file from its in- + core lease database. The old version of the + dhclient.leases file is retained under the name + _d_h_c_p_d_._l_e_a_s_e_s_~ until the next time dhclient rewrites the + database. + + Old leases are kept around in case the DHCP server is + unavailable when dhclient is first invoked (generally dur- + ing the initial system boot process). In that event, old + leases from the dhclient.leases file which have not yet + expired are tested, and if they are determined to be + valid, they are used until either they expire or the DHCP + server becomes available. + + + + + 1 + + + + + +dhclient(8) dhclient(8) + + + A mobile host which may sometimes need to access a network + on which no DHCP server exists may be preloaded with a + lease for a fixed address on that network. When all + attempts to contact a DHCP server have failed, dhclient + will try to validate the static lease, and if it succeeds, + will use that lease until it is restarted. + + A mobile host may also travel to some networks on which + DHCP is not available but BOOTP is. In that case, it may + be advantageous to arrange with the network administrator + for an entry on the BOOTP database, so that the host can + boot quickly on that network rather than cycling through + the list of old leases. + +CCOOMMMMAANNDD LLIINNEE + The names of the network interfaces that dhclient should + attempt to configure may be specified on the command line. + If no interface names are specified on the command line + dhclient will identify all network interfaces, elimininat- + ing non-broadcast interfaces if possible, and attempt to + configure each interface. + + If dhclient should listen and transmit on a port other + than the standard (port 68), the --pp flag may used. It + should be followed by the udp port number that dhclient + should use. This is mostly useful for debugging purposes. + + Dhclient will normally run in the foreground until it has + configured an interface, and then will revert to running + in the background. To run force dhclient to always run as + a foreground process, the --dd flag should be specified. + This is useful when running dhclient under a debugger, or + when running it out of inittab on System V systems. + + +CCOONNFFIIGGUURRAATTIIOONN + The syntax of the dhclient.conf(8) file is discussed + seperately. + +FFIILLEESS + //eettcc//ddhhcclliieenntt..ccoonnff,, //vvaarr//ddbb//ddhhcclliieenntt..lleeaasseess,, + //vvaarr//rruunn//ddhhcclliieenntt..ppiidd,, //vvaarr//ddbb//ddhhcclliieenntt..lleeaasseess~~.. + +SSEEEE AALLSSOO + dhcpd(8), dhcrelay(8), dhclient.conf(5), + dhclient.leases(5) + +AAUUTTHHOORR + ddhhcclliieenntt((88)) has been written for the Internet Software + Consortium by Ted Lemon in cooperation + with Vixie Enterprises. To learn more about the Internet + Software Consortium, see hhttttpp::////wwwwww..vviixx..ccoomm//iisscc.. To learn + more about Vixie Enterprises, see hhttttpp::////wwwwww..vviixx..ccoomm.. + + + + + 2 + + + + + +dhclient(8) dhclient(8) + + + This client was substantially modified and enhanced by + Elliot Poger for use on Linux while he was working on the + MosquitoNet project at Stanford. + + The current version owes much to Elliot's Linux enhance- + ments, but was substantially reorganized and partially + rewritten by Ted Lemon so as to use the same networking + framework that the Internet Software Consortium DHCP + server uses. Much system-specific configuration code was + moved into a shell script so that as support for more + operating systems is added, it will not be necessary to + port and maintain system-specific configuration code to + these operating systems - instead, the shell script can + invoke the native tools to accomplish the same purpose. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 3 + + diff --git a/dhclient.conf.5 b/dhclient.conf.5 new file mode 100644 index 000000000..25d5d8f22 --- /dev/null +++ b/dhclient.conf.5 @@ -0,0 +1,63 @@ +.\" dhclient.conf.5 +.\" +.\" Copyright (c) 1997 The Internet Software Consortium. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of The Internet Software Consortium nor the names +.\" of its contributors may be used to endorse or promote products derived +.\" from this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE INTERNET SOFTWARE CONSORTIUM AND +.\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, +.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +.\" DISCLAIMED. IN NO EVENT SHALL THE INTERNET SOFTWARE CONSORTIUM OR +.\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF +.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +.\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" This software has been written for the Internet Software Consortium +.\" by Ted Lemon in cooperation with Vixie +.\" Enterprises. To learn more about the Internet Software Consortium, +.\" see ``http://www.isc.org/isc''. To learn more about Vixie +.\" Enterprises, see ``http://www.vix.com''. +.TH dhcpd.conf 5 +.SH NAME +dhclient.conf - DHCP client configuration file +.SH DESCRIPTION +The dhclient.conf file contains configuration information for +.IR dhclient, +the Internet Software Consortium DHCP Client. +.PP +The dhclient.conf file is a free-form ASCII text file. It is parsed by +the recursive-descent parser built into dhclient. The file may contain +extra tabs and newlines for formatting purposes. Keywords in the file +are case-insensitive. Comments may be placed anywhere within the +file (except within quotes). Comments begin with the # character and +end at the end of the line. +.PP + \fBTHIS DOCUMENTATION IS NOT YET COMPLETE - SORRY\fR +.SH SEE ALSO +dhcpd.conf(5), dhclient.leases(5), +draft-ietf-dhc-options-1533update-04.txt, draft-ietf-dhc-dhcp-07.txt. +.SH AUTHOR +.B dhclient(8) +was written by Ted Lemon +under a contract with Vixie Labs. Funding +for this project was provided by the Internet Software Corporation. +Information about the Internet Software Consortium can be found at +.B http://www.isc.org/isc. diff --git a/dhcrelay.8 b/dhcrelay.8 new file mode 100644 index 000000000..97e2634de --- /dev/null +++ b/dhcrelay.8 @@ -0,0 +1,123 @@ +.\" dhcrelay.8 +.\" +.\" Copyright (c) 1997 The Internet Software Consortium. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of The Internet Software Consortium nor the names +.\" of its contributors may be used to endorse or promote products derived +.\" from this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE INTERNET SOFTWARE CONSORTIUM AND +.\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, +.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +.\" DISCLAIMED. IN NO EVENT SHALL THE INTERNET SOFTWARE CONSORTIUM OR +.\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF +.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +.\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" This software has been written for the Internet Software Consortium +.\" by Ted Lemon in cooperation with Vixie +.\" Enterprises. To learn more about the Internet Software Consortium, +.\" see ``http://www.isc.org/isc''. To learn more about Vixie +.\" Enterprises, see ``http://www.vix.com''. +.TH dhcrelay 8 +.SH NAME +dhcpd - Dynamic Host Configuration Protocol Relay Agent +.SH SYNOPSIS +.B dhcrelay +[ +.B -p +.I port +] +[ +.B -d +] +[ +.B -i +.I if0 +[ +.B ... +.B -i +.I ifN +] +] +.I server0 +[ +.I ...serverN +] +.SH DESCRIPTION +The Internet Software Consortium DHCP Relay Agent, dhcrelay, provides a +means for relaying DHCP and BOOTP requests from a subnet to which +no DHCP server is directly to one or more DHCP servers on other +subnets. +.SH OPERATION +.PP +The DHCP Relay Agent listens for DHCP requests on all interfaces +attached to a host, or only on those interfaces specified on the +command line with the +.I -i +flag. When a query is received, it forwards it to the list of DHCP +servers specified on the command line. When a reply is received, it +is broadcast or unicast on the network from whence the original +request came. +.PP +It is possible to specify a set of interfaces on which dhcrelay will +listen, so that if dhcrelay is connected through one interface to a +network on which there is no DHCP server, but is connected on another +interface to a network on which there is a DHCP server, it will not +relay DHCP and BOOTP requests from the network on which the server +exists to that server. This is an imperfect solution. +.SH COMMAND LINE +.PP +The names of the network interfaces that dhcrelay should attempt to +configure may be specified on the command line using the +.I -i +option. If no interface names +are specified on the command line dhcrelay will identify all network +interfaces, elimininating non-broadcast interfaces if possible, and +attempt to configure each interface. +.PP +If dhcrelay should listen and transmit on a port other than the +standard (port 67), the +.B -p +flag may used. It should be followed by the udp port number that +dhcrelay should use. This is mostly useful for debugging purposes. +.PP +Dhclient will normally run in the foreground until it has configured +an interface, and then will revert to running in the background. +To run force dhcrelay to always run as a foreground process, the +.B -d +flag should be specified. This is useful when running dhcrelay under +a debugger, or when running it out of inittab on System V systems. +.PP +The name of at least one DHCP server to which DHCP and BOOTP requests +should be relayed must be specified on the command line. +.PP +.SH SEE ALSO +dhclient(8), dhcpd(8), dhcrelay.conf(5), dhcrelay.leases(5) +.SH AUTHOR +.B dhcrelay(8) +has been written for the Internet Software Consortium +by Ted Lemon in cooperation with Vixie +Enterprises. To learn more about the Internet Software Consortium, +see +.B http://www.vix.com/isc. +To learn more about Vixie +Enterprises, see +.B http://www.vix.com. +.PP diff --git a/dhcrelay.cat8 b/dhcrelay.cat8 new file mode 100644 index 000000000..6c60d6c77 --- /dev/null +++ b/dhcrelay.cat8 @@ -0,0 +1,132 @@ + + + +dhcrelay(8) dhcrelay(8) + + +NNAAMMEE + dhcpd - Dynamic Host Configuration Protocol Relay Agent + +SSYYNNOOPPSSIISS + ddhhccrreellaayy [ --pp _p_o_r_t ] [ --dd ] [ --ii _i_f_0 [ ...... --ii _i_f_N ] ] + _s_e_r_v_e_r_0 [ _._._._s_e_r_v_e_r_N ] + +DDEESSCCRRIIPPTTIIOONN + The Internet Software Consortium DHCP Relay Agent, dhcre- + lay, provides a means for relaying DHCP and BOOTP requests + from a subnet to which no DHCP server is directly to one + or more DHCP servers on other subnets. + +OOPPEERRAATTIIOONN + The DHCP Relay Agent listens for DHCP requests on all + interfaces attached to a host, or only on those interfaces + specified on the command line with the _-_i flag. When a + query is received, it forwards it to the list of DHCP + servers specified on the command line. When a reply is + received, it is broadcast or unicast on the network from + whence the original request came. + + It is possible to specify a set of interfaces on which + dhcrelay will listen, so that if dhcrelay is connected + through one interface to a network on which there is no + DHCP server, but is connected on another interface to a + network on which there is a DHCP server, it will not relay + DHCP and BOOTP requests from the network on which the + server exists to that server. This is an imperfect solu- + tion. + +CCOOMMMMAANNDD LLIINNEE + The names of the network interfaces that dhcrelay should + attempt to configure may be specified on the command line + using the _-_i option. If no interface names are specified + on the command line dhcrelay will identify all network + interfaces, elimininating non-broadcast interfaces if pos- + sible, and attempt to configure each interface. + + If dhcrelay should listen and transmit on a port other + than the standard (port 67), the --pp flag may used. It + should be followed by the udp port number that dhcrelay + should use. This is mostly useful for debugging purposes. + + Dhclient will normally run in the foreground until it has + configured an interface, and then will revert to running + in the background. To run force dhcrelay to always run as + a foreground process, the --dd flag should be specified. + This is useful when running dhcrelay under a debugger, or + when running it out of inittab on System V systems. + + The name of at least one DHCP server to which DHCP and + BOOTP requests should be relayed must be specified on the + command line. + + + + 1 + + + + + +dhcrelay(8) dhcrelay(8) + + +SSEEEE AALLSSOO + dhclient(8), dhcpd(8), dhcrelay.conf(5), dhcre- + lay.leases(5) + +AAUUTTHHOORR + ddhhccrreellaayy((88)) has been written for the Internet Software + Consortium by Ted Lemon in cooperation + with Vixie Enterprises. To learn more about the Internet + Software Consortium, see hhttttpp::////wwwwww..vviixx..ccoomm//iisscc.. To learn + more about Vixie Enterprises, see hhttttpp::////wwwwww..vviixx..ccoomm.. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 2 + + diff --git a/relay/dhcrelay.8 b/relay/dhcrelay.8 new file mode 100644 index 000000000..97e2634de --- /dev/null +++ b/relay/dhcrelay.8 @@ -0,0 +1,123 @@ +.\" dhcrelay.8 +.\" +.\" Copyright (c) 1997 The Internet Software Consortium. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of The Internet Software Consortium nor the names +.\" of its contributors may be used to endorse or promote products derived +.\" from this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE INTERNET SOFTWARE CONSORTIUM AND +.\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, +.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +.\" DISCLAIMED. IN NO EVENT SHALL THE INTERNET SOFTWARE CONSORTIUM OR +.\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF +.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +.\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" This software has been written for the Internet Software Consortium +.\" by Ted Lemon in cooperation with Vixie +.\" Enterprises. To learn more about the Internet Software Consortium, +.\" see ``http://www.isc.org/isc''. To learn more about Vixie +.\" Enterprises, see ``http://www.vix.com''. +.TH dhcrelay 8 +.SH NAME +dhcpd - Dynamic Host Configuration Protocol Relay Agent +.SH SYNOPSIS +.B dhcrelay +[ +.B -p +.I port +] +[ +.B -d +] +[ +.B -i +.I if0 +[ +.B ... +.B -i +.I ifN +] +] +.I server0 +[ +.I ...serverN +] +.SH DESCRIPTION +The Internet Software Consortium DHCP Relay Agent, dhcrelay, provides a +means for relaying DHCP and BOOTP requests from a subnet to which +no DHCP server is directly to one or more DHCP servers on other +subnets. +.SH OPERATION +.PP +The DHCP Relay Agent listens for DHCP requests on all interfaces +attached to a host, or only on those interfaces specified on the +command line with the +.I -i +flag. When a query is received, it forwards it to the list of DHCP +servers specified on the command line. When a reply is received, it +is broadcast or unicast on the network from whence the original +request came. +.PP +It is possible to specify a set of interfaces on which dhcrelay will +listen, so that if dhcrelay is connected through one interface to a +network on which there is no DHCP server, but is connected on another +interface to a network on which there is a DHCP server, it will not +relay DHCP and BOOTP requests from the network on which the server +exists to that server. This is an imperfect solution. +.SH COMMAND LINE +.PP +The names of the network interfaces that dhcrelay should attempt to +configure may be specified on the command line using the +.I -i +option. If no interface names +are specified on the command line dhcrelay will identify all network +interfaces, elimininating non-broadcast interfaces if possible, and +attempt to configure each interface. +.PP +If dhcrelay should listen and transmit on a port other than the +standard (port 67), the +.B -p +flag may used. It should be followed by the udp port number that +dhcrelay should use. This is mostly useful for debugging purposes. +.PP +Dhclient will normally run in the foreground until it has configured +an interface, and then will revert to running in the background. +To run force dhcrelay to always run as a foreground process, the +.B -d +flag should be specified. This is useful when running dhcrelay under +a debugger, or when running it out of inittab on System V systems. +.PP +The name of at least one DHCP server to which DHCP and BOOTP requests +should be relayed must be specified on the command line. +.PP +.SH SEE ALSO +dhclient(8), dhcpd(8), dhcrelay.conf(5), dhcrelay.leases(5) +.SH AUTHOR +.B dhcrelay(8) +has been written for the Internet Software Consortium +by Ted Lemon in cooperation with Vixie +Enterprises. To learn more about the Internet Software Consortium, +see +.B http://www.vix.com/isc. +To learn more about Vixie +Enterprises, see +.B http://www.vix.com. +.PP diff --git a/relay/dhcrelay.cat8 b/relay/dhcrelay.cat8 new file mode 100644 index 000000000..6c60d6c77 --- /dev/null +++ b/relay/dhcrelay.cat8 @@ -0,0 +1,132 @@ + + + +dhcrelay(8) dhcrelay(8) + + +NNAAMMEE + dhcpd - Dynamic Host Configuration Protocol Relay Agent + +SSYYNNOOPPSSIISS + ddhhccrreellaayy [ --pp _p_o_r_t ] [ --dd ] [ --ii _i_f_0 [ ...... --ii _i_f_N ] ] + _s_e_r_v_e_r_0 [ _._._._s_e_r_v_e_r_N ] + +DDEESSCCRRIIPPTTIIOONN + The Internet Software Consortium DHCP Relay Agent, dhcre- + lay, provides a means for relaying DHCP and BOOTP requests + from a subnet to which no DHCP server is directly to one + or more DHCP servers on other subnets. + +OOPPEERRAATTIIOONN + The DHCP Relay Agent listens for DHCP requests on all + interfaces attached to a host, or only on those interfaces + specified on the command line with the _-_i flag. When a + query is received, it forwards it to the list of DHCP + servers specified on the command line. When a reply is + received, it is broadcast or unicast on the network from + whence the original request came. + + It is possible to specify a set of interfaces on which + dhcrelay will listen, so that if dhcrelay is connected + through one interface to a network on which there is no + DHCP server, but is connected on another interface to a + network on which there is a DHCP server, it will not relay + DHCP and BOOTP requests from the network on which the + server exists to that server. This is an imperfect solu- + tion. + +CCOOMMMMAANNDD LLIINNEE + The names of the network interfaces that dhcrelay should + attempt to configure may be specified on the command line + using the _-_i option. If no interface names are specified + on the command line dhcrelay will identify all network + interfaces, elimininating non-broadcast interfaces if pos- + sible, and attempt to configure each interface. + + If dhcrelay should listen and transmit on a port other + than the standard (port 67), the --pp flag may used. It + should be followed by the udp port number that dhcrelay + should use. This is mostly useful for debugging purposes. + + Dhclient will normally run in the foreground until it has + configured an interface, and then will revert to running + in the background. To run force dhcrelay to always run as + a foreground process, the --dd flag should be specified. + This is useful when running dhcrelay under a debugger, or + when running it out of inittab on System V systems. + + The name of at least one DHCP server to which DHCP and + BOOTP requests should be relayed must be specified on the + command line. + + + + 1 + + + + + +dhcrelay(8) dhcrelay(8) + + +SSEEEE AALLSSOO + dhclient(8), dhcpd(8), dhcrelay.conf(5), dhcre- + lay.leases(5) + +AAUUTTHHOORR + ddhhccrreellaayy((88)) has been written for the Internet Software + Consortium by Ted Lemon in cooperation + with Vixie Enterprises. To learn more about the Internet + Software Consortium, see hhttttpp::////wwwwww..vviixx..ccoomm//iisscc.. To learn + more about Vixie Enterprises, see hhttttpp::////wwwwww..vviixx..ccoomm.. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 2 + +