diff options
author | Ingo Schwarze <schwarze@openbsd.org> | 2015-03-27 16:28:55 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@openbsd.org> | 2015-03-27 16:28:55 +0000 |
commit | f4674f189e73d3471e680d5e2e96f4d9fef24845 (patch) | |
tree | da97a3978438cae9c4d074463c63cfb132e74fc2 /man.conf.5 | |
parent | 7827ba1ba26dda3e4bc7021fe7c65b01fdaad347 (diff) | |
download | mandoc-f4674f189e73d3471e680d5e2e96f4d9fef24845.tar.gz |
various tweaks from jmc@
Diffstat (limited to 'man.conf.5')
-rw-r--r-- | man.conf.5 | 41 |
1 files changed, 17 insertions, 24 deletions
@@ -19,18 +19,16 @@ .Os .Sh NAME .Nm man.conf -.Nd configuration file for man(1) +.Nd configuration file for man .Sh DESCRIPTION -The -.Nm -configuration file allows to specify non-standard directory trees -for use by the +This is the configuration file +for the .Xr man 1 , .Xr apropos 1 , and .Xr makewhatis 8 utilities. -Its presence and all directives are optional. +Its presence, and all directives, are optional. .Pp This file is an ASCII text file. Leading whitespace on lines, lines starting with @@ -42,15 +40,17 @@ The first word on each line is the name of a configuration directive. The following directives are supported: .Bl -tag -width Ds .It Ic manpath Ar path -Specify that the absolute +Override the default search .Ar path -contains a tree of manual pages, and that +for .Xr man 1 , .Xr apropos 1 , and -.Xr makewhatis 8 -shall use it by default. -Each such tree is supposed to contain subdirectories +.Xr makewhatis 8 . +It can be used multiple times to specify multiple paths, +with the order determining the manual page search order. +.Pp +Each path is a tree containing subdirectories whose names consist of the strings .Sq man and/or @@ -60,11 +60,12 @@ The former are supposed to contain unformatted manual pages in .Xr mdoc 7 and/or .Xr man 7 -format; file names are supposed to end with the name of the section +format; file names should end with the name of the section preceded by a dot. -The latter are supposed to contain preformatted manual pages; -file names are supposed to end with +The latter should contain preformatted manual pages; +file names should end with .Ql .0 . +.Pp Creating a .Xr mandoc.db 5 database with @@ -75,14 +76,6 @@ is recommended and necessary for .Xr apropos 1 to work, but not strictly required for .Xr man 1 . -.Pp -Specifying at least one -.Ic manpath -directive does not append to the default search path -but instead overrides it. -The order of -.Ic manpath -directives determines the manual page search order. .It Ic _whatdb Ar path Ns Cm /whatis.db This directive provides the same functionality as .Ic manpath , @@ -94,9 +87,9 @@ but will eventually be removed. .Pa /etc/man.conf .Sh EXAMPLES The following configuration file reproduces the defaults: -Installing it is equivalent to not having a file +installing it is equivalent to not having a .Nm -at all. +file at all. .Bd -literal -offset indent manpath /usr/share/man manpath /usr/X11R6/man |