Reformat option descriptions.

diff --git a/common/dhcp-options.5 b/common/dhcp-options.5
index 95d9571478366e7576d499f5f4137ac25658fe37..65b5b330ffb9385891176926f1e6a198bbf21d66 100644 (file)
--- a/common/dhcp-options.5
+++ b/common/dhcp-options.5
@@ -1,7 +1,7 @@
 .\"    dhcp-options.5
 .\"
-.\" Copyright (c) 1995, 1996, 1997 The Internet Software Consortium.
-.\" All rights reserved.
+.\" Copyright (c) 1995, 1996, 1997, 1998, 1999
+.\" 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
@@ -126,7 +126,8 @@ no checking is done to ensure the correctness of the entered data.
 .PP
 The standard options are:
 .PP
- \fBoption subnet-mask\fR \fIip-address\fR\fB;\fR
+.B option subnet-mask \fIip-address\fR\fB;\fR
+.RS 0.25i
 .PP
 The subnet mask option specifies the client's subnet mask as per RFC
 950.  If no subnet mask option is provided anywhere in scope, as a
@@ -136,114 +137,162 @@ for the network on which an address is being assigned.  However,
 subnet-mask option declaration that is in scope for the address being
 assigned will override the subnet mask specified in the subnet
 declaration.
+.RE
 .PP
- \fBoption time-offset\fR \fIint32\fR\fB;\fR
+.B option time-offset \fIint32\fR\fB;\fR
+.RS 0.25i
 .PP
 The time-offset option specifies the offset of the client's subnet in
 seconds from Coordinated Universal Time (UTC).
+.RE
 .PP
- \fBoption routers\fR \fIip-address\fR [\fB,\fR \fIip-address\fR ... ]\fB;\fR
+.B option routers \fIip-address\fR [\fB,\fR \fIip-address\fR...
+]\fB;\fR
+.RS 0.25i
 .PP
 The routers option specifies a list of IP addresses for routers on the
 client's subnet.  Routers should be listed in order of preference.
+.RE
 .PP
- \fBoption time-servers\fR \fIip-address [, \fIip-address\fR ... ]\fB;\fR
+.B option time-servers \fIip-address\fR [, \fIip-address\fR...
+]\fB;\fR
+.RS 0.25i
 .PP
 The time-server option specifies a list of RFC 868 time servers
 available to the client.  Servers should be listed in order of
 preference.
+.RE
 .PP
- \fBoption\fR \fBien116-name-servers\fR \fIip-address\fR [\fB,\fR \fIip-address\fR ... ];
+.B option \fBien116-name-servers\fR \fIip-address\fR [\fB,\fR \fIip-address\fR...
+];
+.RS 0.25i
 .PP
 The ien116-name-servers option specifies a list of IEN 116 name servers
 available to the client.  Servers should be listed in order of
 preference.
+.RE
 .PP
- \fBoption\fR \fBdomain-name-servers\fR \fIip-address\fR [\fB,\fR \fIip-address\fR ... ]\fB;\fR
+.B option \fBdomain-name-servers\fR \fIip-address\fR [\fB,\fR \fIip-address\fR...
+]\fB;\fR
+.RS 0.25i
 .PP
 The domain-name-servers option specifies a list of Domain Name System
 (STD 13, RFC 1035) name servers available to the client.  Servers
 should be listed in order of preference.
+.RE
 .PP
- \fBoption\fR \fBlog-servers\fR \fIip-address\fR [\fB,\fR \fIip-address\fR ... ]\fB;\fR
+.B option \fBlog-servers\fR \fIip-address\fR [\fB,\fR \fIip-address\fR...
+]\fB;\fR
+.RS 0.25i
 .PP
 The log-server option specifies a list of MIT-LCS UDP log servers
 available to the client.  Servers should be listed in order of
 preference.
+.RE
 .PP
- \fBoption\fR \fBcookie-servers\fR \fIip-address\fR [\fB,\fR \fIip-address\fR ... ]\fB;\fR
+.B option \fBcookie-servers\fR \fIip-address\fR [\fB,\fR \fIip-address\fR...
+]\fB;\fR
+.RS 0.25i
 .PP
 The cookie server option specifies a list of RFC 865 cookie
 servers available to the client.  Servers should be listed in order
 of preference.
+.RE
 .PP
