mirror of
https://github.com/freebsd/freebsd-src
synced 2024-10-03 23:28:58 +00:00
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
(cherry picked from commit ad8cac1229
)
This commit is contained in:
parent
c3bf44b542
commit
233f423174
|
@ -28,7 +28,7 @@
|
||||||
.\" From: @(#)ifconfig.8 8.3 (Berkeley) 1/5/94
|
.\" From: @(#)ifconfig.8 8.3 (Berkeley) 1/5/94
|
||||||
.\" $FreeBSD$
|
.\" $FreeBSD$
|
||||||
.\"
|
.\"
|
||||||
.Dd March 30, 2022
|
.Dd March 31, 2022
|
||||||
.Dt IFCONFIG 8
|
.Dt IFCONFIG 8
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
|
@ -225,8 +225,17 @@ with no other additional information.
|
||||||
If an
|
If an
|
||||||
.Ar address_family
|
.Ar address_family
|
||||||
is specified, only interfaces of that type will be listed.
|
is specified, only interfaces of that type will be listed.
|
||||||
.Ql ifconfig -l ether
|
.Pp
|
||||||
will list only Ethernet adapters, excluding the loopback interface.
|
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
|
.Pp
|
||||||
Use of this flag is mutually exclusive
|
Use of this flag is mutually exclusive
|
||||||
with all other flags and commands, except for
|
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
|
Since an interface can receive transmissions in differing protocols
|
||||||
with different naming schemes, specifying the address family is recommended.
|
with different naming schemes, specifying the address family is recommended.
|
||||||
The address or protocol families currently
|
The address or protocol families currently
|
||||||
supported are
|
supported are:
|
||||||
.Dq inet ,
|
.Bl -tag
|
||||||
.Dq inet6 ,
|
.It Cm ether
|
||||||
and
|
Synonymous with
|
||||||
.Dq link .
|
.Cm link
|
||||||
The default if available is
|
.Po with some exceptions, see
|
||||||
.Dq inet
|
|
||||||
or otherwise
|
|
||||||
.Dq link .
|
|
||||||
.Dq ether
|
|
||||||
and
|
|
||||||
.Dq lladdr
|
|
||||||
are synonyms for
|
|
||||||
.Dq link .
|
|
||||||
When using the
|
|
||||||
.Fl l
|
.Fl l
|
||||||
flag, the
|
.Pc .
|
||||||
.Dq ether
|
.It Cm inet
|
||||||
address family has special meaning and is no longer synonymous with
|
Default, if available.
|
||||||
.Dq link
|
.It Cm inet6
|
||||||
or
|
.It Cm link
|
||||||
.Dq lladdr .
|
Default, if
|
||||||
Specifying
|
.Cm inet
|
||||||
.Fl l Dq ether
|
is not available.
|
||||||
will list only Ethernet interfaces, excluding all other interface types,
|
.It Cm lladdr
|
||||||
including the loopback interface.
|
Synonymous with
|
||||||
|
.Cm link .
|
||||||
|
.El
|
||||||
.It Ar dest_address
|
.It Ar dest_address
|
||||||
Specify the address of the correspondent on the other end
|
Specify the address of the correspondent on the other end
|
||||||
of a point to point link.
|
of a point to point link.
|
||||||
|
|
Loading…
Reference in a new issue