diff options
author | Ingo Schwarze <schwarze@openbsd.org> | 2019-03-09 15:55:01 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@openbsd.org> | 2019-03-09 15:55:01 +0000 |
commit | 96b26b75942ef3682636c79b488427f342f8b6a6 (patch) | |
tree | 79ba6d5a3ecb9ed665a9b6575c20c427ce495796 | |
parent | 1ad214e72a67273b33eef629660002907d4b2dc7 (diff) | |
download | mandoc-96b26b75942ef3682636c79b488427f342f8b6a6.tar.gz mandoc-96b26b75942ef3682636c79b488427f342f8b6a6.tar.zst mandoc-96b26b75942ef3682636c79b488427f342f8b6a6.zip |
Mention mandoc.db(5), makewhatis(8), and weekly(8).
Omission noticed by espie@ long ago, and wording tweaked by jmc@.
-rw-r--r-- | man.1 | 16 |
1 files changed, 14 insertions, 2 deletions
@@ -1,4 +1,4 @@ -.\" $Id: man.1,v 1.34 2018/11/22 11:30:23 schwarze Exp $ +.\" $Id: man.1,v 1.35 2019/03/09 15:55:01 schwarze Exp $ .\" .\" Copyright (c) 1989, 1990, 1993 .\" The Regents of the University of California. All rights reserved. @@ -31,7 +31,7 @@ .\" .\" @(#)man.1 8.2 (Berkeley) 1/2/94 .\" -.Dd $Mdocdate: November 22 2018 $ +.Dd $Mdocdate: March 9 2019 $ .Dt MAN 1 .Os .Sh NAME @@ -218,12 +218,24 @@ Guidelines for writing man pages can be found in .Xr mdoc 7 . .Pp +The +.Xr mandoc.db 5 +database is used for looking up manual page entries. +In cases where the database is absent, outdated, or corrupt, +.Nm +falls back to looking for files called +.Ar name . Ns Ar section . If both a formatted and an unformatted version of the same manual page, for example .Pa cat1/foo.0 and .Pa man1/foo.1 , exist in the same directory, only the unformatted version is used. +The database is kept up to date with +.Xr makewhatis 8 , +which is run by the +.Xr weekly 8 +maintenance script. .Sh ENVIRONMENT .Bl -tag -width MANPATHX .It Ev MACHINE |