update after recent code changes

[mandoc.git] / apropos.1

diff --git a/apropos.1 b/apropos.1
index bdbb9aa46a2a44da67b22888737fe5df37333500..14682420ff0046ce63faab7f4a157f6e0c7ef3d6 100644 (file)
--- a/apropos.1
+++ b/apropos.1
@@ -1,6 +1,7 @@
-.\"    $Id: apropos.1,v 1.24 2014/04/04 15:51:28 schwarze Exp $
+.\"    $Id: apropos.1,v 1.29 2014/04/24 00:28:19 schwarze Exp $

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

+.\" Copyright (c) 2011, 2012, 2014 Ingo Schwarze <schwarze@openbsd.org>

 .\"
 .\" 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 +15,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: April 4 2014 $
+.Dd $Mdocdate: April 24 2014 $

 .Dt APROPOS 1
 .Os
 .Sh NAME
 .Dt APROPOS 1
 .Os
 .Sh NAME


@@ -36,19 +37,21 @@ The
 and
 .Nm whatis
 utilities query manual page databases generated by
 and
 .Nm whatis
 utilities query manual page databases generated by

-.Xr mandocdb 8 ,
-evaluating on
+.Xr makewhatis 8 ,
+evaluating

 .Ar expression
 for each file in each database.
 .Ar expression
 for each file in each database.

+By default, it displays the names, section numbers, and description lines
+of all matching manuals.

 .Pp
 By default,
 .Nm
 searches for
 .Pp
 By default,
 .Nm
 searches for

-.Xr mandocdb 8
+.Xr makewhatis 8

 databases in the default paths stipulated by
 databases in the default paths stipulated by

-.Xr man 1 ,
-parses terms as case-sensitive regular expressions
-.Pq the Li \&~ operator
+.Xr man 1
+and uses case-insensitive substring matching
+.Pq the Cm = No operator

 over manual names and descriptions
 .Pq the Li \&Nm No and Li \&Nd No macro keys .
 Multiple terms imply pairwise
 over manual names and descriptions
 .Pq the Li \&Nm No and Li \&Nd No macro keys .
 Multiple terms imply pairwise


@@ -67,13 +70,13 @@ format.
 .It Fl M Ar path
 Use the colon-separated path instead of the default list of paths
 searched for
 .It Fl M Ar path
 Use the colon-separated path instead of the default list of paths
 searched for

-.Xr mandocdb 8
+.Xr makewhatis 8

 databases.
 Invalid paths, or paths without manual databases, are ignored.
 .It Fl m Ar path
 Prepend the colon-separated paths to the list of paths searched
 for
 databases.
 Invalid paths, or paths without manual databases, are ignored.
 .It Fl m Ar path
 Prepend the colon-separated paths to the list of paths searched
 for

-.Xr mandocdb 8
+.Xr makewhatis 8

 databases.
 Invalid paths, or paths without manual databases, are ignored.
 .It Fl O Ar outkey
 databases.
 Invalid paths, or paths without manual databases, are ignored.
 .It Fl O Ar outkey


@@ -119,34 +122,40 @@ True if both
 and
 .Ar expr2
 are true (logical
 and
 .Ar expr2
 are true (logical

-.Qq and ) .
+.Sq and ) .

 .It Ar expr1 Oo Fl o Oc Ar expr2
 True if
 .Ar expr1
 and/or
 .Ar expr2
 evaluate to true (logical
 .It Ar expr1 Oo Fl o Oc Ar expr2
 True if
 .Ar expr1
 and/or
 .Ar expr2
 evaluate to true (logical

-.Qq or ) .
+.Sq or ) .

 .It Ar term
 True if
 .Ar term
 is satisfied.
 This has syntax
 .It Ar term
 True if
 .Ar term
 is satisfied.
 This has syntax

