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

.\" Man page for manpath
.\"
.\" Copyright (c) 1990, 1991, John W. Eaton.
.\"
.\" You may distribute under the terms of the GNU General Public
.\" License as specified in the README file that comes with the man 1.0
.\" distribution.
.\"
.\" John W. Eaton
.\" jwe@che.utexas.edu
.\" Department of Chemical Engineering
.\" The University of Texas at Austin
.\" Austin, Texas  78712
.\"
.\" $FreeBSD$
.Dd August 16, 1999
.Dt MANPATH 1
.Os
.Sh NAME
.Nm manpath
.Nd determine user's search path for man pages
.Sh SYNOPSIS
.Nm
.Op Fl dLq
.Sh DESCRIPTION
The
.Nm
utility
tries to determine the user's manpath from a set of system
defaults and the user's
.Ev PATH ,
echoing the result to the standard output.
Warnings and errors are written to the standard error.
If a directory in the user's path is not listed in the
.Pa %manpath_config_file%
file,
.Nm
looks for the subdirectories
.Pa man
or
.Pa MAN .
If they exist, they are added to the search path.
If they do not exist, but the directory ends in
.Pa /bin ,
.Nm
replaces
.Pa /bin
with
.Pa /man
and checks if that directory exists.
If it exists, it is added to the search path.
.Pp
The
.Nm
utility is used by
.Xr man 1
to determine the search path, so users normally do not need to set the
.Ev MANPATH
environment variable directly.
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl d
Output additional debug information.
.It Fl L
Output man locales list (if it exists).
.It Fl q
Operate quietly.
Only echo the final result.
.El
.Sh ENVIRONMENT
.Bl -tag -width ".Ev MANLOCALES" -compact
.It Ev MANPATH
If
.Ev MANPATH
is set,
.Nm
echoes its value on the standard output and issues a warning on the
standard error.
.It Ev MANLOCALES
If
.Ev MANLOCALES
is set and
.Fl L
option is set,
.Nm
echoes its value on the standard output and issues a warning on the
standard error.
.El
.Sh FILES
.Bl -tag -width ".Pa %manpath_config_file%" -compact
.It Pa %manpath_config_file%
System configuration file.
.El
.Sh SEE ALSO
.Xr apropos 1 ,
.Xr man 1 ,
.Xr whatis 1
Newer new man page reader. 1993-07-08 01:07:02 +02:00			`.\" Man page for manpath`
			`.\"`
			`.\" Copyright (c) 1990, 1991, John W. Eaton.`
			`.\"`
			`.\" You may distribute under the terms of the GNU General Public`
			`.\" License as specified in the README file that comes with the man 1.0`
