Module Name: src
Committed By: gutteridge
Date: Sat Jun 18 02:19:07 UTC 2022
Modified Files:
src/usr.bin/man: man.conf.5
Log Message:
man.conf.5: add details about the machine line and search order
Also, tweak some grammar, style, and markup while here.
To generate a diff of this commit:
cvs rdiff -u -r1.27 -r1.28 src/usr.bin/man/man.conf.5
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/usr.bin/man/man.conf.5
diff -u src/usr.bin/man/man.conf.5:1.27 src/usr.bin/man/man.conf.5:1.28
--- src/usr.bin/man/man.conf.5:1.27 Thu Jun 16 15:11:43 2016
+++ src/usr.bin/man/man.conf.5 Sat Jun 18 02:19:07 2022
@@ -1,4 +1,4 @@
-.\" $NetBSD: man.conf.5,v 1.27 2016/06/16 15:11:43 abhinav Exp $
+.\" $NetBSD: man.conf.5,v 1.28 2022/06/18 02:19:07 gutteridge Exp $
.\"
.\" Copyright (c) 1989, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
@@ -29,7 +29,7 @@
.\"
.\" @(#)man.conf.5 8.5 (Berkeley) 1/2/94
.\"
-.Dd June 16, 2016
+.Dd June 18, 2022
.Dt MAN.CONF 5
.Os
.Sh NAME
@@ -45,8 +45,9 @@ file contains the default configuration
.Xr catman 8 ,
and
.Xr makemandb 8
-to find manual pages and information about manual pages (e.g. the
-whatis database).
+to find manual pages and information about manual pages (e.g., the
+.Xr whatis 1
+database).
.Pp
Manual pages are located by searching an ordered set of directories
called the
@@ -106,8 +107,9 @@ be replaced by the name of the file whic
Used by
.Xr catman 8
to determine how to crunch formatted pages
-which originally were compressed man pages: The first field lists a suffix
-which indicates what kind of compression were used to compress the man page.
+which originally were compressed man pages.
+The first field lists a suffix which indicates what kind of compression was
+used to compress the man page.
The rest of the line must be a shell command line, used to compress the
formatted pages.
There should be exactly one occurrence of the string
@@ -159,13 +161,15 @@ Contains the version of the configuratio
.It _ Ns Aq machine
Defines additional paths to be searched for the particular
.Dv machine
-whose literal value is taken from
+hardware name whose literal value is taken from
.Xr uname 1
.Fl m .
For example on an
.Dv amd64 ,
.Dv _amd64
-is used.
+is used, where
+.Dq x86
+is commonly supplied as an alternate machine path to also search.
.El
.Pp
Section configuration lines in
@@ -184,7 +188,7 @@ Section keywords must not start with the
character.
.Pp
A section path may contain either a list of absolute directories or
-a list of or relative directories (but not both).
+a list of relative directories (but not both).
Relative directory paths are treated as a list of subdirectories that
are appended to the current man path directory being searched.
Section configuration lines with absolute directory paths (starting with
@@ -206,7 +210,8 @@ In addition to the above rules, the
.Xr man 1
command also always checks in each directory that it searches for
a subdirectory with the same name as the current machine type.
-If the machine-specific directory is found, it is also searched.
+If a machine-specific subdirectory is found, it is also searched
+before the parent directory is.
This allows the manual to contain machine-specific man pages.
Note that the machine subdirectory does not need to be specified
in the
