gnu/usr.bin/man/manpath/manpath.man

   1 .\" Man page for manpath
   2 .\"
   3 .\" Copyright (c) 1990, 1991, John W. Eaton.
   4 .\"
   5 .\" You may distribute under the terms of the GNU General Public
   6 .\" License as specified in the README file that comes with the man 1.0
   7 .\" distribution.
   8 .\"
   9 .\" John W. Eaton
  10 .\" jwe@che.utexas.edu
  11 .\" Department of Chemical Engineering
  12 .\" The University of Texas at Austin
  13 .\" Austin, Texas  78712
  14 .\"
  15 .\" $FreeBSD$
  16 .Dd August 16, 1999
  17 .Dt MANPATH 1
  18 .Os
  19 .Sh NAME
  20 .Nm manpath
  21 .Nd determine user's search path for man pages
  22 .Sh SYNOPSIS
  23 .Nm
  24 .Op Fl dLq
  25 .Sh DESCRIPTION
  26 The
  27 .Nm
  28 utility
  29 tries to determine the user's manpath from a set of system
  30 defaults and the user's
  31 .Ev PATH ,
  32 echoing the result to the standard output.
  33 Warnings and errors are written to the standard error.
  34 If a directory in the user's path is not listed in the
  35 .Pa %manpath_config_file%
  36 file,
  37 .Nm
  38 looks for the subdirectories
  39 .Pa man
  40 or
  41 .Pa MAN .
  42 If they exist, they are added to the search path.
  43 If they do not exist, but the directory ends in
  44 .Pa /bin ,
  45 .Nm
  46 replaces
  47 .Pa /bin
  48 with
  49 .Pa /man
  50 and checks if that directory exists.
  51 If it exists, it is added to the search path.
  52 .Pp
  53 The
  54 .Nm
  55 utility is used by
  56 .Xr man 1
  57 to determine the search path, so users normally do not need to set the
  58 .Ev MANPATH
  59 environment variable directly.
  60 .Pp
  61 The options are as follows:
  62 .Bl -tag -width indent
  63 .It Fl d
  64 Output additional debug information.
  65 .It Fl L
  66 Output man locales list (if it exists).
  67 .It Fl q
  68 Operate quietly.
  69 Only echo the final result.
  70 .El
  71 .Sh ENVIRONMENT
  72 .Bl -tag -width ".Ev MANLOCALES" -compact
  73 .It Ev MANPATH
  74 If
  75 .Ev MANPATH
  76 is set,
  77 .Nm
  78 echoes its value on the standard output and issues a warning on the
  79 standard error.
  80 .It Ev MANLOCALES
  81 If
  82 .Ev MANLOCALES
  83 is set and
  84 .Fl L
  85 option is set,
  86 .Nm
  87 echoes its value on the standard output and issues a warning on the
  88 standard error.
  89 .El
  90 .Sh FILES
  91 .Bl -tag -width ".Pa %manpath_config_file%" -compact
  92 .It Pa %manpath_config_file%
  93 System configuration file.
  94 .El
  95 .Sh SEE ALSO
  96 .Xr apropos 1 ,
  97 .Xr man 1 ,
  98 .Xr whatis 1