usr.bin/man/man.conf.5

   1 .\"-
   2 .\"  Copyright (c) 2010 Gordon Tetlow
   3 .\"  All rights reserved.
   4 .\"
   5 .\"  Redistribution and use in source and binary forms, with or without
   6 .\"  modification, are permitted provided that the following conditions
   7 .\"  are met:
   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.
  13 .\"
  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
  24 .\"  SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd June 3, 2011
  29 .Os
  30 .Dt MAN.CONF 5
  31 .Sh NAME
  32 .Nm man.conf
  33 .Nd
  34 .Xr man 1
  35 and
  36 .Xr manpath 1
  37 configuration files
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 file is used to configure the manual search path, locales, and utility set for
  42 .Xr man 1
  43 and its related utilities.
  44 During initialization,
  45 .Xr man 1
  46 reads the configuration files located at
  47 .Pa /usr/local/etc/man.d/*.conf
  48 and
  49 .Pa /etc/man.conf .
  50 .Pp
  51 The files contained in
  52 .Pa /usr/local/etc/man.d/*.conf
  53 are intended to be used by the
  54 .Xr ports 7
  55 system for extending the manual set to support additional paths and locales.
  56 .Pa /etc/man.conf
  57 is intended to be used by the local administrator to set additional policy.
  58 .Pp
  59 Currently supported configuration variables include:
  60 .Bl -tag -offset indent
  61 .It MANCONFIG
  62 Overrides the default location to import additional manual configuration files.
  63 Defaults to
  64 .Pa /usr/local/etc/man.d/*.conf .
  65 .It MANPATH
  66 Adds the specified directory to the manual search path.
  67 .It MANLOCALE
  68 Indicates support is available for the given locale.
  69 .El
  70 .Pp
  71 For pages in a given language, overriding the default toolset for
  72 display is supported via the following definitions:
  73 .Bl -tag -offset indent -compact
  74 .It EQN Ns _ Ns Va LANG
  75 .It NROFF Ns _ Ns Va LANG
  76 .It PIC Ns _ Ns Va LANG
  77 .It TBL Ns _ Ns Va LANG
  78 .It TROFF Ns _ Ns Va LANG
  79 .It REFER Ns _ Ns Va LANG
  80 .It VGRIND Ns _ Ns Va LANG
  81 .El
  82 .Pp
  83 See the
  84 .Sx EXAMPLES
  85 section for how to use these variables.
  86 .Sh IMPLEMENTATION NOTES
  87 The parser used for this utility is very basic and only supports comment
  88 characters (#) at the beginning of a line.
  89 .Sh FILES
  90 .Bl -tag -compact
  91 .It Pa /etc/man.conf
  92 System configuration file.
  93 .It Pa /usr/local/etc/man.d/*.conf
  94 Local configuration files.
  95 .El
  96 .Sh EXAMPLES
  97 A perl port that needs to install additional manual pages outside of the
  98 default location could install a file in
  99 .Pa /usr/local/etc/man.d/perl.conf
 100 with the following contents:
 101 .Bd -literal -offset indent
 102 # Add perl man pages to search path
 103 MANPATH /usr/local/lib/perl5/5.8.9/man
 104 MANPATH /usr/local/lib/perl5/5.8.9/perl/man
 105 .Ed
 106 .Pp
 107 A Japanese localization port could install a custom toolset and include a
 108 file in
 109 .Pa /usr/local/etc/man.d/ja-man-doc.conf
 110 with the following contents:
 111 .Bd -literal -offset indent
 112 # Setup Japanese toolset
 113 MANLOCALE       ja_JP.eucJP
 114 EQN_JA          /usr/local/bin/geqn
 115 PIC_JA          /usr/local/bin/gpic
 116 TBL_JA          /usr/local/bin/gtbl
 117 NROFF_JA        /usr/local/bin/groff -man -dlang=ja_JP.eucJP
 118 TROFF_JA        /usr/local/bin/groff -man -dlang=ja_JP.euc.jp
 119 .Ed
 120 .Pp
 121 If the system administrator decides to override the
 122 .Va LOCALBASE
 123 .Xr make 1
 124 variable causing all
 125 .Xr ports 7
 126 to be installed into
 127 .Pa /opt
 128 instead of
 129 .Pa /usr/local ,
 130 specifying the following in
 131 .Pa /etc/man.conf
 132 will accommodate this change:
 133 .Bd -literal -offset indent
 134 # Look for additional configuration files
 135 MANCONFIG /opt/etc/man.d/*.conf
 136 .Ed
 137 .Sh SEE ALSO
 138 .Xr apropos 1 ,
 139 .Xr man 1 ,
 140 .Xr manpath 1 ,
 141 .Xr whatis 1