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: src/gnu/usr.bin/man/manpath/manpath.man,v 1.6.2.3 2001/10/04 13:02:24 ru Exp $
  16 .\" $DragonFly: src/gnu/usr.bin/man/manpath/manpath.man,v 1.2 2003/06/17 04:25:46 dillon Exp $
  17 .Dd August 16, 1999
  18 .Dt MANPATH 1
  19 .Os
  20 .Sh NAME
  21 .Nm manpath
  22 .Nd determine user's search path for man pages
  23 .Sh SYNOPSIS
  24 .Nm
  25 .Op Fl dLq
  26 .Sh DESCRIPTION
  27 .Nm Manpath
  28 tries to determine the user's manpath from a set of system
  29 defaults and the user's
  30 .Ev PATH ,
  31 echoing the result to the standard output.
  32 Warnings and errors are written to the standard error.
  33 If a directory in the user's path is not listed in the
  34 .Pa %manpath_config_file%
  35 file,
  36 .Nm
  37 looks for the subdirectories
  38 .Pa man
  39 or
  40 .Pa MAN .
  41 If they exist, they are added to the search path.
  42 If they do not exist, but the directory ends in
  43 .Pa /bin ,
  44 .Nm
  45 replaces
  46 .Pa /bin
  47 with
  48 .Pa /man
  49 and checks if that directory exists.
  50 If it exists, it is added to the search path.
  51 .Pp
  52 .Nm Manpath
  53 is used by
  54 .Xr man 1
  55 to determine the search path, so users normally don't need to set the
  56 .Ev MANPATH
  57 environment variable directly.
  58 .Pp
  59 The options are as follows:
  60 .Bl -tag -width Fl
  61 .It Fl d
  62 Output additional debug information.
  63 .It Fl L
  64 Output man locales list (if exist).
  65 .It Fl q
  66 Operate quietly.
  67 Only echo the final result.
  68 .El
  69 .Sh ENVIRONMENT
  70 .Bl -tag -width MANLOCALES -compact
  71 .It Ev MANPATH
  72 If
  73 .Ev MANPATH
  74 is set,
  75 .Nm
  76 echoes its value on the standard output and issues a warning on the
  77 standard error.
  78 .It Ev MANLOCALES
  79 If
  80 .Ev MANLOCALES
  81 is set and
  82 .Fl L
  83 option is set,
  84 .Nm
  85 echoes its value on the standard output and issues a warning on the
  86 standard error.
  87 .El
  88 .Sh FILES
  89 .Bl -tag -width %manpath_config_file% -compact
  90 .It Pa %manpath_config_file%
  91 System configuration file.
  92 .El
  93 .Sh SEE ALSO
  94 .Xr apropos 1 ,
  95 .Xr man 1 ,
  96 .Xr whatis 1
  97 .Sh BUGS
  98 None known.