-.Li [key[,key]*(=~)]?val ,
-where operand
-.Cm key
+.Sm off
+.Oo
+.Op Ar key Op , Ar key ...
+.Pq Cm = | ~
+.Oc
+.Ar val ,
+.Sm on
+where
+.Ar key

 is an
 .Xr mdoc 7
 macro to query and
 is an
 .Xr mdoc 7
 macro to query and

-.Cm val
+.Ar val

 is its value.
 See
 .Sx Macro Keys
 for a list of available keys.
 Operator
 is its value.
 See
 .Sx Macro Keys
 for a list of available keys.
 Operator

-.Li \&=
+.Cm =

 evaluates a substring, while
 evaluates a substring, while

-.Li \&~
+.Cm ~

 evaluates a regular expression.
 .It Fl i Ar term
 If
 evaluates a regular expression.
 .It Fl i Ar term
 If


@@ -161,34 +170,33 @@ considers an
 .Ar expression
 to consist of an opaque keyword.
 .Pp
 .Ar expression
 to consist of an opaque keyword.
 .Pp

-Results are sorted by manual title, with output formatted as
+Results are sorted by manual sections and names, with output formatted as

 .Pp
 .Pp

-.D1 title(sec) \- description
+.D1 name[, name...](sec) \- description

 .Pp
 Where
 .Pp
 Where

-.Qq title
-is the manual's title (note multiple manual names may exist for one
-title),
-.Qq sec
+.Dq name
+is the manual's name,
+.Dq sec

 is the manual section, and
 is the manual section, and

-.Qq description
+.Dq description

 is the manual's short description.
 If an architecture is specified for the manual, it is displayed as
 .Pp
 is the manual's short description.
 If an architecture is specified for the manual, it is displayed as
 .Pp

-.D1 title(cat/arch) \- description
+.D1 name(sec/arch) \- description

 .Pp
 Resulting manuals may be accessed as
 .Pp
 .Pp
 Resulting manuals may be accessed as
 .Pp

-.Dl $ man \-s sec title
+.Dl $ man \-s sec name

 .Pp
 If an architecture is specified in the output, use
 .Pp
 .Pp
 If an architecture is specified in the output, use
 .Pp

-.Dl $ man \-s sec \-S arch title
+.Dl $ man \-s sec \-S arch name

 .Ss Macro Keys
 Queries evaluate over a subset of
 .Xr mdoc 7
 macros indexed by
 .Ss Macro Keys
 Queries evaluate over a subset of
 .Xr mdoc 7
 macros indexed by

-.Xr mandocdb 8 .
+.Xr makewhatis 8 .

 In addition to the macro keys listed below, the special key
 .Cm any
 may be used to match any available macro key.
 In addition to the macro keys listed below, the special key
 .Cm any
 may be used to match any available macro key.


@@ -285,7 +293,7 @@ standard search path.
 .Bl -tag -width "/etc/man.conf" -compact
 .It Pa mandoc.db
 name of the
 .Bl -tag -width "/etc/man.conf" -compact
 .It Pa mandoc.db
 name of the

-.Xr mandocdb 8
+.Xr makewhatis 8

 keyword database
 .It Pa /etc/man.conf
 default
 keyword database
 .It Pa /etc/man.conf
 default


@@ -313,7 +321,7 @@ Search in names and descriptions using a regular expression:
 .Pp
 .Dl $ apropos '~set.?[ug]id'
 .Pp
 .Pp
 .Dl $ apropos '~set.?[ug]id'
 .Pp

-Search for manuals in the library category mentioning both the
+Search for manuals in the library section mentioning both the

 .Qq optind
 and the
 .Qq optarg
 .Qq optind
 and the
 .Qq optarg


@@ -339,7 +347,7 @@ The following two invocations are equivalent:
 .Sh SEE ALSO
 .Xr man 1 ,
 .Xr re_format 7 ,
 .Sh SEE ALSO
 .Xr man 1 ,
 .Xr re_format 7 ,

-.Xr mandocdb 8
+.Xr makewhatis 8

 .Sh HISTORY
 An
 .Nm
 .Sh HISTORY
 An
 .Nm