aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/whatis.1
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2012-03-24 01:54:43 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2012-03-24 01:54:43 +0000
commit096b9eb1745c1bb9b8ca952d36f335f066bda384 (patch)
treeb39a526f811fbaa4a8d3af635266d1f4c08a4e9a /whatis.1
parent88f15230be7f66fcbb0009b5e966bad9b4f425c9 (diff)
downloadmandoc-096b9eb1745c1bb9b8ca952d36f335f066bda384.tar.gz
mandoc-096b9eb1745c1bb9b8ca952d36f335f066bda384.tar.zst
mandoc-096b9eb1745c1bb9b8ca952d36f335f066bda384.zip
Get ready for a version.
Diffstat (limited to 'whatis.1')
-rw-r--r--whatis.134
1 files changed, 26 insertions, 8 deletions
diff --git a/whatis.1 b/whatis.1
index ed1196ef..500b0b6c 100644
--- 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.8 2012/03/24 01:54:43 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
@@ -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 25 2011 $
+.Dd $Mdocdate: March 24 2012 $
.Dt WHATIS 1
.Os
.Sh NAME
@@ -47,6 +47,8 @@ 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
@@ -95,13 +97,21 @@ If an architecture is specified for the manual, it is displayed as
.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
-.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
@@ -111,6 +121,14 @@ 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 modifying the default list of paths searched for
manual databases.