From nobody Thu Mar 31 09:45:00 2022 X-Original-To: dev-commits-src-main@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 1981F1A4CB43; Thu, 31 Mar 2022 09:45:01 +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 4KTdgx07rpz4rvW; Thu, 31 Mar 2022 09:45:01 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1648719901; 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=V+qDj3a9NPf84wY501kJ7caRpAvYRYe0UHh9puqJxj4=; b=SDl9MSQNMBZHonSMRZZDIGXqyD7WVDUKU1U++tjCvBAfKC5IqFlgx6j0ZZIBl3+qLjrfT2 ViKKAJoAauQbxil/ZueCRGL1aKF9RIyvmPbqFAZYdiZ5D2iopTRWl2RSWHokT8PM9YNzVA jMhWXwVLosWx8u/JmPuEjZbm0u0e5/VYIj3hZGx0bPWxpdzPSszBSpEqq4+YLl8HXdRX95 751eZ2W+LMiVdVuVIXzsFhStYIH0DVna9CyBfYYCtF+j6dVQF7bVXSs/XFcD4akjHxdVtQ ZIyePf6JuE8OKN9S8FO3uK4Ocq8wx3m8iSRWPGY77/YDaBGwEBNnGj76SRgh6g== 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 D8F982549A; Thu, 31 Mar 2022 09:45:00 +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 22V9j0Z3082437; Thu, 31 Mar 2022 09:45:00 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 22V9j0TR082436; Thu, 31 Mar 2022 09:45:00 GMT (envelope-from git) Date: Thu, 31 Mar 2022 09:45:00 GMT Message-Id: <202203310945.22V9j0TR082436@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Mateusz Piotrowski <0mp@FreeBSD.org> Subject: git: ad8cac1229bf - main - ifconfig.8: Improve readability of address_family documentation List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-main@freebsd.org X-BeenThere: dev-commits-src-main@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/main X-Git-Reftype: branch X-Git-Commit: ad8cac1229bf8ca9d26435e2293c34127c01ff51 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1648719901; 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=V+qDj3a9NPf84wY501kJ7caRpAvYRYe0UHh9puqJxj4=; b=hGKPdFst4DedpG5aoWKShABK94vyv4/phb5tA/ZQIwxRrQCia76LlnGplJ2iV0CtG8ZZoH 7OZxDaYuqg+HGpG29yzS6u3zjnOyocafr8KEdKwVqvHIjSdjNq2JvfVPYP1GXEHThtBIVN 0JtU97+aLx4ecPIg7fHGlwuLCPFIvxqp+cH1VWHKb+bATYQFwFIvu5CYd+m3YIOTexv8v/ 2mLmlXaljWGb778oHPCTR/WUygwzk5ANQ/KtTwpmRfUNTe6j67Pp9fvJmkO+MXWh2QJlrH 8jh5D/biyWYaIXgQy/+tYq7J2KIJrlCNB34AlAX3Welgs1js1xgRl6aKk5DvsA== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1648719901; a=rsa-sha256; cv=none; b=G9jc1FT28Mqp0GUg/ZwH6bqeJFcp+s2xrXoJdyn9lbopdIf6IwOTwgitfLFb0nB4AjNdzI 1tcinX+ss60gmWj8VS/6Xe+iR5bYpRg+k/59fx0dAQ9gLRk3dDMnTHBmV9FRru2XE+r4V6 02VsXtse92l/pCbuF+8oC9C8kOYGFg0VQSki0AUhuHcwzpik61Kq6nM3MyHevsGySnarVa haaiOiZW6BpKiX9WLDGc4P0zrYuOJZJpd8Q1gl+iCf2RbZzp15J/Add11G0XcvWRgs8DOg F35IlPFRPem2RtQjqAtzCCAa+DHloh/HT1/uc60lSkv5x1jEucja3gduelPhTg== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N 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.