===================================================================
RCS file: /cvs/mandoc/Attic/whatis.1,v
retrieving revision 1.1
retrieving revision 1.7.2.1
diff -u -p -r1.1 -r1.7.2.1
--- mandoc/Attic/whatis.1	2011/11/27 18:54:01	1.1
+++ mandoc/Attic/whatis.1	2013/09/17 20:54:35	1.7.2.1
@@ -1,4 +1,4 @@
-.\"	$Id: whatis.1,v 1.1 2011/11/27 18:54:01 kristaps Exp $
+.\"	$Id: whatis.1,v 1.7.2.1 2013/09/17 20:54:35 schwarze Exp $
 .\"
 .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
@@ -14,37 +14,59 @@
 .\" 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 27 2011 $
+.Dd $Mdocdate: September 17 2013 $
 .Dt WHATIS 1
 .Os
 .Sh NAME
 .Nm whatis
-.Nd search manual page databases
+.Nd search for manual pages by page names
 .Sh SYNOPSIS
 .Nm
-.Op Fl M Ar manpath
-.Op Fl m Ar manpath
+.Op Fl C Ar file
+.Op Fl M Ar path
+.Op Fl m Ar path
 .Op Fl S Ar arch
 .Op Fl s Ar section
-.Ar term...
+.Ar name ...
 .Sh DESCRIPTION
 The
 .Nm
-utility searches for manuals named or described with
-.Ar term
-in manual page databases generated by
-.Xr mandocdb 8 .
-Its arguments are as follows:
+utility searches databases generated by
+.Xr mandocdb 8
+for manuals containing the word
+.Ar name
+in their page name, ignoring case.
+It returns the header lines from all matching pages.
+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 M Ar manpath
-Use the colon-separated path instead of the default list of paths
-searched for
+.It Fl C Ar file
+Specify an alternative configuration
+.Ar file
+in
+.Xr man.conf 5
+format.
+.It Fl M Ar path
+Use the colon-separated
+.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
-Prepend the colon-separated paths to the list of paths searched
-for
+.It Fl m Ar path
+Prepend the colon-separated
+.Ar path
+to the list of paths searched for
 .Xr mandocdb 8
 databases.
 Invalid paths, or paths without manual databases, are ignored.
@@ -57,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
@@ -92,27 +108,64 @@ is identical to running
 .Xr apropos 1
 as follows:
 .Pp
-.Dl $ apropos -- -i '~[[:<:]]term[[:>:]]'
+.Dl $ apropos -- -i 'Nm~[[:<:]]term[[:>:]]'
 .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
+.Sh FILES
+.Bl -tag -width "/etc/man.conf" -compact
+.It Pa whatis.db
+name of the
+.Xr mandocdb 8
+keyword database
+.It Pa whatis.index
+name of the
+.Xr mandocdb 8
+filename database
+.It Pa /etc/man.conf
+default
+.Xr man 1
+configuration file
+.El
 .Sh EXIT STATUS
 .Ex -std
 .Sh SEE ALSO
 .Xr apropos 1 ,
 .Xr man 1 ,
-.Xr mandoc 1 ,
+.Xr man.conf 5 ,
 .Xr mandocdb 8
-.Sh AUTHORS
+.Sh HISTORY
 The
 .Nm
-utility was written by
-.An Kristaps Dzonsons ,
-.Mt kristaps@bsd.lv .
+utility first appeared in
+.Bx 2 .
+It was rewritten from scratch as part of the
+.Xr mandocdb 8
+project for
+.Ox 5.1 .
+.Sh AUTHORS
+.An -nosplit
+.An Bill Joy
+wrote the original
+.Bx
+.Nm
+in 1979.
+The current version was written by
+.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .