=================================================================== RCS file: /cvs/mandoc/Attic/whatis.1,v retrieving revision 1.4 retrieving revision 1.9 diff -u -p -r1.4 -r1.9 --- mandoc/Attic/whatis.1 2011/12/12 02:00:49 1.4 +++ mandoc/Attic/whatis.1 2012/03/25 00:48:47 1.9 @@ -1,6 +1,6 @@ -.\" $Id: whatis.1,v 1.4 2011/12/12 02:00:49 schwarze Exp $ +.\" $Id: whatis.1,v 1.9 2012/03/25 00:48:47 kristaps Exp $ .\" -.\" Copyright (c) 2011 Kristaps Dzonsons +.\" Copyright (c) 2011, 2012 Kristaps Dzonsons .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -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: March 25 2012 $ .Dt WHATIS 1 .Os .Sh NAME @@ -36,11 +36,16 @@ utility searches databases generated by 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 . +If standard output is a TTY, a result may be selected from a list and +its manual displayed with the pager. +.Pp The options are as follows: .Bl -tag -width Ds .It Fl C Ar file @@ -72,12 +77,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 @@ -94,14 +93,22 @@ If an architecture is specified for the manual, it is .Pp .D1 title(cat/arch) \- description .Pp -Resulting manuals may be accessed as +If on a TTY, results are prefixed with a numeric identifier. .Pp -.Dl $ man \-s sec title +.D1 [index] title(cat) \- description .Pp -If an architecture is specified in the output, use +One may choose a manual be entering the index at the prompt. +Valid choices are displayed using +.Ev MANPAGER , +or failing that , +.Ev PAGER +or just +.Xr more 1 . +Source pages are formatted with +.Xr mandoc 1 ; +preformatted pages with +.Xr cat 1 . .Pp -.Dl $ man \-s sec \-S arch title -.Pp .Nm is identical to running .Xr apropos 1 @@ -110,20 +117,39 @@ as follows: .Dl $ apropos -- -i 'Nm~[[:<:]]term[[:>:]]' .Sh ENVIRONMENT .Bl -tag -width Ds +.It Ev MANPAGER +Default pager for manuals. +If this is unset, falls back to +.Ev Pager . +.It Ev PAGER +The second choice for a manual pager. +If this is unset, use +.Xr more 1 . .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