Annotation of mandoc/man.conf.5, Revision 1.2
1.2 ! schwarze 1: .\" $Id: man.conf.5,v 1.1 2015/03/27 00:18:14 schwarze Exp $
1.1 schwarze 2: .\"
3: .\" Copyright (c) 2015 Ingo Schwarze <schwarze@openbsd.org>
4: .\"
5: .\" Permission to use, copy, modify, and distribute this software for any
6: .\" purpose with or without fee is hereby granted, provided that the above
7: .\" copyright notice and this permission notice appear in all copies.
8: .\"
9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16: .\"
1.2 ! schwarze 17: .Dd $Mdocdate: March 27 2015 $
1.1 schwarze 18: .Dt MAN.CONF 5
19: .Os
20: .Sh NAME
21: .Nm man.conf
1.2 ! schwarze 22: .Nd configuration file for man
1.1 schwarze 23: .Sh DESCRIPTION
1.2 ! schwarze 24: This is the configuration file
! 25: for the
1.1 schwarze 26: .Xr man 1 ,
27: .Xr apropos 1 ,
28: and
29: .Xr makewhatis 8
30: utilities.
1.2 ! schwarze 31: Its presence, and all directives, are optional.
1.1 schwarze 32: .Pp
33: This file is an ASCII text file.
34: Leading whitespace on lines, lines starting with
35: .Sq # ,
36: and blank lines are ignored.
37: Words are separated by whitespace.
38: The first word on each line is the name of a configuration directive.
39: .Pp
40: The following directives are supported:
41: .Bl -tag -width Ds
42: .It Ic manpath Ar path
1.2 ! schwarze 43: Override the default search
1.1 schwarze 44: .Ar path
1.2 ! schwarze 45: for
1.1 schwarze 46: .Xr man 1 ,
47: .Xr apropos 1 ,
48: and
1.2 ! schwarze 49: .Xr makewhatis 8 .
! 50: It can be used multiple times to specify multiple paths,
! 51: with the order determining the manual page search order.
! 52: .Pp
! 53: Each path is a tree containing subdirectories
1.1 schwarze 54: whose names consist of the strings
55: .Sq man
56: and/or
57: .Sq cat
58: followed by the names of sections, usually single digits.
59: The former are supposed to contain unformatted manual pages in
60: .Xr mdoc 7
61: and/or
62: .Xr man 7
1.2 ! schwarze 63: format; file names should end with the name of the section
1.1 schwarze 64: preceded by a dot.
1.2 ! schwarze 65: The latter should contain preformatted manual pages;
! 66: file names should end with
1.1 schwarze 67: .Ql .0 .
1.2 ! schwarze 68: .Pp
1.1 schwarze 69: Creating a
70: .Xr mandoc.db 5
71: database with
72: .Xr makewhatis 8
73: in each directory configured with
74: .Ic manpath
75: is recommended and necessary for
76: .Xr apropos 1
77: to work, but not strictly required for
78: .Xr man 1 .
79: .It Ic _whatdb Ar path Ns Cm /whatis.db
80: This directive provides the same functionality as
81: .Ic manpath ,
82: but using a historic and misleading syntax.
83: It is kept for backward compatibility for now,
84: but will eventually be removed.
85: .El
86: .Sh FILES
87: .Pa /etc/man.conf
88: .Sh EXAMPLES
89: The following configuration file reproduces the defaults:
1.2 ! schwarze 90: installing it is equivalent to not having a
1.1 schwarze 91: .Nm
1.2 ! schwarze 92: file at all.
1.1 schwarze 93: .Bd -literal -offset indent
94: manpath /usr/share/man
95: manpath /usr/X11R6/man
96: manpath /usr/local/man
97: .Ed
98: .Sh SEE ALSO
99: .Xr apropos 1 ,
100: .Xr man 1 ,
101: .Xr makewhatis 8
102: .Sh HISTORY
103: A relatively complicated
104: .Nm
105: file format first appeared in
106: .Bx 4.3 Reno .
107: For
108: .Ox 5.8 ,
109: it was redesigned from scratch, aiming for simplicity.
110: .Sh AUTHORS
111: .An Ingo Schwarze Aq Mt schwarze@openbsd.org
CVSweb