summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2017-03-18 19:51:19 +0000
committerIngo Schwarze <schwarze@openbsd.org>2017-03-18 19:51:19 +0000
commitfeadac8011cda39cf2fe0f39d57970b53d507d79 (patch)
tree9deb56b1a31b50871b37912d27e5c1a8336bbc92
parent4e42cb141b28105526d861bb64825e369b1a93d1 (diff)
downloadmandoc-feadac8011cda39cf2fe0f39d57970b53d507d79.tar.gz
Correct description of MANPATH, and a few more improvements
to the ENVIRONMENT section; OK jmc@
-rw-r--r--apropos.139
-rw-r--r--makewhatis.812
-rw-r--r--man.129
-rw-r--r--mandoc.119
4 files changed, 73 insertions, 26 deletions
diff --git a/apropos.1 b/apropos.1
index f23b19ea..d031d456 100644
--- a/apropos.1
+++ b/apropos.1
@@ -362,25 +362,25 @@ Text production:
.It Ev MANPAGER
Any non-empty value of the environment variable
.Ev MANPAGER
-will be used instead of the standard pagination program,
-.Xr more 1 .
+is used instead of the standard pagination program,
+.Xr more 1 ;
+see
+.Xr man 1
+for details.
+Only used if
+.Fl a
+or
+.Fl l
+is specified.
.It Ev MANPATH
-The standard search path used by
+A colon-separated list of directories to search for manual pages; see
.Xr man 1
-may be changed by specifying a path in the
-.Ev MANPATH
-environment variable.
-Invalid paths, or paths without manual databases, are ignored.
+for details.
Overridden by
-.Fl M .
-If
-.Ev MANPATH
-begins with a colon, it is appended to the default list;
-if it ends with a colon, it is prepended to the default list;
-or if it contains two adjacent colons,
-the standard search path is inserted between the colons.
-If none of these conditions are met, it overrides the
-standard search path.
+.Fl M ,
+ignored if
+.Fl l
+is specified.
.It Ev PAGER
Specifies the pagination program to use when
.Ev MANPAGER
@@ -388,7 +388,12 @@ is not defined.
If neither PAGER nor MANPAGER is defined,
.Xr more 1
.Fl s
-will be used.
+is used.
+Only used if
+.Fl a
+or
+.Fl l
+is specified.
.El
.Sh FILES
.Bl -tag -width "/etc/man.conf" -compact
diff --git a/makewhatis.8 b/makewhatis.8
index 0a951b59..080a9b79 100644
--- a/makewhatis.8
+++ b/makewhatis.8
@@ -1,7 +1,7 @@
.\" $Id$
.\"
.\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
-.\" Copyright (c) 2011, 2012 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2011, 2012, 2014, 2017 Ingo Schwarze <schwarze@openbsd.org>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
@@ -135,6 +135,16 @@ from the database in
If fatal parse errors are encountered while parsing, the offending file
is printed to stderr, omitted from the index, and the parse continues
with the next input file.
+.Sh ENVIRONMENT
+.Bl -tag -width MANPATH
+.It Ev MANPATH
+A colon-separated list of directories to create databases in.
+Ignored if a
+.Ar dir
+argument or the
+.Fl t
+option is specified.
+.El
.Sh FILES
.Bl -tag -width Ds
.It Pa mandoc.db
diff --git a/man.1 b/man.1
index b869eecd..7ad6f8cc 100644
--- a/man.1
+++ b/man.1
@@ -322,7 +322,7 @@ is case insensitive.
.It Ev MANPAGER
Any non-empty value of the environment variable
.Ev MANPAGER
-will be used instead of the standard pagination program,
+is used instead of the standard pagination program,
.Xr more 1 .
If
.Xr less 1
@@ -346,13 +346,27 @@ information about the term last searched for with
.It Ev MANPATH
The standard search path used by
.Nm
-may be overridden by specifying a path in the
+may be changed by specifying a path in the
.Ev MANPATH
-environment
-variable.
+environment variable.
The format of the path is a colon
.Pq Ql \&:
separated list of directories.
+Invalid paths, or paths without manual databases, are ignored.
+Overridden by
+.Fl M ,
+ignored if
+.Fl l
+is specified.
+.Pp
+If
+.Ev MANPATH
+begins with a colon, it is appended to the default list;
+if it ends with a colon, it is prepended to the default list;
+or if it contains two adjacent colons,
+the standard search path is inserted between the colons.
+If none of these conditions are met, it overrides the
+standard search path.
.It Ev PAGER
Specifies the pagination program to use when
.Ev MANPAGER
@@ -360,7 +374,12 @@ is not defined.
If neither PAGER nor MANPAGER is defined,
.Xr more 1
.Fl s
-will be used.
+is used.
+Only used if
+.Fl a
+or
+.Fl l
+is specified.
.El
.Sh FILES
.Bl -tag -width /etc/man.conf -compact
diff --git a/mandoc.1 b/mandoc.1
index 8cb5a8b1..1cdbeb66 100644
--- a/mandoc.1
+++ b/mandoc.1
@@ -611,8 +611,16 @@ Meta data is not available in this case.
.It Ev MANPAGER
Any non-empty value of the environment variable
.Ev MANPAGER
-will be used instead of the standard pagination program,
-.Xr more 1 .
+is used instead of the standard pagination program,
+.Xr more 1 ;
+see
+.Xr man 1
+for details.
+Only used if
+.Fl a
+or
+.Fl l
+is specified.
.It Ev PAGER
Specifies the pagination program to use when
.Ev MANPAGER
@@ -620,7 +628,12 @@ is not defined.
If neither PAGER nor MANPAGER is defined,
.Xr more 1
.Fl s
-will be used.
+is used.
+Only used if
+.Fl a
+or
+.Fl l
+is specified.
.El
.Sh EXIT STATUS
The