=================================================================== RCS file: /cvs/mandoc/Attic/whatis.1,v retrieving revision 1.4 retrieving revision 1.7.2.1 diff -u -p -r1.4 -r1.7.2.1 --- mandoc/Attic/whatis.1 2011/12/12 02:00:49 1.4 +++ mandoc/Attic/whatis.1 2013/09/17 20:54:35 1.7.2.1 @@ -1,4 +1,4 @@ -.\" $Id: whatis.1,v 1.4 2011/12/12 02:00:49 schwarze Exp $ +.\" $Id: whatis.1,v 1.7.2.1 2013/09/17 20:54:35 schwarze Exp $ .\" .\" Copyright (c) 2011 Kristaps Dzonsons .\" @@ -14,7 +14,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: December 12 2011 $ +.Dd $Mdocdate: September 17 2013 $ .Dt WHATIS 1 .Os .Sh NAME @@ -23,8 +23,8 @@ .Sh SYNOPSIS .Nm .Op Fl C Ar file -.Op Fl M Ar manpath -.Op Fl m Ar manpath +.Op Fl M Ar path +.Op Fl m Ar path .Op Fl S Ar arch .Op Fl s Ar section .Ar name ... @@ -41,6 +41,13 @@ You can then use the .Xr man 1 command to get more information. .Pp +By default, +.Nm +searches for +.Xr mandocdb 8 +databases in the default paths stipulated by +.Xr man 1 . +.Pp The options are as follows: .Bl -tag -width Ds .It Fl C Ar file @@ -49,16 +56,16 @@ Specify an alternative configuration in .Xr man.conf 5 format. -.It Fl M Ar manpath +.It Fl M Ar path Use the colon-separated -.Ar manpath +.Ar path instead of the default list of paths searched for .Xr mandocdb 8 databases. Invalid paths, or paths without manual databases, are ignored. -.It Fl m Ar manpath +.It Fl m Ar path Prepend the colon-separated -.Ar manpath +.Ar path to the list of paths searched for .Xr mandocdb 8 databases. @@ -72,12 +79,6 @@ See for a listing of manual sections. .El .Pp -By default, -.Nm -searches for -.Xr mandocdb 8 -databases in the default paths stipulated by -.Xr man 1 . Results are sorted by manual title, with output formatted as .Pp .D1 title(sec) \- description @@ -111,19 +112,30 @@ as follows: .Sh ENVIRONMENT .Bl -tag -width Ds .It Ev MANPATH -Colon-separated paths overriding the default list of paths searched for +Colon-separated paths modifying the default list of paths searched for manual databases. Invalid paths, or paths without manual databases, are ignored. Overridden by .Fl M . +If +.Ev MANPATH +begins with a +.Sq \&: , +it is appended to the default list; +else if it ends with +.Sq \&: , +it is prepended to the default list; else if it contains +.Sq \&:: , +the default list is inserted between the colons. +If none of these conditions are met, it overrides the default list. .El .Sh FILES .Bl -tag -width "/etc/man.conf" -compact -.It Pa mandoc.db +.It Pa whatis.db name of the .Xr mandocdb 8 keyword database -.It Pa mandoc.index +.It Pa whatis.index name of the .Xr mandocdb 8 filename database @@ -156,5 +168,4 @@ wrote the original .Nm in 1979. The current version was written by -.An Kristaps Dzonsons , -.Mt kristaps@bsd.lv . +.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .