From owner-dev-commits-src-main@freebsd.org Sat Jan 9 17:06:32 2021 Return-Path: Delivered-To: dev-commits-src-main@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 5E8514DCD24; Sat, 9 Jan 2021 17:06:32 +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 "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4DCmbD2DPZz3jnF; Sat, 9 Jan 2021 17:06:32 +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 3F7A8196E2; Sat, 9 Jan 2021 17:06:32 +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 109H6W1P006947; Sat, 9 Jan 2021 17:06:32 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 109H6Wks006946; Sat, 9 Jan 2021 17:06:32 GMT (envelope-from git) Date: Sat, 9 Jan 2021 17:06:32 GMT Message-Id: <202101091706.109H6Wks006946@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Fernando Apesteguía Subject: git: df965a6829f0 - main - man(1): Add EXAMPLES section MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: fernape X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: df965a6829f058b7a9999c39bc229616520645c2 Auto-Submitted: auto-generated X-BeenThere: dev-commits-src-main@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Commit messages for the main branch of the src repository List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 09 Jan 2021 17:06:32 -0000 The branch main has been updated by fernape (ports committer): URL: https://cgit.FreeBSD.org/src/commit/?id=df965a6829f058b7a9999c39bc229616520645c2 commit df965a6829f058b7a9999c39bc229616520645c2 Author: Fernando Apesteguía AuthorDate: 2021-01-09 16:55:21 +0000 Commit: Fernando Apesteguía CommitDate: 2021-01-09 16:57:47 +0000 man(1): Add EXAMPLES section Add some examples showing the use of the flags: a, k, P, w Reviewed by: gbe@, yuripv@ Approved by: manpages (gbe@) Differential Revision: https://reviews.freebsd.org/D27545 --- usr.bin/man/man.1 | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/usr.bin/man/man.1 b/usr.bin/man/man.1 index 89bef50d718a..79821c405416 100644 --- a/usr.bin/man/man.1 +++ b/usr.bin/man/man.1 @@ -357,6 +357,41 @@ Local configuration files. .El .Sh EXIT STATUS .Ex -std +.Sh EXAMPLES +Show the manual page for +.Xr stat 2 : +.Bd -literal -offset indent +$ man 2 stat +.Ed +.Pp +Show all manual pages for +.Ql stat . +.Bd -literal -offset indent +$ man -a stat +.Ed +.Pp +List manual pages which match the regular expression either in the title or in +the body: +.Bd -literal -offset indent +$ man -k '\e.*archive' +.Ed +.Pp +Show the manual page for +.Xr ls 1 +and use +.Xr cat 1 +as pager: +.Bd -literal -offset indent +$ man -P cat ls +.Ed +.Pp +Show the location of the +.Xr ls 1 +manual page: +.Bd -literal -offset indent +$ man -w ls +.Ed +.Pp .Sh SEE ALSO .Xr apropos 1 , .Xr intro 1 ,