- \fBoption\fR \fBlpr-servers\fR \fIip-address \fR [\fB,\fR \fIip-address\fR ... ]\fB;\fR
+.B option \fBlpr-servers\fR \fIip-address \fR [\fB,\fR \fIip-address\fR...
+]\fB;\fR
+.RS 0.25i
 .PP
 The LPR server option specifies a list of RFC 1179 line printer
 servers available to the client.  Servers should be listed in order
 of preference.
+.RE
 .PP
- \fBoption\fR \fBimpress-servers\fR \fIip-address\fR [\fB,\fR \fIip-address\fR ... ]\fB;\fR
+.B option \fBimpress-servers\fR \fIip-address\fR [\fB,\fR \fIip-address\fR...
+]\fB;\fR
+.RS 0.25i
 .PP
 The impress-server option specifies a list of Imagen Impress servers
 available to the client.  Servers should be listed in order of
 preference.
+.RE
 .PP
- \fBoption\fR \fBresource-location-servers\fR \fIip-address\fR [\fB,\fR \fIip-address\fR ... ]\fB;\fR
+.B option \fBresource-location-servers\fR \fIip-address\fR [\fB,\fR \fIip-address\fR...
+]\fB;\fR
+.RS 0.25i
 .PP
 This option specifies a list of RFC 887 Resource Location
 servers available to the client.  Servers should be listed in order
 of preference.
+.RE
 .PP
- \fBoption\fR \fBhost-name\fR \fIstring\fR\fB;\fR
+.B option \fBhost-name\fR \fIstring\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies the name of the client.  The name may or may
 not be qualified with the local domain name (it is preferable to use
 the domain-name option to specify the domain name).  See RFC 1035 for
 character set restrictions.
+.RE
 .PP
- \fBoption\fR \fBboot-size\fR \fIuint16\fR\fB;\fR
+.B option \fBboot-size\fR \fIuint16\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies the length in 512-octet blocks of the default
 boot image for the client.
+.RE
 .PP
- \fBoption\fR \fBmerit-dump\fR \fIstring\fR\fB;\fR
+.B option \fBmerit-dump\fR \fIstring\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies the path-name of a file to which the client's
 core image should be dumped in the event the client crashes.  The
 path is formatted as a character string consisting of characters from
 the NVT ASCII character set.
+.RE
 .PP
- \fBoption\fR \fBdomain-name\fR \fIstring\fR\fB;\fR
+.B option \fBdomain-name\fR \fIstring\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies the domain name that client should use when
 resolving hostnames via the Domain Name System.
+.RE
 .PP
- \fBoption\fR \fBswap-server\fR \fIip-address\fR\fB;\fR
+.B option \fBswap-server\fR \fIip-address\fR\fB;\fR
+.RS 0.25i
 .PP
 This specifies the IP address of the client's swap server.
+.RE
 .PP
- \fBoption\fR \fBroot-path\fR \fIstring\fB;\fR\fR
+.B option \fBroot-path\fR \fIstring\fB;\fR\fR
+.RS 0.25i
 .PP
 This option specifies the path-name that contains the client's root
 disk.  The path is formatted as a character string consisting of
 characters from the NVT ASCII character set.
+.RE
 .PP
- \fBoption\fR \fBip-forwarding\fR \fIflag\fR\fB;\fR
+.B option \fBip-forwarding\fR \fIflag\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies whether the client should configure its IP
 layer for packet forwarding.  A value of 0 means disable IP
 forwarding, and a value of 1 means enable IP forwarding.
+.RE
 .PP
- \fBoption\fR \fBnon-local-source-routing\fR \fIflag\fR\fB;\fR
+.B option \fBnon-local-source-routing\fR \fIflag\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies whether the client should configure its IP
 layer to allow forwarding of datagrams with non-local source routes
 (see Section 3.3.5 of [4] for a discussion of this topic).  A value
 of 0 means disallow forwarding of such datagrams, and a value of 1
 means allow forwarding.
+.RE
 .PP
- \fBoption\fR \fBpolicy-filter\fR \fIip-address ip-address\fR [\fB,\fR \fIip-address ip-address\fR ... ]\fB;\fR
+.B option \fBpolicy-filter\fR \fIip-address ip-address\fR [\fB,\fR \fIip-address ip-address\fR...
+]\fB;\fR
+.RS 0.25i
 .PP
 This option specifies policy filters for non-local source routing.
 The filters consist of a list of IP addresses and masks which specify
