usr.bin/man/manpath.1

   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 September 1, 2010
  29 .Dt MANPATH 1
  30 .Os
  31 .Sh NAME
  32 .Nm manpath
  33 .Nd display search path for manual pages
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Fl Ldq
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 utility determines the user's manual search path from
  41 the user's
  42 .Ev PATH ,
  43 and local configuration files.
  44 This result is echoed to the standard output.
  45 .Bl -tag -width ".Fl d"
  46 .It Fl L
  47 Output manual locales list instead of the manual path.
  48 .It Fl d
  49 Print extra debugging information.
  50 .It Fl q
  51 Suppresses warning messages.
  52 .El
  53 .Sh IMPLEMENTATION NOTES
  54 The
  55 .Nm
  56 utility constructs the manual path from two sources:
  57 .Bl -enum -compact
  58 .It
  59 From each component of the user's
  60 .Ev PATH
  61 for the first of:
  62 .Bl -dash -compact
  63 .It
  64 .Pa pathname/man
  65 .It
  66 .Pa pathname/MAN
  67 .It
  68 If pathname ends with /bin:
  69 .Pa pathname/../man
  70 .El
  71 Note: Special logic exists to make
  72 .Pa /bin
  73 and
  74 .Pa /usr/bin
  75 look in
  76 .Pa /usr/share/man
  77 for manual files.
  78 .It
  79 The configuration files listed in the
  80 .Sx FILES
  81 section for
  82 .Va MANPATH
  83 entries.
  84 .El
  85 The information from these locations is then concatenated together.
  86 .Pp
  87 If the
  88 .Fl L
  89 flag is set, the
  90 .Nm
  91 utility will search the configuration files listed in the
  92 .Sx FILES
  93 section for
  94 .Va MANLOCALE
  95 entries.
  96 .Sh ENVIRONMENT
  97 The following environment variables affect the execution of
  98 .Nm :
  99 .Bl -tag -width ".Ev MANLOCALES"
 100 .It Ev MANLOCALES
 101 If set with the
 102 .Fl L
 103 flag, causes the utility to display a warning and the value, overriding any
 104 other configuration found on the system.
 105 .It Ev MANPATH
 106 If set, causes the utility to display a warning and the value, overriding
 107 any other configuration found on the system.
 108 .It Ev PATH
 109 Influences the manual path as described in the
 110 .Sx IMPLEMENTATION NOTES .
 111 .El
 112 .Sh FILES
 113 .Bl -tag -width indent -compact
 114 .It Pa /etc/man.conf
 115 System configuration file.
 116 .It Pa /usr/local/etc/man.d/*.conf
 117 Local configuration files.
 118 .El
 119 .Sh SEE ALSO
 120 .Xr apropos 1 ,
 121 .Xr man 1 ,
 122 .Xr whatis 1 ,
 123 .Xr man.conf 5