git: ad8cac1229bf - main - ifconfig.8: Improve readability of address_family documentation

From: Mateusz Piotrowski <0mp_at_FreeBSD.org>
Date: Thu, 31 Mar 2022 09:45:00 UTC
The branch main has been updated by 0mp (doc, ports committer):

URL: https://cgit.FreeBSD.org/src/commit/?id=ad8cac1229bf8ca9d26435e2293c34127c01ff51

commit ad8cac1229bf8ca9d26435e2293c34127c01ff51
Author:     Mateusz Piotrowski <0mp@FreeBSD.org>
AuthorDate: 2022-03-31 09:11:32 +0000
Commit:     Mateusz Piotrowski <0mp@FreeBSD.org>
CommitDate: 2022-03-31 09:43:17 +0000

    ifconfig.8: Improve readability of address_family documentation
    
    Also, move the description of the special case of "ifconfig -l ether" to
    the description of the -l flag.
    
    MFC after:      2 weeks
---
 sbin/ifconfig/ifconfig.8 | 58 +++++++++++++++++++++++++-----------------------
 1 file changed, 30 insertions(+), 28 deletions(-)

diff --git a/sbin/ifconfig/ifconfig.8 b/sbin/ifconfig/ifconfig.8
index 627fd5e6eea3..9fede254314c 100644
--- a/sbin/ifconfig/ifconfig.8
+++ b/sbin/ifconfig/ifconfig.8
@@ -28,7 +28,7 @@
 .\"     From: @(#)ifconfig.8	8.3 (Berkeley) 1/5/94
 .\" $FreeBSD$
 .\"
-.Dd March 30, 2022
+.Dd March 31, 2022
 .Dt IFCONFIG 8
 .Os
 .Sh NAME
@@ -225,8 +225,17 @@ with no other additional information.
 If an
 .Ar address_family
 is specified, only interfaces of that type will be listed.
-.Ql ifconfig -l ether
-will list only Ethernet adapters, excluding the loopback interface.
+.Pp
+If the
+.Ar address_family
+is set to
+.Cm ether ,
+then
+.Fl l
+will exclude loopback interfaces from the list of Ethernet interfaces.
+This is a special case, because all the other synonyms of the
+.Cm link
+address family will include loopback interfaces in the list.
 .Pp
 Use of this flag is mutually exclusive
 with all other flags and commands, except for
@@ -313,32 +322,25 @@ which affects interpretation of the remaining parameters.
 Since an interface can receive transmissions in differing protocols
 with different naming schemes, specifying the address family is recommended.
 The address or protocol families currently
-supported are
-.Dq inet ,
-.Dq inet6 ,
-and
-.Dq link .
-The default if available is
-.Dq inet
-or otherwise
-.Dq link .
-.Dq ether
-and
-.Dq lladdr
-are synonyms for
-.Dq link .
-When using the
+supported are:
+.Bl -tag
+.It Cm ether
+Synonymous with
+.Cm link
+.Po with some exceptions, see
 .Fl l
-flag, the
-.Dq ether
-address family has special meaning and is no longer synonymous with
-.Dq link
-or
-.Dq lladdr .
-Specifying
-.Fl l Dq ether
-will list only Ethernet interfaces, excluding all other interface types,
-including the loopback interface.
+.Pc .
+.It Cm inet
+Default, if available.
+.It Cm inet6
+.It Cm link
+Default, if
+.Cm inet
+is not available.
+.It Cm lladdr
+Synonymous with
+.Cm link .
+.El
 .It Ar dest_address
 Specify the address of the correspondent on the other end
 of a point to point link.