Fix a few lies; polish wording and formatting while here.
authorschwarze <schwarze@openbsd.org>
Fri, 18 Apr 2014 09:46:41 +0000 (09:46 +0000)
committerschwarze <schwarze@openbsd.org>
Fri, 18 Apr 2014 09:46:41 +0000 (09:46 +0000)
usr.bin/mandoc/apropos.1

index 8528fb6..54a6079 100644 (file)
@@ -1,4 +1,4 @@
-.\"    $Id: apropos.1,v 1.22 2014/04/15 23:01:34 schwarze Exp $
+.\"    $Id: apropos.1,v 1.23 2014/04/18 09:46:41 schwarze Exp $
 .\"
 .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2011, 2012, 2014 Ingo Schwarze <schwarze@openbsd.org>
@@ -15,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.
 .\"
-.Dd $Mdocdate: April 15 2014 $
+.Dd $Mdocdate: April 18 2014 $
 .Dt APROPOS 1
 .Os
 .Sh NAME
@@ -35,18 +35,20 @@ The
 .Nm
 utility queries manual page databases generated by
 .Xr makewhatis 8 ,
-evaluating on
+evaluating
 .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
 .Xr makewhatis 8
 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
@@ -115,34 +117,40 @@ True if both
 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
-.Qq or ) .
+.Sq or ) .
 .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
-.Cm val
+.Ar val
 is its value.
 See
 .Sx Macro Keys
 for a list of available keys.
 Operator
-.Li \&=
+.Cm =
 evaluates a substring, while
-.Li \&~
+.Cm ~
 evaluates a regular expression.
 .It Fl i Ar term
 If
@@ -152,29 +160,28 @@ is evaluated case-insensitively.
 Has no effect on substring terms.
 .El
 .Pp
-Results are sorted by manual title, with output formatted as
+Results are sorted by manual sections and names, with output formatted as
 .Pp
-.D1 title(sec) \- description
+.D1 name[, name...](sec) \- description
 .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
-.Qq description
+.Dq description
 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
-.Dl $ man \-s sec title
+.Dl $ man \-s sec name
 .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
@@ -304,7 +311,7 @@ Search in names and descriptions using a regular expression:
 .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