diff options
author | Ingo Schwarze <schwarze@openbsd.org> | 2014-04-18 09:47:09 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@openbsd.org> | 2014-04-18 09:47:09 +0000 |
commit | 85e9e961e07c282eeaba41762ca8b5439873b13b (patch) | |
tree | f13d5f1f027bf6ccb24eb8bb4316f0793fd1d2bd /apropos.1 | |
parent | 751b61131f149061d689b6bac72b4a2c3629e44a (diff) | |
download | mandoc-85e9e961e07c282eeaba41762ca8b5439873b13b.tar.gz |
Fix a few lies; polish wording and formatting while here.
Diffstat (limited to 'apropos.1')
-rw-r--r-- | apropos.1 | 53 |
1 files changed, 30 insertions, 23 deletions
@@ -38,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 @@ -120,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 @@ -162,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 @@ -314,7 +321,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 |