summaryrefslogtreecommitdiffstats
path: root/man.1
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2019-03-09 15:55:01 +0000
committerIngo Schwarze <schwarze@openbsd.org>2019-03-09 15:55:01 +0000
commit1ddd5cf62b04cb63075ea1b42e2bbe230c98306b (patch)
treea5c70860235b796595c25789906d9156ee614897 /man.1
parent098c0b99417e4a5d0ceee1c29b24b097fb210e3b (diff)
downloadmandoc-1ddd5cf62b04cb63075ea1b42e2bbe230c98306b.tar.gz
Mention mandoc.db(5), makewhatis(8), and weekly(8).
Omission noticed by espie@ long ago, and wording tweaked by jmc@.
Diffstat (limited to 'man.1')
-rw-r--r--man.112
1 files changed, 12 insertions, 0 deletions
diff --git a/man.1 b/man.1
index 8c7cec71..e223d0e9 100644
--- a/man.1
+++ b/man.1
@@ -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