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

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