=================================================================== RCS file: /cvs/mandoc/apropos.1,v retrieving revision 1.14 retrieving revision 1.18 diff -u -p -r1.14 -r1.18 --- mandoc/apropos.1 2011/12/24 22:37:16 1.14 +++ mandoc/apropos.1 2012/06/08 10:44:52 1.18 @@ -1,6 +1,6 @@ -.\" $Id: apropos.1,v 1.14 2011/12/24 22:37:16 kristaps Exp $ +.\" $Id: apropos.1,v 1.18 2012/06/08 10:44:52 kristaps Exp $ .\" -.\" Copyright (c) 2011 Kristaps Dzonsons +.\" Copyright (c) 2011, 2012 Kristaps Dzonsons .\" .\" 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 +14,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: December 24 2011 $ +.Dd $Mdocdate: June 8 2012 $ .Dt APROPOS 1 .Os .Sh NAME @@ -36,6 +36,18 @@ utility queries manual page databases generated by evaluating on .Ar expression for each file in each database. +.Pp +By default, +.Nm +searches for +.Xr mandocdb 8 +databases in the default paths stipulated by +.Xr man 1 +and +parses terms as case-sensitive words +over manual names and descriptions. +Multiple terms are OR'd. +.Pp Its arguments are as follows: .Bl -tag -width Ds .It Fl C Ar file @@ -67,41 +79,8 @@ for a listing of manual sections. .Pp An .Ar expression -consists of search terms joined by logical operators -.Fl a -.Pq and -and -.Fl o -.Pq or . -The -.Fl a -operator has precedence over -.Fl o -and both are evaluated left-to-right. -.Bl -tag -width Ds -.It \&( Ar expr No \&) -True if the subexpression -.Ar expr -is true. -.It Ar expr1 Fl a Ar expr2 -True if both -.Ar expr1 -and -.Ar expr2 -are true (logical -.Qq and ) . -.It Ar expr1 Oo Fl o Oc Ar expr2 -True if -.Ar expr1 -and/or -.Ar expr2 -evaluate to true (logical -.Qq or ) . -.It Ar term -True if -.Ar term -is satisfied. -This has syntax +consists of type and keyword pairs. +This pair syntax .Li [key[,key]*(=~)]?val , where operand .Cm key @@ -115,34 +94,15 @@ See for a list of available keys. Operator .Li \&= -evaluates a substring, while +evaluates a full string, while .Li \&~ -evaluates a regular expression. -.It Fl i Ar term -If -.Ar term -is a regular expression, it -is evaluated case-insensitively. -Has no effect on substring terms. -.El +evaluates a +.Xr glob 7 +pattern. .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 -over manual names and descriptions -.Pq the Li \&Nm No and Li \&Nd No macro keys . -Multiple terms imply pairwise -.Fl o . Results are sorted by manual title, with output formatted as -.Pp -.D1 title(sec) \- description -.Pp -Where +.Qq title(sec) \- description +where .Qq title is the manual's title (note multiple manual names may exist for one title), @@ -151,16 +111,7 @@ is the manual section, and .Qq 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 -.Pp -Resulting manuals may be accessed as -.Pp -.Dl $ man \-s sec title -.Pp -If an architecture is specified in the output, use -.Pp -.Dl $ man \-s sec \-S arch title +.Qq title(cat/arch) \- description . .Ss Macro Keys Queries evaluate over a subset of .Xr mdoc 7 @@ -258,11 +209,11 @@ If none of these conditions are met, it overrides the .El .Sh FILES .Bl -tag -width "/etc/man.conf" -compact -.It Pa mandoc.db +.It Pa whatis.db name of the .Xr mandocdb 8 keyword database -.It Pa mandoc.index +.It Pa whatis.index name of the .Xr mandocdb 8 filename database @@ -276,31 +227,30 @@ configuration file .Sh EXAMPLES Search for .Qq mdoc -as a substring and regular expression -within each manual name and description: +as a word or +.Xr glob 7 +expression: .Pp .Dl $ apropos mdoc -.Dl $ apropos ~^mdoc$ +.Dl $ apropos any~mdoc* .Pp Include matches for .Qq roff and .Qq man -for the regular expression case: +using +.Xr glob 7 +expressions: .Pp -.Dl $ apropos ~^mdoc$ roff man -.Dl $ apropos ~^mdoc$ \-o roff \-o man +.Dl $ apropos ~*mdoc* ~*roff* .Pp Search for -.Qq optind -and .Qq optarg -as variable names in the library category: +as a variable name in the library category: .Pp -.Dl $ apropos \-s 3 Va~^optind \-a Va~^optarg$ +.Dl $ apropos \-s 3 Va=optarg .Sh SEE ALSO -.Xr man 1 , -.Xr re_format 7 , +.Xr glob 7 , .Xr mandocdb 8 .Sh AUTHORS The