From nobody Wed Jun 29 08:19:28 2022 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id E6A7986001A; Wed, 29 Jun 2022 08:19:28 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4LXvWh4Y0Yz4kHY; Wed, 29 Jun 2022 08:19:28 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1656490768; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=ZRfQeRdZAVTAsI8f/orfW20KdOT9MvgK8YKmMKpmgRo=; b=TTcjTA//x/MqzE9Vf0J685Fjp+s05T3lhHPejGt+GQH5Tu9VpSaf9I5nRQoTqssRjyf5MD Bfh8Ic3Ay0od4k44C9Pmjeg247GP7QJI4FE4zVLOgm6yeSsNcNU3EshTQ1zWQE9Hh/ItyV VQNguXz/iTXC9AlpAS+BUvFF9HCT7QkSRaZs9G08/avPAcKqEAEGA/Fvps/0Do5mFEhT9C TDLwC/LX0ibNdJ74JD4Df62kwT0L51wXNqYMvheLmIjeowU5a4iWNOMO/74SMdwfbUPHAV e7xQwNnnBgvzcs8Ki9lrN4bni7OjFiaICvVclP5lZ4BOvGHD2iKEXQ4k8OwQRA== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 67BD15DE8; Wed, 29 Jun 2022 08:19:28 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 25T8JSEv005330; Wed, 29 Jun 2022 08:19:28 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 25T8JSOw005329; Wed, 29 Jun 2022 08:19:28 GMT (envelope-from git) Date: Wed, 29 Jun 2022 08:19:28 GMT Message-Id: <202206290819.25T8JSOw005329@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Mateusz Piotrowski <0mp@FreeBSD.org> Subject: git: 233f4231744c - stable/13 - ifconfig.8: Improve readability of address_family documentation List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-all@freebsd.org X-BeenThere: dev-commits-src-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: 0mp X-Git-Repository: src X-Git-Refname: refs/heads/stable/13 X-Git-Reftype: branch X-Git-Commit: 233f4231744c384b57614c76a322412de395f4b5 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1656490768; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=ZRfQeRdZAVTAsI8f/orfW20KdOT9MvgK8YKmMKpmgRo=; b=w+7Vd9BFLqGizg+ad28um+qJgqaEQEAPlpPMshEecVrL07Lg4AB5wiMPifxCrv5/7XaQpm y8ZzFQVAhEHAfgF5fb+z0IOo4V/LZyCVQcIJvxjb5iJSmieYuoKU4B3jfsLIj1n4l+L/W7 JTLZgXyS3CDXkPFHrB6WGuJzPoeRMIpg9kasp4+bxSpywDkWCRMUW3mG0/QzdS8lkFAued NhxzanMNfyCmK9BBMdRtsbko+YoNdymAezqMF99oIq/QdC0qbkyGa44/xAPJRH1nS3Wh6D GdvVo8uhoGJdKJMaTAYKi9HkbhkW2TzibVJP7jn9tW4dOIblF5CQmQ8Q8K9UdA== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1656490768; a=rsa-sha256; cv=none; b=oLOWVf5E0DXbUgyh7v6H8MbX9TCAtHtIOz8GitoZMKKKRZzsUb+ZSyCE3po/AfBkoyfwLm Uw8Ahq5eMr8EXKoJxgfdB9Xt44GTWKLhw2xkwMGmJQdGhzSS177XBvxEXr4kMPfWHSLlzU xd2EYTfwVM3RxKscbUGQUWab/45BeFypNWry+hT0NMGdQSARvjq0nk5BUqTjh9vtJobUjf UOv6f0SRgCYsJN+tesyup0f2HU7l7d6+Mq9g+q9leBT7etlYWMzovktkA9riW2wIG3AnOj FOYa3ruIcb0hcP5LCF/SkMwthXggotJ5ol62rSDc6bMWn93cB2m9da1Zilg/xQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch stable/13 has been updated by 0mp (doc, ports committer): URL: https://cgit.FreeBSD.org/src/commit/?id=233f4231744c384b57614c76a322412de395f4b5 commit 233f4231744c384b57614c76a322412de395f4b5 Author: Mateusz Piotrowski <0mp@FreeBSD.org> AuthorDate: 2022-03-31 09:11:32 +0000 Commit: Mateusz Piotrowski <0mp@FreeBSD.org> CommitDate: 2022-06-29 08:15:10 +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 (cherry picked from commit ad8cac1229bf8ca9d26435e2293c34127c01ff51) --- 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 69e6d5799492..1edcc1b35e09 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.