diff options
| author | Ingo Schwarze <schwarze@openbsd.org> | 2017-03-17 17:24:41 +0000 |
|---|---|---|
| committer | Ingo Schwarze <schwarze@openbsd.org> | 2017-03-17 17:24:41 +0000 |
| commit | 4e452a40810358cef4533a02ac18776e562a62aa (patch) | |
| tree | 7c6bf32b1aad6d2f8b2e24d344344dbd12acfead | |
| parent | 395c0aa3514c19963ae4611cde8f518707a8bb75 (diff) | |
| download | mandoc-4e452a40810358cef4533a02ac18776e562a62aa.tar.gz | |
Document man(1) section selection priority,
and correct description of apropos(1) output search order.
Suggested by tb@.
| -rw-r--r-- | apropos.1 | 25 | ||||
| -rw-r--r-- | man.1 | 6 |
2 files changed, 28 insertions, 3 deletions
@@ -1,7 +1,7 @@ .\" $Id$ .\" .\" 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 @@ -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 @@ -3,7 +3,7 @@ .\" Copyright (c) 1989, 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" Copyright (c) 2003, 2007, 2008, 2014 Jason McIntyre <jmc@openbsd.org> -.\" Copyright (c) 2010, 2011, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org> +.\" Copyright (c) 2010, 2011, 2014-2017 Ingo Schwarze <schwarze@openbsd.org> .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions @@ -234,6 +234,10 @@ System maintenance and operation commands. .It 9 Kernel internals. .El +.Pp +If not specified and a match is found in more than one section, +the first match is selected from the following list: +1, 8, 6, 2, 3, 5, 7, 4, 9, 3p. .It Fl T Ar output Select the output format. The default is |