* mdocml: various tweaks from jmc@
@ 2015-03-27 16:29 schwarze
0 siblings, 0 replies; only message in thread
From: schwarze @ 2015-03-27 16:29 UTC (permalink / raw)
To: source
Log Message:
-----------
various tweaks from jmc@
Modified Files:
--------------
mdocml:
man.conf.5
Revision Data
-------------
Index: man.conf.5
===================================================================
RCS file: /home/cvs/mdocml/mdocml/man.conf.5,v
retrieving revision 1.1
retrieving revision 1.2
diff -Lman.conf.5 -Lman.conf.5 -u -p -r1.1 -r1.2
--- man.conf.5
+++ man.conf.5
@@ -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
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 unfor
.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
--
To unsubscribe send an email to source+unsubscribe@mdocml.bsd.lv
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2015-03-27 16:29 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2015-03-27 16:29 mdocml: various tweaks from jmc@ 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).