Skip to content

Commit 8e112e2

Browse files
author
Jeremy C. Reed
committed
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.)
1 parent a2bb892 commit 8e112e2

File tree

8 files changed

+30
-29
lines changed

8 files changed

+30
-29
lines changed

client/dhclient.8

+2-2
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ inittab on System V systems. This implies \fB-v\fR.
245245
.TP
246246
.BI \-nw
247247
Become a daemon immediately (nowait) rather than waiting until an
248-
an IP address has been acquired.
248+
IP address has been acquired.
249249
.TP
250250
.BI \-q
251251
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.
361361
.PP
362362
.I Modifying default file locations:
363363
The following options can be used to modify the locations a client uses
364-
for it's files. They can be particularly useful if, for example,
364+
for its files. They can be particularly useful if, for example,
365365
.B DBDIR
366366
or
367367
.B RUNDIR

client/dhclient.conf.5

+2-2
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ or DHCPv6. The exact same syntax is used for both.
267267
.PP
268268
To make it work, you have to declare a key and zone as in the DHCP
269269
server (see \fBdhcpd.conf\fR(5) for details). You also need to
270-
configure the fqdn option on the client, as follows:
270+
configure the \fIfqdn\fR option on the client, as follows:
271271
.PP
272272
.nf
273273
send fqdn.fqdn "grosse.fugue.com.";
@@ -569,7 +569,7 @@ The \fBdb-time-format\fR option determines which of two output methods are
569569
used for printing times in leases files. The \fIdefault\fR format provides
570570
day-and-time in UTC, whereas \fIlocal\fR uses a seconds-since-epoch to store
571571
the time value, and helpfully places a local timezone time in a comment on
572-
the same line. The formats are described in detail in this manpage, whithin
572+
the same line. The formats are described in detail in this manpage, within
573573
the LEASE DECLARATIONS section.
574574
.PP
575575
\fBreject \fIcidr-ip-address\fR [\fB,\fR \fI...\fB \fIcidr-ip-address\fR ] \fB;\fR

common/dhcp-eval.5

+1-1
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ the data expression is reversed in place, using hunks of the size
316316
specified in the numeric expression. For example, if the numeric
317317
expression evaluates to four, and the data expression evaluates to
318318
twelve bytes of data, then the reverse expression will evaluate to
319-
twelve bytes of data, consisting of the last four bytes of the the
319+
twelve bytes of data, consisting of the last four bytes of the
320320
input data, followed by the middle four bytes, followed by the first
321321
four bytes.
322322
.RE

common/dhcp-options.5

