From owner-dev-commits-doc-all@freebsd.org Mon May 24 08:56:14 2021 Return-Path: Delivered-To: dev-commits-doc-all@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id 064A3630A7E for ; Mon, 24 May 2021 08:56:14 +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 4FpWK96qTfz3m3q; Mon, 24 May 2021 08:56:13 +0000 (UTC) (envelope-from git@FreeBSD.org) 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 D32E127634; Mon, 24 May 2021 08:56:13 +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 14O8uD20080680; Mon, 24 May 2021 08:56:13 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 14O8uD8t080679; Mon, 24 May 2021 08:56:13 GMT (envelope-from git) Date: Mon, 24 May 2021 08:56:13 GMT Message-Id: <202105240856.14O8uD8t080679@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Ceri Davies Subject: git: ed1e8451a5 - main - books/handbook/basics: Use less confusing whatis(1) example. MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: ceri X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: ed1e8451a507305a18a5da67324708b9726e8e0c Auto-Submitted: auto-generated X-BeenThere: dev-commits-doc-all@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Commit messages for all branches of the doc repository List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 24 May 2021 08:56:14 -0000 The branch main has been updated by ceri: URL: https://cgit.FreeBSD.org/doc/commit/?id=ed1e8451a507305a18a5da67324708b9726e8e0c commit ed1e8451a507305a18a5da67324708b9726e8e0c Author: Ceri Davies AuthorDate: 2021-05-24 08:51:18 +0000 Commit: Ceri Davies CommitDate: 2021-05-24 08:54:27 +0000 books/handbook/basics: Use less confusing whatis(1) example. If, as suggested by the Basics chapter in the handbook, one does: % cd /usr/bin % man -f * | more the result is a number of warnings due to filenames like c++ and flex++ being treated as expressions. Two ways to handle this: 1) Explain that one should use "man -f -- *" and why; 2) Avoid the problem and use "cd /usr/sbin" instead. Option 1 is more appropriate for this stage of the handbook Approved by: blackend (mentor) --- documentation/content/en/books/handbook/basics/_index.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/content/en/books/handbook/basics/_index.adoc b/documentation/content/en/books/handbook/basics/_index.adoc index 3755b4a547..7c0c35a27c 100644 --- a/documentation/content/en/books/handbook/basics/_index.adoc +++ b/documentation/content/en/books/handbook/basics/_index.adoc @@ -1515,11 +1515,11 @@ If the name of the manual page is unknown, use `man -k` to search for keywords i This command displays a list of commands that have the keyword "mail" in their descriptions. This is equivalent to using man:apropos[1]. -To read the descriptions for all of the commands in [.filename]#/usr/bin#, type: +To read the descriptions for all of the commands in [.filename]#/usr/sbin#, type: [source,shell] .... -% cd /usr/bin +% cd /usr/sbin % man -f * | more .... @@ -1527,7 +1527,7 @@ or [source,shell] .... -% cd /usr/bin +% cd /usr/sbin % whatis * |more ....