@@ -253,36 +302,49 @@ Any source routed datagram whose next-hop address does not match one
 of the filters should be discarded by the client.
 .PP
 See STD 3 (RFC1122) for further information.
+.RE
 .PP
- \fBoption\fR \fBmax-dgram-reassembly\fR \fIuint16\fR\fB;\fR
+.B option \fBmax-dgram-reassembly\fR \fIuint16\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies the maximum size datagram that the client
 should be prepared to reassemble.  The minimum value legal value is
 576.
+.RE
 .PP
- \fBoption\fR \fBdefault-ip-ttl\fR \fIuint8;\fR
+.B option \fBdefault-ip-ttl\fR \fIuint8;\fR
+.RS 0.25i
 .PP
 This option specifies the default time-to-live that the client should
 use on outgoing datagrams.
+.RE
 .PP
- \fBoption\fR \fBpath-mtu-aging-timeout\fR \fIuint32\fR\fB;\fR
+.B option \fBpath-mtu-aging-timeout\fR \fIuint32\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies the timeout (in seconds) to use when aging Path
 MTU values discovered by the mechanism defined in RFC 1191.
+.RE
 .PP
- \fBoption\fR \fBpath-mtu-plateau-table\fR \fIuint16\fR [\fB,\fR \fIuint16\fR ... ]\fB;\fR
+.B option \fBpath-mtu-plateau-table\fR \fIuint16\fR [\fB,\fR \fIuint16\fR...
+]\fB;\fR
+.RS 0.25i
 .PP
 This option specifies a table of MTU sizes to use when performing
 Path MTU Discovery as defined in RFC 1191.  The table is formatted as
 a list of 16-bit unsigned integers, ordered from smallest to largest.
 The minimum MTU value cannot be smaller than 68.
+.RE
 .PP
- \fBoption\fR \fBinterface-mtu\fR \fIuint16\fR\fB;\fR
+.B option \fBinterface-mtu\fR \fIuint16\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies the MTU to use on this interface.   The minimum
 legal value for the MTU is 68.
+.RE
 .PP
- \fBoption\fR \fBall-subnets-local\fR \fIflag\fR\fB;\fR
+.B option \fBall-subnets-local\fR \fIflag\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies whether or not the client may assume that all
 subnets of the IP network to which the client is connected use the
@@ -290,41 +352,54 @@ same MTU as the subnet of that network to which the client is
 directly connected.  A value of 1 indicates that all subnets share
 the same MTU.  A value of 0 means that the client should assume that
 some subnets of the directly connected network may have smaller MTUs.
+.RE
 .PP
- \fBoption\fR \fBbroadcast-address\fR \fIip-address\fR\fB;\fR
+.B option \fBbroadcast-address\fR \fIip-address\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies the broadcast address in use on the client's
 subnet.  Legal values for broadcast addresses are specified in
 section 3.2.1.3 of STD 3 (RFC1122).
+.RE
 .PP
- \fBoption\fR \fBperform-mask-discovery\fR \fIflag\fR\fB;\fR
+.B option \fBperform-mask-discovery\fR \fIflag\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies whether or not the client should perform subnet
 mask discovery using ICMP.  A value of 0 indicates that the client
 should not perform mask discovery.  A value of 1 means that the
 client should perform mask discovery.
+.RE
 .PP
- \fBoption\fR \fBmask-supplier\fR \fIflag\fR\fB;\fR
+.B option \fBmask-supplier\fR \fIflag\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies whether or not the client should respond to
 subnet mask requests using ICMP.  A value of 0 indicates that the
 client should not respond.  A value of 1 means that the client should
 respond.
+.RE
 .PP
- \fBoption\fR \fBrouter-discovery\fR \fIflag\fR\fB;\fR
+.B option \fBrouter-discovery\fR \fIflag\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies whether or not the client should solicit
 routers using the Router Discovery mechanism defined in RFC 1256.
 A value of 0 indicates that the client should not perform
 router discovery.  A value of 1 means that the client should perform
 router discovery.
+.RE
 .PP
