=================================================================== RCS file: /cvs/mandoc/apropos.1,v retrieving revision 1.24 retrieving revision 1.27 diff -u -p -r1.24 -r1.27 --- mandoc/apropos.1 2014/04/04 15:51:28 1.24 +++ mandoc/apropos.1 2014/04/18 09:47:09 1.27 @@ -1,6 +1,7 @@ -.\" $Id: apropos.1,v 1.24 2014/04/04 15:51:28 schwarze Exp $ +.\" $Id: apropos.1,v 1.27 2014/04/18 09:47:09 schwarze Exp $ .\" .\" Copyright (c) 2011, 2012 Kristaps Dzonsons +.\" Copyright (c) 2011, 2012, 2014 Ingo Schwarze .\" .\" 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. .\" -.Dd $Mdocdate: April 4 2014 $ +.Dd $Mdocdate: April 18 2014 $ .Dt APROPOS 1 .Os .Sh NAME @@ -37,18 +38,20 @@ and .Nm whatis utilities query manual page databases generated by .Xr mandocdb 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 mandocdb 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 @@ -119,34 +122,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 @@ -161,29 +170,28 @@ considers an .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 -.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 @@ -313,7 +321,7 @@ Search in names and descriptions using a regular expre .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