+8-8
Original file line numberDiff line numberDiff line change
@@ -1146,7 +1146,7 @@ circuit from which a DHCP client-to-server packet was received. It is
11461146
intended for use by agents in relaying DHCP responses back to the
11471147
proper circuit. The format of this option is currently defined to be
11481148
vendor-dependent, and will probably remain that way, although the
1149-
current draft allows for for the possibility of standardizing the
1149+
current draft allows for the possibility of standardizing the
11501150
format in the future.
11511151
.RE
11521152
.PP
@@ -1184,7 +1184,7 @@ cases where the giaddr (where responses must be sent to the relay agent)
11841184
is not on the same subnet as the client. When this option is present in
11851185
a packet from a relay agent, the DHCP server will use its contents to find
11861186
a subnet declared in configuration, and from here take one step further
1187-
backwards to any shared-network the subnet may be defined within...the
1187+
backwards to any shared-network the subnet may be defined within; the
11881188
client may be given any address within that shared network, as normally
11891189
appropriate.
11901190
.RE
@@ -1261,8 +1261,8 @@ and \fBconfig-option\fR operators in an expression, in which case it returns
12611261
all labels after the first label in the \fBfqdn.fqdn\fR suboption - for
12621262
example, if the value of \fBfqdn.fqdn\fR is "foo.example.com.",
12631263
then \fBfqdn.hostname\fR will be "example.com.". If this suboption value
1264-
is not set, it means that an unqualified name was sent in the fqdn option,
1265-
or that no fqdn option was sent at all.
1264+
is not set, it means that an unqualified name was sent in the \fBfqdn\fR option,
1265+
or that no \fBfqdn\fR option was sent at all.
12661266
.RE
12671267
.PP
12681268
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.
15911591
.B option \fBdhcp6.nis-domain-name\fR \fIdomain-name\fR\fB;\fR
15921592
.RS 0.25i
15931593
.PP
1594-
The \fBdhcp6.nis-domain-name\fR option specfies NIS domain name the
1594+
The \fBdhcp6.nis-domain-name\fR option specifies NIS domain name the
15951595
client is expected to use, and is related to \fBdhcp6.nis-servers\fR option.
15961596
.RE
15971597
.PP
@@ -1605,7 +1605,7 @@ is expected to use, and is related to the \fBnisp-servers\fR option.
16051605
.B option \fBdhcp6.nisp-domain-name\fR \fIdomain-name\fR\fB;\fR
16061606
.RS 0.25i
16071607
.PP
1608-
The \fBdhcp6.nis-domain-name\fR option specfies NIS+ domain name the
1608+
The \fBdhcp6.nis-domain-name\fR option specifies NIS+ domain name the
16091609
client is expected to use, and is related to \fBdhcp6.nisp-servers\fR option.
16101610
.RE
16111611
.PP
@@ -1906,7 +1906,7 @@ optional \fBcompressed\fR keyword indicates if the option should be
19061906
compressed relative to the start of the option contents (not the packet
19071907
contents).
19081908
.PP
1909-
When in doubt, omit the \fBcompressed\fR keyword. When the software recieves
1909+
When in doubt, omit the \fBcompressed\fR keyword. When the software receives
19101910
an option that is compressed and the \fBcompressed\fR keyword is omitted, it
19111911
will still decompress the option (relative to the option contents field). The
19121912
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
19871987
DHCPv6 protocol defines the \fBVendor-specific Information Option\fR
19881988
("VSIO"). The format of all of these options is usually internally a
19891989
string of options, similarly to other normal DHCP options. The VIVSO
1990-
and VSIO options differ in that that they contain options that correspond
1990+
and VSIO options differ in that they contain options that correspond
19911991
to vendor Enterprise-ID numbers (assigned by IANA), which then contain
19921992
options according to each Vendor's specifications. You will need to refer
19931993
to your vendor's documentation in order to form options to their

dhcpctl/dhcpctl.3

+4-4
Original file line numberDiff line numberDiff line change
@@ -297,8 +297,8 @@ functions all set a value on the object handle.
297297
.Pp
298298
.Fn dhcpctl_object_update
299299
function queues a request for
300-
all the changes made to the object handle be be sent to the remote
301-
for processing. The changes made to the atributes on the handle will be
300+
all the changes made to the object handle be sent to the remote
301+
for processing. The changes made to the attributes on the handle will be
302302
applied to remote object if permitted.
303303
.\"
304304
.\"
@@ -352,7 +352,7 @@ from how the value appears in the dhcpd.conf file.
352352
.\"
353353
.Pp
354354
.Fn dhcpctl_new_object
355-
creates a local handle for an object on the the server. The
355+
creates a local handle for an object on the server. The
356356
.Dq object_type
357357
parameter is the ascii name of the type of object being accessed. e.g.
358358
.Qq lease .
@@ -418,7 +418,7 @@ released.
418418
The following program will connect to the DHCP server running on the local
419419
host and will get the details of the existing lease for IP address
420420
10.0.0.101. It will then print out the time the lease is due to expire. Note
421-
that most error checking has been ommitted for brevity.
421+
that most error checking has been omitted for brevity.
422422
.Bd -literal -offset indent
423423
#include <sys/time.h>
424424
#include <stdio.h>

server/dhcpd.8

+2-2
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ automatically before installing it.
246246
.BI \-T
247247
Test the lease file. The server tests the lease file
248248
for correct syntax, but will not attempt to perform any network
249-
operations. This can be used to test a new leaes file
249+
operations. This can be used to test a new lease file
250250
automatically before installing it.
251251
.TP
252252
.BI \-tf \ tracefile
@@ -273,7 +273,7 @@ Print version number and exit.
273273
.I Modifying default file locations:
274274
The following options can be used to modify the locations
275275
.B dhcpd
276-
uses for it's files. Because of the importance of using the same
276+
uses for its files. Because of the importance of using the same
277277
lease database at all times when running dhcpd in production, these
278278
options should be used \fBonly\fR for testing lease files or database
279279
files in a non-production environment.

server/dhcpd.conf.5

