aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/apropos.1
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2014-08-21 02:28:40 +0000
committerIngo Schwarze <schwarze@openbsd.org>2014-08-21 02:28:40 +0000
commitd7864a41b071bdbae3ccd81f3cc5170e15f13f95 (patch)
treecc7b3cb6516e1a869dceb762f6c670aa653d6404 /apropos.1
parent4a599f470e8524900db79db76d5a05dca9ce00f7 (diff)
downloadmandoc-d7864a41b071bdbae3ccd81f3cc5170e15f13f95.tar.gz
mandoc-d7864a41b071bdbae3ccd81f3cc5170e15f13f95.tar.zst
mandoc-d7864a41b071bdbae3ccd81f3cc5170e15f13f95.zip
Describe the new options -afkw.
Clean up the description of whatis(1).
Diffstat (limited to 'apropos.1')
-rw-r--r--apropos.151
1 files changed, 43 insertions, 8 deletions
diff --git a/apropos.1 b/apropos.1
index e31900bb..4a7bba67 100644
--- a/apropos.1
+++ b/apropos.1
@@ -1,4 +1,4 @@
-.\" $Id: apropos.1,v 1.30 2014/08/21 01:52:59 schwarze Exp $
+.\" $Id: apropos.1,v 1.31 2014/08/21 02:28:40 schwarze Exp $
.\"
.\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
.\" Copyright (c) 2011, 2012, 2014 Ingo Schwarze <schwarze@openbsd.org>
@@ -24,6 +24,7 @@
.Nd search manual page databases
.Sh SYNOPSIS
.Nm
+.Op Fl afkw
.Op Fl C Ar file
.Op Fl M Ar path
.Op Fl m Ar path
@@ -56,17 +57,50 @@ over manual names and descriptions
.Pq the Li \&Nm No and Li \&Nd No macro keys .
Multiple terms imply pairwise
.Fl o .
+.Pp
.Nm whatis
-maps terms only to case-sensitive manual names.
+is a synonym for
+.Nm
+.Fl f .
.Pp
-Its arguments are as follows:
+The options are as follows:
.Bl -tag -width Ds
+.It Fl a
+Instead of showing only the title lines, show the complete manual pages,
+just like
+.Xr man 1
+.Fl a
+would.
+In this mode, the options
+.Fl IOTW
+described in the
+.Xr mandoc 1
+manual are also available.
.It Fl C Ar file
Specify an alternative configuration
.Ar file
in
.Xr man.conf 5
format.
+.It Fl f
+Search for all words in
+.Ar expression
+in manual page names only.
+The search is case insensitive and matches whole words only.
+In this mode, macro keys, comparison operators, and logical operators
+are not available.
+This overrides any earlier
+.Fl k
+option.
+.It Fl k
+Support the full
+.Ar expression
+syntax.
+This overrides any earlier
+.Fl f
+option.
+It is the default for
+.Nm .
.It Fl M Ar path
Use the colon-separated path instead of the default list of paths
searched for
@@ -96,6 +130,12 @@ By default, pages from all sections are shown.
See
.Xr man 1
for a listing of sections.
+.It Fl w
+Instead of showing title lines, show the pathnames of the matching
+manual pages, just like
+.Xr man 1
+.Fl w
+would.
.El
.Pp
An
@@ -165,11 +205,6 @@ is evaluated case-insensitively.
Has no effect on substring terms.
.El
.Pp
-.Nm whatis
-considers an
-.Ar expression
-to consist of an opaque keyword.
-.Pp
Results are sorted by manual sections and names, with output formatted as
.Pp
.D1 name[, name...](sec) \- description