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
39 file is used to configure the manual search path, locales, and utility set for
41 and its related utilities.
42 During initialization,
44 reads the configuration files located at
45 .Pa /usr/local/etc/man.d/*.conf
49 The files contained in
50 .Pa /usr/local/etc/man.d/*.conf
51 are intended to be used by the
53 system for extending the manual set to support additional paths and locales.
55 is intended to be used by the local administrator to set additional policy.
57 Currently supported configuration variables include:
58 .Bl -tag -width 12n -offset indent
60 Overrides the default location to import additional manual configuration files.
62 .Pa /usr/local/etc/man.d/*.conf .
64 Adds the specified directory to the manual search path.
66 Indicates support is available for the given locale.
69 For pages in a given language, overriding the default toolset for
70 display is supported via the following definitions:
72 .Bl -tag -width 12n -offset indent -compact
73 .It EQN Ns _ Ns Va LANG
74 .It NROFF Ns _ Ns Va LANG
75 .It PIC Ns _ Ns Va LANG
76 .It TBL Ns _ Ns Va LANG
77 .It TROFF Ns _ Ns Va LANG
78 .It REFER Ns _ Ns Va LANG
79 .It VGRIND Ns _ Ns Va LANG
84 section for how to use these variables.
85 .Sh IMPLEMENTATION NOTES
86 The parser used for this utility is very basic and only supports comment
87 characters (#) at the beginning of a line.
89 .Bl -tag -width "Pa /usr/local/etc/man.d/*.conf" -compact
91 System configuration file.
92 .It Pa /usr/local/etc/man.d/*.conf
93 Local configuration files.
96 A perl port that needs to install additional manual pages outside of the
97 default location could install a file in
98 .Pa /usr/local/etc/man.d/perl.conf
99 with the following contents:
100 .Bd -literal -offset indent
101 # Add perl man pages to search path
102 MANPATH /usr/local/lib/perl5/5.8.9/man
103 MANPATH /usr/local/lib/perl5/5.8.9/perl/man
106 A Japanese localization port could install a custom toolset and include a
108 .Pa /usr/local/etc/man.d/ja-man-doc.conf
109 with the following contents:
110 .Bd -literal -offset indent
111 # Setup Japanese toolset
112 MANLOCALE ja_JP.eucJP
113 EQN_JA /usr/local/bin/geqn
114 PIC_JA /usr/local/bin/gpic
115 TBL_JA /usr/local/bin/gtbl
116 NROFF_JA /usr/local/bin/groff -man -dlang=ja_JP.eucJP
117 TROFF_JA /usr/local/bin/groff -man -dlang=ja_JP.euc.jp
120 If the system administrator decides to override the
129 specifying the following in
131 will accommodate this change:
132 .Bd -literal -offset indent
133 # Look for additional configuration files
134 MANCONFIG /opt/etc/man.d/*.conf