+7-6
Original file line numberDiff line numberDiff line change
@@ -780,7 +780,7 @@ The Failover pool balance statements.
780780
This version of the DHCP Server evaluates pool balance on a schedule,
781781
rather than on demand as leases are allocated. The latter approach
782782
proved to be slightly klunky when pool misbalanced reach total
783-
saturation...when any server ran out of leases to assign, it also lost
783+
saturation \(em when any server ran out of leases to assign, it also lost
784784
its ability to notice it had run dry.
785785
.PP
786786
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
12281228
.PP
12291229
If the server is configured not to allow client updates, or if the
12301230
client doesn't want to do its own update, the server will simply
1231-
choose a name for the client from either the fqdn option (if present)
1231+
choose a name for the client from either the \fBfqdn\fR option (if present)
12321232
or the hostname option (if present). It will use its own
12331233
domain name for the client, just as in the ad-hoc update scheme.
12341234
It will then update both the A and PTR record, using the name that it
12351235
chose for the client. If the client sends a fully-qualified domain
1236-
name in the fqdn option, the server uses only the leftmost part of the
1236+
name in the \fBfqdn\fR option, the server uses only the leftmost part of the
12371237
domain name - in the example above, "jschmoe" instead of
12381238
"jschmoe.radish.org".
12391239
.PP
@@ -2051,7 +2051,7 @@ The \fIddns-hostname\fR statement
20512051
.B ddns-hostname \fIname\fB;\fR
20522052
.PP
20532053
The \fIname\fR parameter should be the hostname that will be used in
2054-
setting up the client's A and PTR records. If no ddns-hostname is
2054+
setting up the client's A and PTR records. If no \fIddns-hostname\fR is
20552055
specified in scope, then the server will derive the hostname
20562056
automatically, using an algorithm that varies for each of the
20572057
different update methods.
@@ -2199,7 +2199,7 @@ set to \fBinterim\fR. Forward updates are enabled by default. If
21992199
this statement is used to disable forward updates, the DHCP server
22002200
will never attempt to update the client's A record, and will only ever
22012201
attempt to update the client's PTR record if the client supplies an
2202-
FQDN that should be placed in the PTR record using the fqdn option.
2202+
FQDN that should be placed in the PTR record using the \fBfqdn\fR option.
22032203
If forward updates are enabled, the DHCP server will still honor the
22042204
setting of the \fBclient-updates\fR flag.
22052205
.RE
@@ -2454,7 +2454,7 @@ This statement causes the DHCP server to listen for DHCP requests sent
24542454
to the specified \fIaddress\fR, rather than requests sent to all addresses.
24552455
Since serving directly attached DHCP clients implies that the server must
24562456
respond to requests sent to the all-ones IP address, this option cannot be
2457-
used if clients are on directly attached networks...it is only realistically
2457+
used if clients are on directly attached networks; it is only realistically
24582458
useful for a server whose only clients are reached via unicasts, such as via
24592459
DHCP relay agents.
24602460
.PP
@@ -2509,6 +2509,7 @@ Because the \fIlog-facility\fR setting is controlled by the dhcpd.conf
25092509
file, log messages printed while parsing the dhcpd.conf file or before
25102510
parsing it are logged to the default log facility. To prevent this,
25112511
see the README file included with this distribution, which describes
2512+
BUG: where is that mentioned in README?
25122513
how to change the default log facility. When this parameter is used,
25132514
the DHCP server prints its startup message a second time after parsing
25142515
the configuration file, so that the log will be as complete as

server/dhcpd.leases.5

+4-4
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ manual page.
215215
.B The \fIddns-text\fB variable
216216
.PP
217217
The \fIddns-text\fR variable is used to record the value of the
218-
client's TXT identification record when the interim ddns update
218+
client's TXT identification record when the interim DDNS update
219219
style has been used to update the DNS for a particular lease.
220220
.PP
221221
.B The \fIddns-fwd-name\fB variable
@@ -227,9 +227,9 @@ update the client's PTR record.
227227
.PP
228228
.B The \fIddns-client-fqdn\fB variable
229229
.PP
230-
If the server is configured to use the interim ddns update style, and
231-
is also configured to allow clients to update their own fqdns, and the
232-
client did in fact update its own fqdn, then the
230+
If the server is configured to use the interim DDNS update style, and
231+
is also configured to allow clients to update their own FQDNs, and the
232+
client did in fact update its own FQDN, then the
233233
\fIddns-client-fqdn\fR variable records the name that the client has
234234
indicated it is using. This is the name that the server will have
235235
used to update the client's PTR record in this case.

0 commit comments

Comments
 (0)