source@mandoc.bsd.lv
 help / color / mirror / Atom feed
* mandoc: Mention mandoc.db(5), makewhatis(8), and weekly(8).
@ 2019-03-09 15:55 schwarze
  0 siblings, 0 replies; only message in thread
From: schwarze @ 2019-03-09 15:55 UTC (permalink / raw)
  To: source

Log Message:
-----------
Mention mandoc.db(5), makewhatis(8), and weekly(8).
Omission noticed by espie@ long ago, and wording tweaked by jmc@.

Modified Files:
--------------
    mandoc:
        man.1

Revision Data
-------------
Index: man.1
===================================================================
RCS file: /home/cvs/mandoc/mandoc/man.1,v
retrieving revision 1.34
retrieving revision 1.35
diff -Lman.1 -Lman.1 -u -p -r1.34 -r1.35
--- man.1
+++ 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
--
 To unsubscribe send an email to source+unsubscribe@mandoc.bsd.lv

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2019-03-09 15:55 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-03-09 15:55 mandoc: Mention mandoc.db(5), makewhatis(8), and weekly(8) schwarze

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).