mirror of
https://github.com/rsmarples/dhcpcd.git
synced 2024-11-23 10:06:42 +08:00
Grammar improvements and typo fixes to README and manpages
This commit is contained in:
parent
b3c41d25a3
commit
dc9775edaa
10
README.md
10
README.md
@ -1,11 +1,11 @@
|
||||
# dhcpcd
|
||||
|
||||
dhcpcd is a
|
||||
[DHCP](http://en.wikipedia.org/wiki/Dynamic_Host_Configuration_Protocol) and a
|
||||
[DHCPv6](http://en.wikipedia.org/wiki/DHCPv6) client.
|
||||
It's also an IPv4LL (aka [ZeroConf](http://en.wikipedia.org/wiki/Zeroconf))
|
||||
[DHCP](https://en.wikipedia.org/wiki/Dynamic_Host_Configuration_Protocol) and a
|
||||
[DHCPv6](https://en.wikipedia.org/wiki/DHCPv6) client.
|
||||
It's also an IPv4LL (aka [ZeroConf](https://en.wikipedia.org/wiki/Zeroconf))
|
||||
client.
|
||||
In layman's terms, dhcpcd runs on your machine and silently configures your
|
||||
In layperson's terms, dhcpcd runs on your machine and silently configures your
|
||||
computer to work on the attached networks without trouble and mostly without
|
||||
configuration.
|
||||
|
||||
@ -93,4 +93,4 @@ dhcpcd-9 defaults the run directory to `/var/run/dhcpcd` instead of
|
||||
We no longer supply a ChangeLog.
|
||||
However, you're more than welcome to read the
|
||||
[commit log](https://roy.marples.name/git/dhcpcd/log) and
|
||||
[archived release announcements](http://roy.marples.name/archives/dhcpcd-discuss/).
|
||||
[archived release announcements](https://roy.marples.name/archives/dhcpcd-discuss/).
|
||||
|
@ -68,15 +68,14 @@ is set to the interface that
|
||||
.Nm dhcpcd
|
||||
is run on and
|
||||
.Ev $reason
|
||||
is to the reason why
|
||||
q
|
||||
is set to the reason why
|
||||
.Nm
|
||||
was invoked.
|
||||
DHCP information to be configured is held in variables starting with the word
|
||||
new_ and old DHCP information to be removed is held in variables starting with
|
||||
the word old_.
|
||||
.Nm dhcpcd
|
||||
can display the full list of variables it knows how about by using the
|
||||
can display the full list of variables it knows about by using the
|
||||
.Fl V , -variables
|
||||
argument.
|
||||
.Pp
|
||||
@ -85,7 +84,7 @@ Here's a list of reasons why
|
||||
could be invoked:
|
||||
.Bl -tag -width EXPIREXXXEXPIRE6
|
||||
.It Dv PREINIT
|
||||
dhcpcd is starting up and any pre-initialisation should be done.
|
||||
dhcpcd is starting up and any pre-initialisation required should be performed now.
|
||||
.It Dv CARRIER
|
||||
dhcpcd has detected the carrier is up.
|
||||
This is generally just a notification and no action need be taken.
|
||||
@ -181,7 +180,7 @@ flags.
|
||||
.Ev $interface
|
||||
MTU.
|
||||
.It Ev $ifssid
|
||||
the name of the SSID the
|
||||
the SSID the
|
||||
.Ev interface
|
||||
is connected to.
|
||||
.It Ev $interface_order
|
||||
@ -207,24 +206,24 @@ Address family waiting for, as defined in
|
||||
the name of the profile selected from
|
||||
.Xr dhcpcd.conf 5 .
|
||||
.It Ev $new_delegated_dhcp6_prefix
|
||||
space separated list of delegated prefixes.
|
||||
space-separated list of delegated prefixes.
|
||||
.El
|
||||
.Sh FILES
|
||||
When
|
||||
.Nm
|
||||
runs, it loads
|
||||
.Pa @SYSCONFDIR@/dhcpcd.enter-hook
|
||||
and any scripts found in
|
||||
.Pa @SYSCONFDIR@/dhcpcd.enter-hook ,
|
||||
any scripts found in
|
||||
.Pa @HOOKDIR@
|
||||
in a lexical order and then finally
|
||||
.Pa @SYSCONFDIR@/dhcpcd.exit-hook
|
||||
in lexical order, then finally
|
||||
.Pa @SYSCONFDIR@/dhcpcd.exit-hook .
|
||||
.Sh SEE ALSO
|
||||
.Xr dhcpcd 8
|
||||
.Sh AUTHORS
|
||||
.An Roy Marples Aq Mt roy@marples.name
|
||||
.Sh BUGS
|
||||
Please report them to
|
||||
.Lk http://roy.marples.name/projects/dhcpcd
|
||||
.Lk https://roy.marples.name/projects/dhcpcd
|
||||
.Sh SECURITY CONSIDERATIONS
|
||||
.Nm dhcpcd
|
||||
will validate the content of each option against its encoding.
|
||||
|
@ -171,7 +171,7 @@ only works with those interfaces, otherwise
|
||||
discovers available Ethernet interfaces that can be configured.
|
||||
When
|
||||
.Nm
|
||||
not limited to one interface on the command line,
|
||||
is not limited to one interface on the command line,
|
||||
it is running in Manager mode.
|
||||
The
|
||||
.Nm dhcpcd-ui
|
||||
@ -182,6 +182,7 @@ If a single interface is given then
|
||||
only works for that interface and runs as a separate instance to other
|
||||
.Nm
|
||||
processes.
|
||||
The
|
||||
.Fl w , Fl Fl waitip
|
||||
option is enabled in this instance to maintain compatibility with older
|
||||
versions.
|
||||
@ -320,7 +321,7 @@ to put things back afterwards.
|
||||
does not read a new configuration when this happens - you should rebind if you
|
||||
need that functionality.
|
||||
.It Fl F , Fl Fl fqdn Ar fqdn
|
||||
Requests that the DHCP server updates DNS using FQDN instead of just a
|
||||
Requests that the DHCP server update DNS using FQDN instead of just a
|
||||
hostname.
|
||||
Valid values for
|
||||
.Ar fqdn
|
||||
@ -453,7 +454,7 @@ variable for use in
|
||||
.Nm
|
||||
normally de-configures the
|
||||
.Ar interface
|
||||
and configuration when it exits.
|
||||
when it exits.
|
||||
Sometimes, this isn't desirable if, for example, you have root mounted over
|
||||
NFS or SSH clients connect to this host and they need to be notified of
|
||||
the host shutting down.
|
||||
@ -789,7 +790,7 @@ If the point to point interface is configured for INFORM, then
|
||||
unicasts INFORM to the destination, otherwise it defaults to STATIC.
|
||||
.Sh NOTES
|
||||
.Nm
|
||||
requires a Berkley Packet Filter, or BPF device on BSD based systems and a
|
||||
requires a Berkeley Packet Filter, or BPF device on BSD based systems and a
|
||||
Linux Socket Filter, or LPF device on Linux based systems for all IPv4
|
||||
configuration.
|
||||
.Pp
|
||||
@ -825,7 +826,7 @@ Linux
|
||||
.Pa /dev
|
||||
management modules.
|
||||
.It Pa @HOOKDIR@
|
||||
A directory containing bourne shell scripts that are run by the above script.
|
||||
A directory containing Bourne shell scripts that are run by the above script.
|
||||
Each script can be disabled by using the
|
||||
.Fl C , Fl Fl nohook
|
||||
option described above.
|
||||
@ -881,4 +882,4 @@ RFC\ 6603, RFC\ 6704, RFC\ 7217, RFC\ 7550, RFC\ 7844.
|
||||
.An Roy Marples Aq Mt roy@marples.name
|
||||
.Sh BUGS
|
||||
Please report them to
|
||||
.Lk http://roy.marples.name/projects/dhcpcd
|
||||
.Lk https://roy.marples.name/projects/dhcpcd
|
||||
|
@ -1013,4 +1013,4 @@ Same as
|
||||
.An Roy Marples Aq Mt roy@marples.name
|
||||
.Sh BUGS
|
||||
Please report them to
|
||||
.Lk http://roy.marples.name/projects/dhcpcd
|
||||
.Lk https://roy.marples.name/projects/dhcpcd
|
||||
|
Loading…
Reference in New Issue
Block a user