catch up with the changed interface of mparse_alloc(), see mandoc.h rev 1.100

[mandoc.git] / whatis.1

diff --git a/whatis.1 b/whatis.1
index ed1196ef32084930942b32bb4b51c35c34c6da16..94297e3618c0f6ec007c5d289585efbd26ecf2e6 100644 (file)
--- a/whatis.1
+++ b/whatis.1
@@ -1,6 +1,6 @@
-.\"    $Id: whatis.1,v 1.7 2011/12/25 19:35:44 kristaps Exp $
+.\"    $Id: whatis.1,v 1.9 2012/03/25 00:48:47 kristaps Exp $

 .\"
 .\"

-.\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+.\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>

 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above
 .\"
 .\" 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.
 .\"
 .\" 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 25 2011 $
+.Dd $Mdocdate: March 25 2012 $

 .Dt WHATIS 1
 .Os
 .Sh NAME
 .Dt WHATIS 1
 .Os
 .Sh NAME


@@ -36,10 +36,6 @@ utility searches databases generated by
 for manuals containing the word
 .Ar name
 in their page name, ignoring case.
 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
 .Pp
 By default,
 .Nm


@@ -47,6 +43,8 @@ searches for
 .Xr mandocdb 8
 databases in the default paths stipulated by
 .Xr man 1 .
 .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
 .Pp
 The options are as follows:
 .Bl -tag -width Ds


@@ -95,13 +93,21 @@ If an architecture is specified for the manual, it is displayed as
 .Pp
 .D1 title(cat/arch) \- description
 .Pp
 .Pp
 .D1 title(cat/arch) \- description
 .Pp

-Resulting manuals may be accessed as
-.Pp
-.Dl $ man \-s sec title
+If on a TTY, results are prefixed with a numeric identifier.

 .Pp
 .Pp

-If an architecture is specified in the output, use
+.D1 [index] title(cat) \- description

 .Pp
 .Pp

-.Dl $ man \-s sec \-S arch title
+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
 .Nm
 is identical to running
 .Pp
 .Nm
 is identical to running


@@ -111,6 +117,14 @@ as follows:
 .Dl $ apropos -- -i 'Nm~[[:<:]]term[[:>:]]'
 .Sh ENVIRONMENT
 .Bl -tag -width Ds
 .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 modifying the default list of paths searched for
 manual databases.
 .It Ev MANPATH
 Colon-separated paths modifying the default list of paths searched for
 manual databases.