summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorschwarze <schwarze@openbsd.org>2017-03-18 19:50:58 +0000
committerschwarze <schwarze@openbsd.org>2017-03-18 19:50:58 +0000
commitaf17c515d8196c921777d557156899c52c8784b8 (patch)
treecab099799e6ba7b5ca6bf72cace41163d16012a6
parentAdd slaacd, a Stateless Address AutoConfiguration Daemon. (diff)
downloadwireguard-openbsd-af17c515d8196c921777d557156899c52c8784b8.tar.xz
wireguard-openbsd-af17c515d8196c921777d557156899c52c8784b8.zip
Correct description of MANPATH, and a few more improvements
to the ENVIRONMENT section; OK jmc@
-rw-r--r--usr.bin/mandoc/apropos.143
-rw-r--r--usr.bin/mandoc/makewhatis.816
-rw-r--r--usr.bin/mandoc/man.133
-rw-r--r--usr.bin/mandoc/mandoc.123
4 files changed, 81 insertions, 34 deletions
diff --git a/usr.bin/mandoc/apropos.1 b/usr.bin/mandoc/apropos.1
index f66e2073590..439efbb90f8 100644
--- a/usr.bin/mandoc/apropos.1
+++ b/usr.bin/mandoc/apropos.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: apropos.1,v 1.33 2017/03/17 17:24:26 schwarze Exp $
+.\" $OpenBSD: apropos.1,v 1.34 2017/03/18 19:50:58 schwarze Exp $
.\"
.\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
.\" Copyright (c) 2011, 2012, 2014, 2017 Ingo Schwarze <schwarze@openbsd.org>
@@ -15,7 +15,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: March 17 2017 $
+.Dd $Mdocdate: March 18 2017 $
.Dt APROPOS 1
.Os
.Sh NAME
@@ -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/usr.bin/mandoc/makewhatis.8 b/usr.bin/mandoc/makewhatis.8
index 3acde392059..abc44b6dea7 100644
--- a/usr.bin/mandoc/makewhatis.8
+++ b/usr.bin/mandoc/makewhatis.8
@@ -1,7 +1,7 @@
-.\" $OpenBSD: makewhatis.8,v 1.12 2014/11/28 19:25:03 schwarze Exp $
+.\" $OpenBSD: makewhatis.8,v 1.13 2017/03/18 19:50:58 schwarze Exp $
.\"
.\" 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
@@ -15,7 +15,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: November 28 2014 $
+.Dd $Mdocdate: March 18 2017 $
.Dt MAKEWHATIS 8
.Os
.Sh NAME
@@ -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/usr.bin/mandoc/man.1 b/usr.bin/mandoc/man.1
index 808f90d1479..07c1adf29d3 100644
--- a/usr.bin/mandoc/man.1
+++ b/usr.bin/mandoc/man.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: man.1,v 1.20 2017/03/17 17:24:26 schwarze Exp $
+.\" $OpenBSD: man.1,v 1.21 2017/03/18 19:50:58 schwarze Exp $
.\"
.\" Copyright (c) 1989, 1990, 1993
.\" The Regents of the University of California. All rights reserved.
@@ -31,7 +31,7 @@
.\"
.\" @(#)man.1 8.2 (Berkeley) 1/2/94
.\"
-.Dd $Mdocdate: March 17 2017 $
+.Dd $Mdocdate: March 18 2017 $
.Dt MAN 1
.Os
.Sh NAME
@@ -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/usr.bin/mandoc/mandoc.1 b/usr.bin/mandoc/mandoc.1
index 6981414e8ef..44ec420fa09 100644
--- a/usr.bin/mandoc/mandoc.1
+++ b/usr.bin/mandoc/mandoc.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: mandoc.1,v 1.102 2017/03/08 19:40:46 schwarze Exp $
+.\" $OpenBSD: mandoc.1,v 1.103 2017/03/18 19:50:58 schwarze Exp $
.\"
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
.\" Copyright (c) 2012, 2014-2017 Ingo Schwarze <schwarze@openbsd.org>
@@ -15,7 +15,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: March 8 2017 $
+.Dd $Mdocdate: March 18 2017 $
.Dt MANDOC 1
.Os
.Sh NAME
@@ -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