2 .\" Copyright (c) 2010 Gordon Tetlow
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" $FreeBSD: head/usr.bin/man/man.conf.5 236508 2012-06-03 11:09:51Z joel $
41 file is used to configure the manual search path, locales, and utility set for
43 and its related utilities.
44 During initialization,
46 reads the configuration files located at
47 .Pa /usr/local/etc/man.d/*.conf
51 The files contained in
52 .Pa /usr/local/etc/man.d/*.conf
53 are intended to be used by the
55 system for extending the manual set to support additional paths and locales.
57 is intended to be used by the local administrator to set additional policy.
59 Currently supported configuration variables include:
60 .Bl -tag -width 12n -offset indent
62 Overrides the default location to import additional manual configuration files.
64 .Pa /usr/local/etc/man.d/*.conf .
66 Adds the specified directory to the manual search path.
68 Indicates support is available for the given locale.
71 For pages in a given language, overriding the default toolset for
72 display is supported via the following definitions:
74 .Bl -tag -width 12n -offset indent -compact
75 .It EQN Ns _ Ns Va LANG
76 .It NROFF Ns _ Ns Va LANG
77 .It PIC Ns _ Ns Va LANG
78 .It TBL Ns _ Ns Va LANG
79 .It TROFF Ns _ Ns Va LANG
80 .It REFER Ns _ Ns Va LANG
81 .It VGRIND Ns _ Ns Va LANG
86 section for how to use these variables.
87 .Sh IMPLEMENTATION NOTES
88 The parser used for this utility is very basic and only supports comment
89 characters (#) at the beginning of a line.
91 .Bl -tag -width "Pa /usr/local/etc/man.d/*.conf" -compact
93 System configuration file.
94 .It Pa /usr/local/etc/man.d/*.conf
95 Local configuration files.
98 A perl port that needs to install additional manual pages outside of the
99 default location could install a file in
100 .Pa /usr/local/etc/man.d/perl.conf
101 with the following contents:
102 .Bd -literal -offset indent
103 # Add perl man pages to search path
104 MANPATH /usr/local/lib/perl5/5.8.9/man
105 MANPATH /usr/local/lib/perl5/5.8.9/perl/man
108 A Japanese localization port could install a custom toolset and include a
110 .Pa /usr/local/etc/man.d/ja-man-doc.conf
111 with the following contents:
112 .Bd -literal -offset indent
113 # Setup Japanese toolset
114 MANLOCALE ja_JP.eucJP
115 EQN_JA /usr/local/bin/geqn
116 PIC_JA /usr/local/bin/gpic
117 TBL_JA /usr/local/bin/gtbl
118 NROFF_JA /usr/local/bin/groff -man -dlang=ja_JP.eucJP
119 TROFF_JA /usr/local/bin/groff -man -dlang=ja_JP.euc.jp
122 If the system administrator decides to override the
131 specifying the following in
133 will accommodate this change:
134 .Bd -literal -offset indent
135 # Look for additional configuration files
136 MANCONFIG /opt/etc/man.d/*.conf