- \fBoption\fR \fBrouter-solicitation-address\fR \fIip-address\fR\fB;\fR
+.B option \fBrouter-solicitation-address\fR \fIip-address\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies the address to which the client should transmit
 router solicitation requests.
+.RE
 .PP
- \fBoption\fR \fBstatic-routes\fR \fIip-address ip-address\fR [\fB,\fR \fIip-address ip-address\fR ... ]\fB;\fR
+.B option \fBstatic-routes\fR \fIip-address ip-address\fR [\fB,\fR \fIip-address ip-address\fR...
+]\fB;\fR
+.RS 0.25i
 .PP
 This option specifies a list of static routes that the client should
 install in its routing cache.  If multiple routes to the same
@@ -339,108 +414,159 @@ The default route (0.0.0.0) is an illegal destination for a static
 route.  To specify the default route, use the
 .B routers
 option.
+.RE
 .PP
- \fBoption\fR \fBtrailer-encapsulation\fR \fIflag\fR\fB;\fR
+.B option \fBtrailer-encapsulation\fR \fIflag\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies whether or not the client should negotiate the
 use of trailers (RFC 893 [14]) when using the ARP protocol.  A value
 of 0 indicates that the client should not attempt to use trailers.  A
 value of 1 means that the client should attempt to use trailers.
+.RE
 .PP
- \fBoption\fR \fBarp-cache-timeout\fR \fIuint32\fR\fB;\fR
+.B option \fBarp-cache-timeout\fR \fIuint32\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies the timeout in seconds for ARP cache entries.
+.RE
 .PP
- \fBoption\fR \fBieee802-3-encapsulation\fR \fIflag\fR\fB;\fR
+.B option \fBieee802-3-encapsulation\fR \fIflag\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies whether or not the client should use Ethernet
 Version 2 (RFC 894) or IEEE 802.3 (RFC 1042) encapsulation if the
 interface is an Ethernet.  A value of 0 indicates that the client
 should use RFC 894 encapsulation.  A value of 1 means that the client
 should use RFC 1042 encapsulation.
+.RE
 .PP
- \fBoption\fR \fBdefault-tcp-ttl\fR \fIuint8\fR\fB;\fR
+.B option \fBdefault-tcp-ttl\fR \fIuint8\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies the default TTL that the client should use when
 sending TCP segments.  The minimum value is 1.
+.RE
 .PP
- \fBoption\fR \fBtcp-keepalive-interval\fR \fIuint32\fR\fB;\fR
+.B option \fBtcp-keepalive-interval\fR \fIuint32\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies the interval (in seconds) that the client TCP
 should wait before sending a keepalive message on a TCP connection.
 The time is specified as a 32-bit unsigned integer.  A value of zero
 indicates that the client should not generate keepalive messages on
 connections unless specifically requested by an application.
+.RE
 .PP
- \fBoption\fR \fBtcp-keepalive-garbage\fR \fIflag\fR\fB;\fR
+.B option \fBtcp-keepalive-garbage\fR \fIflag\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies the whether or not the client should send TCP
 keepalive messages with a octet of garbage for compatibility with
 older implementations.  A value of 0 indicates that a garbage octet
 should not be sent. A value of 1 indicates that a garbage octet
 should be sent.
+.RE
 .PP
- \fBoption\fR \fBnis-domain\fR \fIstring\fR\fB;\fR
+.B option \fBnis-domain\fR \fIstring\fR\fB;\fR
+.RS 0.25i
 .PP
 This option specifies the name of the client's NIS (Sun Network
 Information Services) domain.  The domain is formatted as a character
 string consisting of characters from the NVT ASCII character set.
+.RE
 .PP
- \fBoption\fR \fBnis-servers\fR \fIip-address\fR [\fB,\fR \fIip-address\fR ... ]\fB;\fR
+.B option \fBnis-servers\fR \fIip-address\fR [\fB,\fR \fIip-address\fR...
+]\fB;\fR
+.RS 0.25i
 .PP
 This option specifies a list of IP addresses indicating NIS servers
 available to the client.  Servers should be listed in order of
 preference.
+.RE
 .PP
- \fBoption\fR \fBntp-servers\fR \fIip-address\fR [\fB,\fR \fIip-address\fR ... ]\fB;\fR
+.B option \fBntp-servers\fR \fIip-address\fR [\fB,\fR \fIip-address\fR...
+]\fB;\fR
+.RS 0.25i
 .PP
 This option specifies a list of IP addresses indicating NTP (RFC 1035)
 servers available to the client.  Servers should be listed in order
 of preference.
