]> git.cameronkatri.com Git - mandoc.git/blobdiff - apropos.1
In SYNOPSIS mode, .Ek doesn't end a keep.
[mandoc.git] / apropos.1
index 4706d36a626d2951945b461d7dd01795fb0051b3..71868aeef970d01d126c3dad43226ea5d84f9fbe 100644 (file)
--- a/apropos.1
+++ b/apropos.1
@@ -1,4 +1,4 @@
-.\"    $Id: apropos.1,v 1.18 2012/06/08 10:44:52 kristaps Exp $
+.\"    $Id: apropos.1,v 1.19 2012/06/09 14:11:15 kristaps Exp $
 .\"
 .\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: June 8 2012 $
+.Dd $Mdocdate: June 9 2012 $
 .Dt APROPOS 1
 .Os
 .Sh NAME
-.Nm apropos
+.Nm apropos ,
+.Nm whatis
 .Nd search manual page databases
 .Sh SYNOPSIS
 .Nm
 .Ar expression ...
 .Sh DESCRIPTION
 The
-.Nm
-utility queries manual page databases generated by
+.Nm apropos
+and
+.Nm whatis
+utilities query manual page databases generated by
 .Xr mandocdb 8 ,
 evaluating on
 .Ar expression
@@ -44,9 +47,10 @@ searches for
 databases in the default paths stipulated by
 .Xr man 1
 and
-parses terms as case-sensitive words
-over manual names and descriptions.
+maps terms to case-sensitive manual names and descriptions.
 Multiple terms are OR'd.
+.Nm whatis
+maps terms only to case-sensitive manual names.
 .Pp
 Its arguments are as follows:
 .Bl -tag -width Ds
@@ -77,9 +81,14 @@ See
 for a listing of manual sections.
 .El
 .Pp
-An
+.Nm whatis
+considers an
 .Ar expression
-consists of type and keyword pairs.
+to consist of an opaque keyword.
+.Nm apropos
+parses a
+.Ar expression
+into type and keyword pairs.
 This pair syntax
 .Li [key[,key]*(=~)]?val ,
 where operand
@@ -113,7 +122,8 @@ is the manual's short description.
 If an architecture is specified for the manual, it is displayed as
 .Qq title(cat/arch) \- description .
 .Ss Macro Keys
-Queries evaluate over a subset of
+.Nm apropos
+queries evaluate over a subset of
 .Xr mdoc 7
 macros indexed by
 .Xr mandocdb 8 .
@@ -209,14 +219,10 @@ If none of these conditions are met, it overrides the default list.
 .El
 .Sh FILES
 .Bl -tag -width "/etc/man.conf" -compact
-.It Pa whatis.db
+.It Pa mandocdb.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