share/man/man5/manpath.config.5

   1 .\"
   2 .\" Copyright (c) 2007
   3 .\"     The DragonFly Project.  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 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in
  13 .\"    the documentation and/or other materials provided with the
  14 .\"    distribution.
  15 .\" 3. Neither the name of The DragonFly Project nor the names of its
  16 .\"    contributors may be used to endorse or promote products derived
  17 .\"    from this software without specific, prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  22 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  23 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  24 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  25 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  26 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  27 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  28 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  29 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .Dd April 25, 2007
  33 .Dt MANPATH.CONFIG 5
  34 .Os
  35 .Sh NAME
  36 .Nm manpath.config
  37 .Nd manual page search path configuration file
  38 .Sh SYNOPSIS
  39 .Pa /etc/manpath.config
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 file configures the manual page search path used by the man utilities.
  44 The environment variable
  45 .Ev MANPATH
  46 (if set) overrides this information.
  47 .Pp
  48 Empty lines or lines beginning with a
  49 .Dq #
  50 are ignored.
  51 The following keywords are recognized:
  52 .Bl -tag -width XXXXXX
  53 .It Li MANDATORY_MANPATH Ar manpath_element
  54 Each specified
  55 .Ar manpath_element
  56 will be added to the search path.
  57 .It Li OPTIONAL_MANPATH Ar manpath_element
  58 Each specified
  59 .Ar manpath_element
  60 will be added to the search path if it exists.
  61 .It Li MANPATH_MAP Ar path_element Ar manpath_element
  62 Each specified
  63 .Ar manpath_element
  64 will be added to the search path if
  65 .Ar path_element
  66 is in
  67 .Ev PATH .
  68 .\".It MANLOCALES Ar locale1 Ar locale2 Ar ...
  69 .El
  70 .Sh FILES
  71 .Bl -tag -width ".Pa /etc/manpath.config" -compact
  72 .It Pa /etc/manpath.config
  73 Configuration file for setting up the manual page search path.
  74 .El
  75 .Sh SEE ALSO
  76 .Xr manpath 1
  77 .Sh AUTHORS
  78 This manual page was written by
  79 .An Sascha Wildner .