From: jmc <jmc@openbsd.org>
Date: Sun, 11 Aug 2024 06:07:37 +0000 (+0000)
Subject: rework DESCRIPTION for both dhcpleased(8) and slaacd(8) to more accurately
X-Git-Url: http://artulab.com/gitweb/?a=commitdiff_plain;h=fb6793a638ba2c194401d3a26cc78c1d73e6f504;p=openbsd

rework DESCRIPTION for both dhcpleased(8) and slaacd(8) to more accurately
reflect how they work, to emphasize that they do nothing unless auto conf
is set, and to more closely match each other;

prompted by a diff from andrew christopher hawk on tech, who noted a wonky
sentence;

help/feedback deraadt florian; ok deraadt
---

diff --git a/sbin/dhcpleased/dhcpleased.8 b/sbin/dhcpleased/dhcpleased.8
index 4b42b5639e6..23c6c2ffb0e 100644
--- a/sbin/dhcpleased/dhcpleased.8
+++ b/sbin/dhcpleased/dhcpleased.8
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: dhcpleased.8,v 1.6 2023/03/02 17:09:52 jmc Exp $
+.\"	$OpenBSD: dhcpleased.8,v 1.7 2024/08/11 06:07:37 jmc Exp $
 .\"
 .\" Copyright (c) 2021 Florian Obser <florian@openbsd.org>
 .\"
@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: March 2 2023 $
+.Dd $Mdocdate: August 11 2024 $
 .Dt DHCPLEASED 8
 .Os
 .Sh NAME
@@ -28,11 +28,16 @@
 .Sh DESCRIPTION
 .Nm
 is a dynamic host configuration protocol (DHCP) daemon for clients.
-It requests IP configuration information from for example those offered by
-.Xr dhcpd 8 ,
-on interfaces with the
+If an interface has the
 .Sy AUTOCONF4
-flag set.
+flag set
+(auto configuration is enabled),
+.Nm
+sends requests for IP configuration information from a DHCP server,
+such as
+.Xr dhcpd 8 ,
+and uses that information to configure the relevant interface.
+.Pp
 See
 .Xr hostname.if 5
 and
@@ -41,9 +46,8 @@ on how to enable auto configuration on an interface.
 .Pp
 .Nm
 monitors network interface states (interface going up or down,
-auto configuration enabled or disabled etc.) and sends requests
+auto configuration enabled or disabled, etc.) and sends requests
 when necessary.
-.Pp
 A running
 .Nm
 can be controlled with the
diff --git a/sbin/slaacd/slaacd.8 b/sbin/slaacd/slaacd.8
index 4ffc3143c5d..e51ff5ee4ce 100644
--- a/sbin/slaacd/slaacd.8
+++ b/sbin/slaacd/slaacd.8
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: slaacd.8,v 1.12 2023/03/02 17:09:54 jmc Exp $
+.\"	$OpenBSD: slaacd.8,v 1.13 2024/08/11 06:07:37 jmc Exp $
 .\"
 .\" Copyright (c) 2017 Florian Obser <florian@openbsd.org>
 .\" Copyright (c) 2016 Kenneth R Westerback <kwesterback@gmail.com>
@@ -15,7 +15,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: March 2 2023 $
+.Dd $Mdocdate: August 11 2024 $
 .Dt SLAACD 8
 .Os
 .Sh NAME
@@ -28,15 +28,16 @@
 .Sh DESCRIPTION
 .Nm
 is a stateless address autoconfiguration (SLAAC) daemon for clients.
-It listens for IPv6 router advertisement messages,
-for example those sent by
-.Xr rad 8 ,
-on interfaces with the
+If an interface has the
 .Sy AUTOCONF6
-flag set.
+flag set
+(auto configuration is enabled),
 .Nm
-derives IPv6 addresses and default routes from received router
-advertisements and installs them in the kernel.
+regularly sends out requests for IPv6 router advertisement messages,
+such as those sent by
+.Xr rad 8 ,
+and uses those messages to configure the relevant interface.
+.Pp
 See
 .Xr hostname.if 5
 and
@@ -44,10 +45,9 @@ and
 on how to enable auto configuration on an interface.
 .Pp
 .Nm
-monitors network interface states (interface going up or down,
-auto configuration enabled or disabled etc.) and sends router solicitations
-when necessary.
-.Pp
+monitors network interface states
+(interface going up or down, auto configuration enabled or disabled, etc.)\&
+and sends router solicitations when necessary.
 A running
 .Nm
 can be controlled with the