- Add an OPTIONAL_MANPATH directive (same as MANDATORY_MANPATH, except an absence of the directory is not considered an error and doesn't produce a warning). Put /usr/local/lib/perl5/*/man under OPTIONAL_MANPATH. - An order of directives in manpath.config is now irrelevant. - Get rid of infinite loop when PATH is unset or NULL, and MANDATORY_MANPATH directory doesn't exist. - mdoc(9)ify manpage. Reviewed by: des, markm, sheldonh 1999-08-16 13:34:57 +02:00			`.\" distribution.`
Newer new man page reader. 1993-07-08 01:07:02 +02:00			`.\"`
			`.\" John W. Eaton`
			`.\" jwe@che.utexas.edu`
			`.\" Department of Chemical Engineering`
			`.\" The University of Texas at Austin`
			`.\" Austin, Texas 78712`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 01:37:10 +02:00			`.\" $FreeBSD$`
mdoc(7) police: use canonical form of .Dd macro. 2000-12-11 16:15:20 +01:00			`.Dd August 16, 1999`
Convert to mdoc format. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2134 1996-12-09 08:57:54 +01:00			`.Dt MANPATH 1`
			`.Os`
			`.Sh NAME`
			`.Nm manpath`
			`.Nd determine user's search path for man pages`
			`.Sh SYNOPSIS`
			`.Nm`
Add -L: print MANLOCALES variable for man locales list 1999-11-23 04:06:18 +01:00			`.Op Fl dLq`
Convert to mdoc format. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2134 1996-12-09 08:57:54 +01:00			`.Sh DESCRIPTION`
Fix markup, remove a dummy BUGS section. 2006-12-25 00:07:11 +01:00			`The`
			`.Nm`
			`utility`
Convert to mdoc format. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2134 1996-12-09 08:57:54 +01:00			`tries to determine the user's manpath from a set of system`
Newer new man page reader. 1993-07-08 01:07:02 +02:00			`defaults and the user's`
Convert to mdoc format. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2134 1996-12-09 08:57:54 +01:00			`.Ev PATH ,`
- Add an OPTIONAL_MANPATH directive (same as MANDATORY_MANPATH, except an absence of the directory is not considered an error and doesn't produce a warning). Put /usr/local/lib/perl5/*/man under OPTIONAL_MANPATH. - An order of directives in manpath.config is now irrelevant. - Get rid of infinite loop when PATH is unset or NULL, and MANDATORY_MANPATH directory doesn't exist. - mdoc(9)ify manpage. Reviewed by: des, markm, sheldonh 1999-08-16 13:34:57 +02:00			`echoing the result to the standard output.`
			`Warnings and errors are written to the standard error.`
			`If a directory in the user's path is not listed in the`
			`.Pa %manpath_config_file%`
			`file,`
Convert to mdoc format. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2134 1996-12-09 08:57:54 +01:00			`.Nm`
- Add an OPTIONAL_MANPATH directive (same as MANDATORY_MANPATH, except an absence of the directory is not considered an error and doesn't produce a warning). Put /usr/local/lib/perl5/*/man under OPTIONAL_MANPATH. - An order of directives in manpath.config is now irrelevant. - Get rid of infinite loop when PATH is unset or NULL, and MANDATORY_MANPATH directory doesn't exist. - mdoc(9)ify manpage. Reviewed by: des, markm, sheldonh 1999-08-16 13:34:57 +02:00			`looks for the subdirectories`
			`.Pa man`
			`or`
			`.Pa MAN .`
			`If they exist, they are added to the search path.`
Document how manpath(1) handles user's path directories that end in "/bin". PR: docs/30940 MFC after: 3 days 2001-10-01 18:58:30 +02:00			`If they do not exist, but the directory ends in`
			`.Pa /bin ,`
			`.Nm`
			`replaces`
			`.Pa /bin`
			`with`
			`.Pa /man`
			`and checks if that directory exists.`
			`If it exists, it is added to the search path.`
- Add an OPTIONAL_MANPATH directive (same as MANDATORY_MANPATH, except an absence of the directory is not considered an error and doesn't produce a warning). Put /usr/local/lib/perl5/*/man under OPTIONAL_MANPATH. - An order of directives in manpath.config is now irrelevant. - Get rid of infinite loop when PATH is unset or NULL, and MANDATORY_MANPATH directory doesn't exist. - mdoc(9)ify manpage. Reviewed by: des, markm, sheldonh 1999-08-16 13:34:57 +02:00			`.Pp`
Fix markup, remove a dummy BUGS section. 2006-12-25 00:07:11 +01:00			`The`
			`.Nm`
			`utility is used by`
- Add an OPTIONAL_MANPATH directive (same as MANDATORY_MANPATH, except an absence of the directory is not considered an error and doesn't produce a warning). Put /usr/local/lib/perl5/*/man under OPTIONAL_MANPATH. - An order of directives in manpath.config is now irrelevant. - Get rid of infinite loop when PATH is unset or NULL, and MANDATORY_MANPATH directory doesn't exist. - mdoc(9)ify manpage. Reviewed by: des, markm, sheldonh 1999-08-16 13:34:57 +02:00			`.Xr man 1`
Expand *n't contractions. 2005-02-13 23:25:33 +01:00			`to determine the search path, so users normally do not need to set the`
Convert to mdoc format. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2134 1996-12-09 08:57:54 +01:00			`.Ev MANPATH`
Newer new man page reader. 1993-07-08 01:07:02 +02:00			`environment variable directly.`
Convert to mdoc format. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2134 1996-12-09 08:57:54 +01:00			`.Pp`
			`The options are as follows:`
Fix markup, remove a dummy BUGS section. 2006-12-25 00:07:11 +01:00			`.Bl -tag -width indent`
Add -L: print MANLOCALES variable for man locales list 1999-11-23 04:06:18 +01:00			`.It Fl d`
			`Output additional debug information.`
			`.It Fl L`
Fix markup, remove a dummy BUGS section. 2006-12-25 00:07:11 +01:00			`Output man locales list (if it exists).`
Convert to mdoc format. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2134 1996-12-09 08:57:54 +01:00			`.It Fl q`
- Add an OPTIONAL_MANPATH directive (same as MANDATORY_MANPATH, except an absence of the directory is not considered an error and doesn't produce a warning). Put /usr/local/lib/perl5/*/man under OPTIONAL_MANPATH. - An order of directives in manpath.config is now irrelevant. - Get rid of infinite loop when PATH is unset or NULL, and MANDATORY_MANPATH directory doesn't exist. - mdoc(9)ify manpage. Reviewed by: des, markm, sheldonh 1999-08-16 13:34:57 +02:00			`Operate quietly.`
Add -L: print MANLOCALES variable for man locales list 1999-11-23 04:06:18 +01:00			`Only echo the final result.`
Convert to mdoc format. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2134 1996-12-09 08:57:54 +01:00			`.El`
			`.Sh ENVIRONMENT`
Fix markup, remove a dummy BUGS section. 2006-12-25 00:07:11 +01:00			`.Bl -tag -width ".Ev MANLOCALES" -compact`
Convert to mdoc format. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2134 1996-12-09 08:57:54 +01:00			`.It Ev MANPATH`
Newer new man page reader. 1993-07-08 01:07:02 +02:00			`If`
Convert to mdoc format. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2134 1996-12-09 08:57:54 +01:00			`.Ev MANPATH`
Newer new man page reader. 1993-07-08 01:07:02 +02:00			`is set,`
- Add an OPTIONAL_MANPATH directive (same as MANDATORY_MANPATH, except an absence of the directory is not considered an error and doesn't produce a warning). Put /usr/local/lib/perl5/*/man under OPTIONAL_MANPATH. - An order of directives in manpath.config is now irrelevant. - Get rid of infinite loop when PATH is unset or NULL, and MANDATORY_MANPATH directory doesn't exist. - mdoc(9)ify manpage. Reviewed by: des, markm, sheldonh 1999-08-16 13:34:57 +02:00			`.Nm`
Newer new man page reader. 1993-07-08 01:07:02 +02:00			`echoes its value on the standard output and issues a warning on the`
			`standard error.`
Add -L: print MANLOCALES variable for man locales list 1999-11-23 04:06:18 +01:00			`.It Ev MANLOCALES`
			`If`
			`.Ev MANLOCALES`
			`is set and`
			`.Fl L`
			`option is set,`
			`.Nm`
			`echoes its value on the standard output and issues a warning on the`
			`standard error.`
Convert to mdoc format. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2134 1996-12-09 08:57:54 +01:00			`.El`
			`.Sh FILES`
Fix markup, remove a dummy BUGS section. 2006-12-25 00:07:11 +01:00			`.Bl -tag -width ".Pa %manpath_config_file%" -compact`
Convert to mdoc format. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2134 1996-12-09 08:57:54 +01:00			`.It Pa %manpath_config_file%`
Newer new man page reader. 1993-07-08 01:07:02 +02:00			`System configuration file.`
Convert to mdoc format. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2134 1996-12-09 08:57:54 +01:00			`.El`
			`.Sh SEE ALSO`
			`.Xr apropos 1 ,`
mdoc(7) police: sort SEE ALSO xrefs (sort -b -f +2 -3 +1 -2). 2001-07-06 18:46:48 +02:00			`.Xr man 1 ,`
			`.Xr whatis 1`