+.RE
 .PP
- \fBoption\fR \fBnetbios-name-servers\fR \fIip-address\fR [\fB,\fR \fIip-address\fR ... ]\fB;\fR
+.B option \fBnetbios-name-servers\fR \fIip-address\fR [\fB,\fR \fIip-address\fR...
+]\fB;\fR
+.RS 0.25i
 .PP
 The NetBIOS name server (NBNS) option specifies a list of RFC
 1001/1002 NBNS name servers listed in order of preference.   NetBIOS
-Name Service is more commonly referred to nowadays as WINS.   WINS
+Name Service is currently more commonly referred to as WINS.   WINS
 servers can be specified using the netbios-name-servers option.
+.RE
 .PP
- \fBoption\fR \fBnetbios-dd-server\fR \fIip-address\fR [\fB,\fR \fIip-address\fR ... ]\fB;\fR
+.B option \fBnetbios-dd-server\fR \fIip-address\fR [\fB,\fR \fIip-address\fR...
+]\fB;\fR
+.RS 0.25i
 .PP
 The NetBIOS datagram distribution server (NBDD) option specifies a
 list of RFC 1001/1002 NBDD servers listed in order of preference.
+.RE
 .PP
- \fBoption\fR \fBnetbios-node-type\fR \fIuint8\fR\fB;\fR
+.B option \fBnetbios-node-type\fR \fIuint8\fR\fB;\fR
+.RS 0.25i
 .PP
 The NetBIOS node type option allows NetBIOS over TCP/IP clients which
 are configurable to be configured as described in RFC 1001/1002.  The
 value is specified as a single octet which identifies the client type.
-A value of 1 corresponds to a NetBIOS B-node; a value of 2 corresponds
-to a P-node; a value of 4 corresponds to an M-node; a value of 8
-corresponds to an H-node.
 .PP
- \fBoption\fR \fBnetbios-scope\fR \fIstring\fR\fB;\fR
+Possible node types are:
+.PP
+.TP 5
+.I 1
+B-node: Broadcast - no WINS
+.TP
+.I 2
+P-node: Peer - WINS only.
+.TP
+.I 4
+M-node: Mixed - broadcast, then WINS
+.TP
+.I 8
+H-node: Hybrid - WINS, then broadcast
+.RE
+.PP
+.B option \fBnetbios-scope\fR \fIstring\fR\fB;\fR
+.RS 0.25i
 .PP
 The NetBIOS scope option specifies the NetBIOS over TCP/IP scope
 parameter for the client as specified in RFC 1001/1002. See RFC1001,
 RFC1002, and RFC1035 for character-set restrictions.
+.RE
 .PP
- \fBoption\fR \fBfont-servers\fR \fIip-address\fR [\fB,\fR \fIip-address\fR ... ]\fB;\fR
+.B option \fBfont-servers\fR \fIip-address\fR [\fB,\fR \fIip-address\fR...
+]\fB;\fR
+.RS 0.25i
 .PP
 This option specifies a list of X Window System Font servers available
 to the client. Servers should be listed in order of preference.
+.RE
 .PP
- \fBoption\fR \fBx-display-manager\fR \fIip-address\fR [\fB,\fR \fIip-address\fR ... ]\fB;\fR
+.B option \fBx-display-manager\fR \fIip-address\fR [\fB,\fR \fIip-address\fR...
+]\fB;\fR
+.RS 0.25i
 .PP
 This option specifies a list of systems that are running the X Window
 System Display Manager and are available to the client.  Addresses
 should be listed in order of preference.
+.RE
 .PP
- \fBoption\fR \fBdhcp-client-identifier\fR \fIdata-string\fR\fB;\fR
+.B option \fBdhcp-client-identifier\fR \fIdata-string\fR\fB;\fR
+.RS 0.25i
 .PP
 This option can be used to specify the a DHCP client identifier in a
 host declaration, so that dhcpd can find the host record by matching
 against the client identifier.
+.RE
 .SH SEE ALSO
 dhcpd.conf(5), dhcpd.leases(5), dhclient.conf(5), dhcpd(8),
 dhclient(8), RFC2132, RFC2131.