mirror of
https://gitlab.isc.org/isc-projects/dhcp
synced 2025-08-29 05:17:57 +00:00
Various minor documentation improvements:
remove repeated words fix: it's to its some minor formatting added (this needs to be improved still, there is a mix of \fB Bold and \fI underline for same things) spelling fixes minor punctuation fixes (remove ...) uppercase an acronym that is not a config item (I didn't get this reviewed, these all are very minor or obvious.)
This commit is contained in:
parent
a2bb892f71
commit
8e112e2bc6
@ -245,7 +245,7 @@ inittab on System V systems. This implies \fB-v\fR.
|
|||||||
.TP
|
.TP
|
||||||
.BI \-nw
|
.BI \-nw
|
||||||
Become a daemon immediately (nowait) rather than waiting until an
|
Become a daemon immediately (nowait) rather than waiting until an
|
||||||
an IP address has been acquired.
|
IP address has been acquired.
|
||||||
.TP
|
.TP
|
||||||
.BI \-q
|
.BI \-q
|
||||||
Be quiet at startup, this is the default.
|
Be quiet at startup, this is the default.
|
||||||
@ -361,7 +361,7 @@ It is used to restore normal operation after using \fB-T\fR or \fB-P\fR.
|
|||||||
.PP
|
.PP
|
||||||
.I Modifying default file locations:
|
.I Modifying default file locations:
|
||||||
The following options can be used to modify the locations a client uses
|
The following options can be used to modify the locations a client uses
|
||||||
for it's files. They can be particularly useful if, for example,
|
for its files. They can be particularly useful if, for example,
|
||||||
.B DBDIR
|
.B DBDIR
|
||||||
or
|
or
|
||||||
.B RUNDIR
|
.B RUNDIR
|
||||||
|
@ -267,7 +267,7 @@ or DHCPv6. The exact same syntax is used for both.
|
|||||||
.PP
|
.PP
|
||||||
To make it work, you have to declare a key and zone as in the DHCP
|
To make it work, you have to declare a key and zone as in the DHCP
|
||||||
server (see \fBdhcpd.conf\fR(5) for details). You also need to
|
server (see \fBdhcpd.conf\fR(5) for details). You also need to
|
||||||
configure the fqdn option on the client, as follows:
|
configure the \fIfqdn\fR option on the client, as follows:
|
||||||
.PP
|
.PP
|
||||||
.nf
|
.nf
|
||||||
send fqdn.fqdn "grosse.fugue.com.";
|
send fqdn.fqdn "grosse.fugue.com.";
|
||||||
@ -569,7 +569,7 @@ The \fBdb-time-format\fR option determines which of two output methods are
|
|||||||
used for printing times in leases files. The \fIdefault\fR format provides
|
used for printing times in leases files. The \fIdefault\fR format provides
|
||||||
day-and-time in UTC, whereas \fIlocal\fR uses a seconds-since-epoch to store
|
day-and-time in UTC, whereas \fIlocal\fR uses a seconds-since-epoch to store
|
||||||
the time value, and helpfully places a local timezone time in a comment on
|
the time value, and helpfully places a local timezone time in a comment on
|
||||||
the same line. The formats are described in detail in this manpage, whithin
|
the same line. The formats are described in detail in this manpage, within
|
||||||
the LEASE DECLARATIONS section.
|
the LEASE DECLARATIONS section.
|
||||||
.PP
|
.PP
|
||||||
\fBreject \fIcidr-ip-address\fR [\fB,\fR \fI...\fB \fIcidr-ip-address\fR ] \fB;\fR
|
\fBreject \fIcidr-ip-address\fR [\fB,\fR \fI...\fB \fIcidr-ip-address\fR ] \fB;\fR
|
||||||
|
@ -316,7 +316,7 @@ the data expression is reversed in place, using hunks of the size
|
|||||||
specified in the numeric expression. For example, if the numeric
|
specified in the numeric expression. For example, if the numeric
|
||||||
expression evaluates to four, and the data expression evaluates to
|
expression evaluates to four, and the data expression evaluates to
|
||||||
twelve bytes of data, then the reverse expression will evaluate to
|
twelve bytes of data, then the reverse expression will evaluate to
|
||||||
twelve bytes of data, consisting of the last four bytes of the the
|
twelve bytes of data, consisting of the last four bytes of the
|
||||||
input data, followed by the middle four bytes, followed by the first
|
input data, followed by the middle four bytes, followed by the first
|
||||||
four bytes.
|
four bytes.
|
||||||
.RE
|
.RE
|
||||||
|
@ -1146,7 +1146,7 @@ circuit from which a DHCP client-to-server packet was received. It is
|
|||||||
intended for use by agents in relaying DHCP responses back to the
|
intended for use by agents in relaying DHCP responses back to the
|
||||||
proper circuit. The format of this option is currently defined to be
|
proper circuit. The format of this option is currently defined to be
|
||||||
vendor-dependent, and will probably remain that way, although the
|
vendor-dependent, and will probably remain that way, although the
|
||||||
current draft allows for for the possibility of standardizing the
|
current draft allows for the possibility of standardizing the
|
||||||
format in the future.
|
format in the future.
|
||||||
.RE
|
.RE
|
||||||
.PP
|
.PP
|
||||||
@ -1184,7 +1184,7 @@ cases where the giaddr (where responses must be sent to the relay agent)
|
|||||||
is not on the same subnet as the client. When this option is present in
|
is not on the same subnet as the client. When this option is present in
|
||||||
a packet from a relay agent, the DHCP server will use its contents to find
|
a packet from a relay agent, the DHCP server will use its contents to find
|
||||||
a subnet declared in configuration, and from here take one step further
|
a subnet declared in configuration, and from here take one step further
|
||||||
backwards to any shared-network the subnet may be defined within...the
|
backwards to any shared-network the subnet may be defined within; the
|
||||||
client may be given any address within that shared network, as normally
|
client may be given any address within that shared network, as normally
|
||||||
appropriate.
|
appropriate.
|
||||||
.RE
|
.RE
|
||||||
@ -1261,8 +1261,8 @@ and \fBconfig-option\fR operators in an expression, in which case it returns
|
|||||||
all labels after the first label in the \fBfqdn.fqdn\fR suboption - for
|
all labels after the first label in the \fBfqdn.fqdn\fR suboption - for
|
||||||
example, if the value of \fBfqdn.fqdn\fR is "foo.example.com.",
|
example, if the value of \fBfqdn.fqdn\fR is "foo.example.com.",
|
||||||
then \fBfqdn.hostname\fR will be "example.com.". If this suboption value
|
then \fBfqdn.hostname\fR will be "example.com.". If this suboption value
|
||||||
is not set, it means that an unqualified name was sent in the fqdn option,
|
is not set, it means that an unqualified name was sent in the \fBfqdn\fR option,
|
||||||
or that no fqdn option was sent at all.
|
or that no \fBfqdn\fR option was sent at all.
|
||||||
.RE
|
.RE
|
||||||
.PP
|
.PP
|
||||||
If you wish to use any of these suboptions, we strongly recommend that you
|
If you wish to use any of these suboptions, we strongly recommend that you
|
||||||
@ -1591,7 +1591,7 @@ expected to use, and is related to the \fBnis-servers\fR option.
|
|||||||
.B option \fBdhcp6.nis-domain-name\fR \fIdomain-name\fR\fB;\fR
|
.B option \fBdhcp6.nis-domain-name\fR \fIdomain-name\fR\fB;\fR
|
||||||
.RS 0.25i
|
.RS 0.25i
|
||||||
.PP
|
.PP
|
||||||
The \fBdhcp6.nis-domain-name\fR option specfies NIS domain name the
|
The \fBdhcp6.nis-domain-name\fR option specifies NIS domain name the
|
||||||
client is expected to use, and is related to \fBdhcp6.nis-servers\fR option.
|
client is expected to use, and is related to \fBdhcp6.nis-servers\fR option.
|
||||||
.RE
|
.RE
|
||||||
.PP
|
.PP
|
||||||
@ -1605,7 +1605,7 @@ is expected to use, and is related to the \fBnisp-servers\fR option.
|
|||||||
.B option \fBdhcp6.nisp-domain-name\fR \fIdomain-name\fR\fB;\fR
|
.B option \fBdhcp6.nisp-domain-name\fR \fIdomain-name\fR\fB;\fR
|
||||||
.RS 0.25i
|
.RS 0.25i
|
||||||
.PP
|
.PP
|
||||||
The \fBdhcp6.nis-domain-name\fR option specfies NIS+ domain name the
|
The \fBdhcp6.nis-domain-name\fR option specifies NIS+ domain name the
|
||||||
client is expected to use, and is related to \fBdhcp6.nisp-servers\fR option.
|
client is expected to use, and is related to \fBdhcp6.nisp-servers\fR option.
|
||||||
.RE
|
.RE
|
||||||
.PP
|
.PP
|
||||||
@ -1906,7 +1906,7 @@ optional \fBcompressed\fR keyword indicates if the option should be
|
|||||||
compressed relative to the start of the option contents (not the packet
|
compressed relative to the start of the option contents (not the packet
|
||||||
contents).
|
contents).
|
||||||
.PP
|
.PP
|
||||||
When in doubt, omit the \fBcompressed\fR keyword. When the software recieves
|
When in doubt, omit the \fBcompressed\fR keyword. When the software receives
|
||||||
an option that is compressed and the \fBcompressed\fR keyword is omitted, it
|
an option that is compressed and the \fBcompressed\fR keyword is omitted, it
|
||||||
will still decompress the option (relative to the option contents field). The
|
will still decompress the option (relative to the option contents field). The
|
||||||
keyword only controls whether or not transmitted packets are compressed.
|
keyword only controls whether or not transmitted packets are compressed.
|
||||||
@ -1987,7 +1987,7 @@ the \fBVendor Identified Vendor Sub Options\fR option ("VIVSO"), and the
|
|||||||
DHCPv6 protocol defines the \fBVendor-specific Information Option\fR
|
DHCPv6 protocol defines the \fBVendor-specific Information Option\fR
|
||||||
("VSIO"). The format of all of these options is usually internally a
|
("VSIO"). The format of all of these options is usually internally a
|
||||||
string of options, similarly to other normal DHCP options. The VIVSO
|
string of options, similarly to other normal DHCP options. The VIVSO
|
||||||
and VSIO options differ in that that they contain options that correspond
|
and VSIO options differ in that they contain options that correspond
|
||||||
to vendor Enterprise-ID numbers (assigned by IANA), which then contain
|
to vendor Enterprise-ID numbers (assigned by IANA), which then contain
|
||||||
options according to each Vendor's specifications. You will need to refer
|
options according to each Vendor's specifications. You will need to refer
|
||||||
to your vendor's documentation in order to form options to their
|
to your vendor's documentation in order to form options to their
|
||||||
|
@ -297,8 +297,8 @@ functions all set a value on the object handle.
|
|||||||
.Pp
|
.Pp
|
||||||
.Fn dhcpctl_object_update
|
.Fn dhcpctl_object_update
|
||||||
function queues a request for
|
function queues a request for
|
||||||
all the changes made to the object handle be be sent to the remote
|
all the changes made to the object handle be sent to the remote
|
||||||
for processing. The changes made to the atributes on the handle will be
|
for processing. The changes made to the attributes on the handle will be
|
||||||
applied to remote object if permitted.
|
applied to remote object if permitted.
|
||||||
.\"
|
.\"
|
||||||
.\"
|
.\"
|
||||||
@ -352,7 +352,7 @@ from how the value appears in the dhcpd.conf file.
|
|||||||
.\"
|
.\"
|
||||||
.Pp
|
.Pp
|
||||||
.Fn dhcpctl_new_object
|
.Fn dhcpctl_new_object
|
||||||
creates a local handle for an object on the the server. The
|
creates a local handle for an object on the server. The
|
||||||
.Dq object_type
|
.Dq object_type
|
||||||
parameter is the ascii name of the type of object being accessed. e.g.
|
parameter is the ascii name of the type of object being accessed. e.g.
|
||||||
.Qq lease .
|
.Qq lease .
|
||||||
@ -418,7 +418,7 @@ released.
|
|||||||
The following program will connect to the DHCP server running on the local
|
The following program will connect to the DHCP server running on the local
|
||||||
host and will get the details of the existing lease for IP address
|
host and will get the details of the existing lease for IP address
|
||||||
10.0.0.101. It will then print out the time the lease is due to expire. Note
|
10.0.0.101. It will then print out the time the lease is due to expire. Note
|
||||||
that most error checking has been ommitted for brevity.
|
that most error checking has been omitted for brevity.
|
||||||
.Bd -literal -offset indent
|
.Bd -literal -offset indent
|
||||||
#include <sys/time.h>
|
#include <sys/time.h>
|
||||||
#include <stdio.h>
|
#include <stdio.h>
|
||||||
|
@ -246,7 +246,7 @@ automatically before installing it.
|
|||||||
.BI \-T
|
.BI \-T
|
||||||
Test the lease file. The server tests the lease file
|
Test the lease file. The server tests the lease file
|
||||||
for correct syntax, but will not attempt to perform any network
|
for correct syntax, but will not attempt to perform any network
|
||||||
operations. This can be used to test a new leaes file
|
operations. This can be used to test a new lease file
|
||||||
automatically before installing it.
|
automatically before installing it.
|
||||||
.TP
|
.TP
|
||||||
.BI \-tf \ tracefile
|
.BI \-tf \ tracefile
|
||||||
@ -273,7 +273,7 @@ Print version number and exit.
|
|||||||
.I Modifying default file locations:
|
.I Modifying default file locations:
|
||||||
The following options can be used to modify the locations
|
The following options can be used to modify the locations
|
||||||
.B dhcpd
|
.B dhcpd
|
||||||
uses for it's files. Because of the importance of using the same
|
uses for its files. Because of the importance of using the same
|
||||||
lease database at all times when running dhcpd in production, these
|
lease database at all times when running dhcpd in production, these
|
||||||
options should be used \fBonly\fR for testing lease files or database
|
options should be used \fBonly\fR for testing lease files or database
|
||||||
files in a non-production environment.
|
files in a non-production environment.
|
||||||
|
@ -780,7 +780,7 @@ The Failover pool balance statements.
|
|||||||
This version of the DHCP Server evaluates pool balance on a schedule,
|
This version of the DHCP Server evaluates pool balance on a schedule,
|
||||||
rather than on demand as leases are allocated. The latter approach
|
rather than on demand as leases are allocated. The latter approach
|
||||||
proved to be slightly klunky when pool misbalanced reach total
|
proved to be slightly klunky when pool misbalanced reach total
|
||||||
saturation...when any server ran out of leases to assign, it also lost
|
saturation \(em when any server ran out of leases to assign, it also lost
|
||||||
its ability to notice it had run dry.
|
its ability to notice it had run dry.
|
||||||
.PP
|
.PP
|
||||||
In order to understand pool balance, some elements of its operation
|
In order to understand pool balance, some elements of its operation
|
||||||
@ -1228,12 +1228,12 @@ IP address, it can update its own A record, assuming that the
|
|||||||
.PP
|
.PP
|
||||||
If the server is configured not to allow client updates, or if the
|
If the server is configured not to allow client updates, or if the
|
||||||
client doesn't want to do its own update, the server will simply
|
client doesn't want to do its own update, the server will simply
|
||||||
choose a name for the client from either the fqdn option (if present)
|
choose a name for the client from either the \fBfqdn\fR option (if present)
|
||||||
or the hostname option (if present). It will use its own
|
or the hostname option (if present). It will use its own
|
||||||
domain name for the client, just as in the ad-hoc update scheme.
|
domain name for the client, just as in the ad-hoc update scheme.
|
||||||
It will then update both the A and PTR record, using the name that it
|
It will then update both the A and PTR record, using the name that it
|
||||||
chose for the client. If the client sends a fully-qualified domain
|
chose for the client. If the client sends a fully-qualified domain
|
||||||
name in the fqdn option, the server uses only the leftmost part of the
|
name in the \fBfqdn\fR option, the server uses only the leftmost part of the
|
||||||
domain name - in the example above, "jschmoe" instead of
|
domain name - in the example above, "jschmoe" instead of
|
||||||
"jschmoe.radish.org".
|
"jschmoe.radish.org".
|
||||||
.PP
|
.PP
|
||||||
@ -2051,7 +2051,7 @@ The \fIddns-hostname\fR statement
|
|||||||
.B ddns-hostname \fIname\fB;\fR
|
.B ddns-hostname \fIname\fB;\fR
|
||||||
.PP
|
.PP
|
||||||
The \fIname\fR parameter should be the hostname that will be used in
|
The \fIname\fR parameter should be the hostname that will be used in
|
||||||
setting up the client's A and PTR records. If no ddns-hostname is
|
setting up the client's A and PTR records. If no \fIddns-hostname\fR is
|
||||||
specified in scope, then the server will derive the hostname
|
specified in scope, then the server will derive the hostname
|
||||||
automatically, using an algorithm that varies for each of the
|
automatically, using an algorithm that varies for each of the
|
||||||
different update methods.
|
different update methods.
|
||||||
@ -2199,7 +2199,7 @@ set to \fBinterim\fR. Forward updates are enabled by default. If
|
|||||||
this statement is used to disable forward updates, the DHCP server
|
this statement is used to disable forward updates, the DHCP server
|
||||||
will never attempt to update the client's A record, and will only ever
|
will never attempt to update the client's A record, and will only ever
|
||||||
attempt to update the client's PTR record if the client supplies an
|
attempt to update the client's PTR record if the client supplies an
|
||||||
FQDN that should be placed in the PTR record using the fqdn option.
|
FQDN that should be placed in the PTR record using the \fBfqdn\fR option.
|
||||||
If forward updates are enabled, the DHCP server will still honor the
|
If forward updates are enabled, the DHCP server will still honor the
|
||||||
setting of the \fBclient-updates\fR flag.
|
setting of the \fBclient-updates\fR flag.
|
||||||
.RE
|
.RE
|
||||||
@ -2454,7 +2454,7 @@ This statement causes the DHCP server to listen for DHCP requests sent
|
|||||||
to the specified \fIaddress\fR, rather than requests sent to all addresses.
|
to the specified \fIaddress\fR, rather than requests sent to all addresses.
|
||||||
Since serving directly attached DHCP clients implies that the server must
|
Since serving directly attached DHCP clients implies that the server must
|
||||||
respond to requests sent to the all-ones IP address, this option cannot be
|
respond to requests sent to the all-ones IP address, this option cannot be
|
||||||
used if clients are on directly attached networks...it is only realistically
|
used if clients are on directly attached networks; it is only realistically
|
||||||
useful for a server whose only clients are reached via unicasts, such as via
|
useful for a server whose only clients are reached via unicasts, such as via
|
||||||
DHCP relay agents.
|
DHCP relay agents.
|
||||||
.PP
|
.PP
|
||||||
@ -2509,6 +2509,7 @@ Because the \fIlog-facility\fR setting is controlled by the dhcpd.conf
|
|||||||
file, log messages printed while parsing the dhcpd.conf file or before
|
file, log messages printed while parsing the dhcpd.conf file or before
|
||||||
parsing it are logged to the default log facility. To prevent this,
|
parsing it are logged to the default log facility. To prevent this,
|
||||||
see the README file included with this distribution, which describes
|
see the README file included with this distribution, which describes
|
||||||
|
BUG: where is that mentioned in README?
|
||||||
how to change the default log facility. When this parameter is used,
|
how to change the default log facility. When this parameter is used,
|
||||||
the DHCP server prints its startup message a second time after parsing
|
the DHCP server prints its startup message a second time after parsing
|
||||||
the configuration file, so that the log will be as complete as
|
the configuration file, so that the log will be as complete as
|
||||||
|
@ -215,7 +215,7 @@ manual page.
|
|||||||
.B The \fIddns-text\fB variable
|
.B The \fIddns-text\fB variable
|
||||||
.PP
|
.PP
|
||||||
The \fIddns-text\fR variable is used to record the value of the
|
The \fIddns-text\fR variable is used to record the value of the
|
||||||
client's TXT identification record when the interim ddns update
|
client's TXT identification record when the interim DDNS update
|
||||||
style has been used to update the DNS for a particular lease.
|
style has been used to update the DNS for a particular lease.
|
||||||
.PP
|
.PP
|
||||||
.B The \fIddns-fwd-name\fB variable
|
.B The \fIddns-fwd-name\fB variable
|
||||||
@ -227,9 +227,9 @@ update the client's PTR record.
|
|||||||
.PP
|
.PP
|
||||||
.B The \fIddns-client-fqdn\fB variable
|
.B The \fIddns-client-fqdn\fB variable
|
||||||
.PP
|
.PP
|
||||||
If the server is configured to use the interim ddns update style, and
|
If the server is configured to use the interim DDNS update style, and
|
||||||
is also configured to allow clients to update their own fqdns, and the
|
is also configured to allow clients to update their own FQDNs, and the
|
||||||
client did in fact update its own fqdn, then the
|
client did in fact update its own FQDN, then the
|
||||||
\fIddns-client-fqdn\fR variable records the name that the client has
|
\fIddns-client-fqdn\fR variable records the name that the client has
|
||||||
indicated it is using. This is the name that the server will have
|
indicated it is using. This is the name that the server will have
|
||||||
used to update the client's PTR record in this case.
|
used to update the client's PTR record in this case.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user