do not crash when a manpath directory contains a symbolic link

[mandoc.git] / man.conf.5

diff --git a/man.conf.5 b/man.conf.5
index 9cfeca761d3b3b65ce3873f405f558047bf2cc5b..ffe9fcc070580078819252eb1b7fe30bfdc773db 100644 (file)
--- a/man.conf.5
+++ b/man.conf.5
@@ -1,6 +1,6 @@
-.\"    $Id: man.conf.5,v 1.3 2015/03/27 21:33:20 schwarze Exp $
+.\"    $Id: man.conf.5,v 1.8 2020/02/10 14:42:10 schwarze Exp $
 .\"
-.\" Copyright (c) 2015 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2015, 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
@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: March 27 2015 $
+.Dd $Mdocdate: February 10 2020 $
 .Dt MAN.CONF 5
 .Os
 .Sh NAME
@@ -74,8 +74,12 @@ in each directory configured with
 .Ic manpath
 is recommended and necessary for
 .Xr apropos 1
-to work, but not strictly required for
-.Xr man 1 .
+to work, and also for
+.Xr man 1
+on operating systems like
+.Ox
+that install each manual page with only one file name in the file system,
+even if it documents multiple utilities or functions.
 .It Ic output Ar option Op Ar value
 Configure the default value of an output option.
 These directives are overridden by the
@@ -91,20 +95,17 @@ manual.
 .It Ic fragment Ta none     Ta Cm html Ta print only body
 .It Ic includes Ta string   Ta Cm html Ta path to header files
 .It Ic indent   Ta integer  Ta Cm ascii , utf8 Ta left margin
-.It Ic man      Ta string   Ta Cm html Ta path for Xr links
+.It Ic man      Ta string   Ta Cm html Ta path for \&Xr links
 .It Ic paper    Ta string   Ta Cm ps , pdf Ta paper size
 .It Ic style    Ta string   Ta Cm html Ta CSS file
+.It Ic toc      Ta none     Ta Cm html Ta print table of contents
 .It Ic width    Ta integer  Ta Cm ascii , utf8 Ta right margin
 .El
-.It Ic _whatdb Ar path Ns Cm /whatis.db
-This directive provides the same functionality as
-.Ic manpath ,
-but using a historic and misleading syntax.
-It is kept for backward compatibility for now,
-but will eventually be removed.
 .El
 .Sh FILES
-.Pa /etc/man.conf
+.Bl -tag -width /etc/examples/man.conf -compact
+.It Pa /etc/man.conf
+.El
 .Sh EXAMPLES
 The following configuration file reproduces the defaults:
 installing it is equivalent to not having a