On Thu, Nov 11, 2021 at 04:11:10PM +0000, Raf Czlonka wrote:
> Hello,
> 
> It seems like this has been missed in recent thread[0].
> 
> Not entirely sure whether the sentence "flows" any longer but here
> it goes anyway.
> 
> [0] https://marc.info/?l=openbsd-tech&m=163507448118443&w=2

Thanks, I missed that!

> Index: share/man/man5/hostname.if.5
> ===================================================================
> RCS file: /cvs/src/share/man/man5/hostname.if.5,v
> retrieving revision 1.77
> diff -u -p -r1.77 hostname.if.5
> --- share/man/man5/hostname.if.5      17 Jul 2021 15:28:31 -0000      1.77
> +++ share/man/man5/hostname.if.5      11 Nov 2021 16:09:33 -0000
> @@ -67,13 +67,13 @@ inet 10.0.0.1 255.255.255.0 10.0.0.255 d
>  Each line is processed separately and in order.
>  For example:
>  .Bd -literal -offset indent
> -nwid mynwid wpakey mywpakey
> +join mynwid wpakey mywpakey
>  inet6 autoconf
>  inet autoconf
>  .Ed
>  .Pp
>  would run ifconfig three times to set the
> -.Cm nwid
> +.Cm join
>  and
>  .Cm wpakey
>  of the interface,

Maybe this reads better in general?

    would run ifconfig three times to join a wireless network using WPA and
    to set the AUTOCONF6 and AUTOCONF4 flags, respectively.

No need to explain lines command by command.  Keep it simple;  users
must read ifconfig(8) anyway.

One might as well say to

    ... and
    to enable automatic address configuration for IPv6 and IPv4, respectively.

Then we don't have the weird mix of conceptual words and technical bits,
i.e. "connect to wifi" vs. "set if flags [they're picked up by network
daemons, but we don't say which ones]".

DYNAMIC ADDRESS CONFIGURATION down below repeats all this, anyway.

Feedback? OK?


Index: hostname.if.5
===================================================================
RCS file: /cvs/src/share/man/man5/hostname.if.5,v
retrieving revision 1.77
diff -u -p -r1.77 hostname.if.5
--- hostname.if.5       17 Jul 2021 15:28:31 -0000      1.77
+++ hostname.if.5       11 Nov 2021 16:30:00 -0000
@@ -67,21 +67,15 @@ inet 10.0.0.1 255.255.255.0 10.0.0.255 d
 Each line is processed separately and in order.
 For example:
 .Bd -literal -offset indent
-nwid mynwid wpakey mywpakey
+join mynwid wpakey mywpakey
 inet6 autoconf
 inet autoconf
 .Ed
 .Pp
-would run ifconfig three times to set the
-.Cm nwid
-and
-.Cm wpakey
-of the interface,
-the
-.Sy AUTOCONF6
-flag and the
-.Sy AUTOCONF4
-flag, respectively.
+would run ifconfig three times to
+.Cm join
+a wireless network using WPA
+and enable dynamic address configuration, respectively.
 .Sh STATIC ADDRESS CONFIGURATION
 The following packed formats are valid for configuring network
 interfaces with static addresses.

Reply via email to