source@mandoc.bsd.lv
 help / color / mirror / Atom feed
* mdocml: Correct description of MANPATH, and a few more improvements  to
@ 2017-03-18 19:51 schwarze
  0 siblings, 0 replies; only message in thread
From: schwarze @ 2017-03-18 19:51 UTC (permalink / raw)
  To: source

Log Message:
-----------
Correct description of MANPATH, and a few more improvements 
to the ENVIRONMENT section; OK jmc@

Modified Files:
--------------
    mdocml:
        apropos.1
        makewhatis.8
        man.1
        mandoc.1

Revision Data
-------------
Index: man.1
===================================================================
RCS file: /home/cvs/mdocml/mdocml/man.1,v
retrieving revision 1.22
retrieving revision 1.23
diff -Lman.1 -Lman.1 -u -p -r1.22 -r1.23
--- man.1
+++ 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
 .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
Index: mandoc.1
===================================================================
RCS file: /home/cvs/mdocml/mdocml/mandoc.1,v
retrieving revision 1.178
retrieving revision 1.179
diff -Lmandoc.1 -Lmandoc.1 -u -p -r1.178 -r1.179
--- mandoc.1
+++ 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
Index: apropos.1
===================================================================
RCS file: /home/cvs/mdocml/mdocml/apropos.1,v
retrieving revision 1.41
retrieving revision 1.42
diff -Lapropos.1 -Lapropos.1 -u -p -r1.41 -r1.42
--- apropos.1
+++ 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
Index: makewhatis.8
===================================================================
RCS file: /home/cvs/mdocml/mdocml/makewhatis.8,v
retrieving revision 1.4
retrieving revision 1.5
diff -Lmakewhatis.8 -Lmakewhatis.8 -u -p -r1.4 -r1.5
--- makewhatis.8
+++ 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
--
 To unsubscribe send an email to source+unsubscribe@mdocml.bsd.lv

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2017-03-18 19:51 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-03-18 19:51 mdocml: Correct description of MANPATH, and a few more improvements to schwarze

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).