aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/apropos.1
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2017-03-17 17:24:41 +0000
committerIngo Schwarze <schwarze@openbsd.org>2017-03-17 17:24:41 +0000
commitfb2fb4535d4dea6392efb9685eab56a2da9844c6 (patch)
tree907209071c890e8bed4bf6109d7e6772737cef07 /apropos.1
parentce039f71a1b3f3aa23348424b7b99fcb59c67197 (diff)
downloadmandoc-fb2fb4535d4dea6392efb9685eab56a2da9844c6.tar.gz
mandoc-fb2fb4535d4dea6392efb9685eab56a2da9844c6.tar.zst
mandoc-fb2fb4535d4dea6392efb9685eab56a2da9844c6.zip
Document man(1) section selection priority,
and correct description of apropos(1) output search order. Suggested by tb@.
Diffstat (limited to 'apropos.1')
-rw-r--r--apropos.129
1 files changed, 25 insertions, 4 deletions
diff --git a/apropos.1 b/apropos.1
index 8f51030e..e3acec96 100644
--- a/apropos.1
+++ b/apropos.1
@@ -1,7 +1,7 @@
-.\" $Id: apropos.1,v 1.40 2017/01/31 19:44:04 schwarze Exp $
+.\" $Id: apropos.1,v 1.41 2017/03/17 17:24:41 schwarze Exp $
.\"
.\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
-.\" Copyright (c) 2011, 2012, 2014 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2011, 2012, 2014, 2017 Ingo Schwarze <schwarze@openbsd.org>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
@@ -15,7 +15,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: January 31 2017 $
+.Dd $Mdocdate: March 17 2017 $
.Dt APROPOS 1
.Os
.Sh NAME
@@ -237,7 +237,28 @@ is evaluated case-insensitively.
Has no effect on substring terms.
.El
.Pp
-Results are sorted by manual sections and names, with output formatted as
+Results are sorted according to the following criteria:
+.Bl -enum
+.It
+The manpath directory tree the page is found in, according to the
+order specified with
+.Fl M ,
+.Fl m ,
+the
+.Ev MANPATH
+environment variable, the
+.Xr man.conf 5
+configuration file, or the default documented in
+.Xr man.conf 5 .
+.It
+The section number in ascending numerical order.
+.It
+The page name in ascending
+.Xr ascii 7
+alphabetical order, case-insensitive.
+.El
+.Pp
+Each output line is formatted as
.Pp
.D1 name[, name...](sec) \- description
.Pp