=================================================================== RCS file: /cvs/mandoc/apropos.1,v retrieving revision 1.27 retrieving revision 1.31 diff -u -p -r1.27 -r1.31 --- mandoc/apropos.1 2014/04/18 09:47:09 1.27 +++ mandoc/apropos.1 2014/08/21 02:28:40 1.31 @@ -1,4 +1,4 @@ -.\" $Id: apropos.1,v 1.27 2014/04/18 09:47:09 schwarze Exp $ +.\" $Id: apropos.1,v 1.31 2014/08/21 02:28:40 schwarze Exp $ .\" .\" Copyright (c) 2011, 2012 Kristaps Dzonsons .\" Copyright (c) 2011, 2012, 2014 Ingo Schwarze @@ -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 18 2014 $ +.Dd $Mdocdate: August 21 2014 $ .Dt APROPOS 1 .Os .Sh NAME @@ -24,6 +24,7 @@ .Nd search manual page databases .Sh SYNOPSIS .Nm +.Op Fl afkw .Op Fl C Ar file .Op Fl M Ar path .Op Fl m Ar path @@ -37,17 +38,17 @@ The and .Nm whatis utilities query manual page databases generated by -.Xr mandocdb 8 , +.Xr makewhatis 8 , evaluating .Ar expression for each file in each database. -By default, it displays the names, section numbers, and description lines +By default, they display the names, section numbers, and description lines of all matching manuals. .Pp By default, .Nm searches for -.Xr mandocdb 8 +.Xr makewhatis 8 databases in the default paths stipulated by .Xr man 1 and uses case-insensitive substring matching @@ -56,27 +57,60 @@ over manual names and descriptions .Pq the Li \&Nm No and Li \&Nd No macro keys . Multiple terms imply pairwise .Fl o . +.Pp .Nm whatis -maps terms only to case-sensitive manual names. +is a synonym for +.Nm +.Fl f . .Pp -Its arguments are as follows: +The options are as follows: .Bl -tag -width Ds +.It Fl a +Instead of showing only the title lines, show the complete manual pages, +just like +.Xr man 1 +.Fl a +would. +In this mode, the options +.Fl IOTW +described in the +.Xr mandoc 1 +manual are also available. .It Fl C Ar file Specify an alternative configuration .Ar file in .Xr man.conf 5 format. +.It Fl f +Search for all words in +.Ar expression +in manual page names only. +The search is case insensitive and matches whole words only. +In this mode, macro keys, comparison operators, and logical operators +are not available. +This overrides any earlier +.Fl k +option. +.It Fl k +Support the full +.Ar expression +syntax. +This overrides any earlier +.Fl f +option. +It is the default for +.Nm . .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 -.Xr mandocdb 8 +.Xr makewhatis 8 databases. Invalid paths, or paths without manual databases, are ignored. .It Fl O Ar outkey @@ -96,6 +130,12 @@ By default, pages from all sections are shown. See .Xr man 1 for a listing of sections. +.It Fl w +Instead of showing title lines, show the pathnames of the matching +manual pages, just like +.Xr man 1 +.Fl w +would. .El .Pp An @@ -140,8 +180,8 @@ This has syntax .Op Ar key Op , Ar key ... .Pq Cm = | ~ .Oc -.Ar val -.Sm on , +.Ar val , +.Sm on where .Ar key is an @@ -165,11 +205,6 @@ is evaluated case-insensitively. Has no effect on substring terms. .El .Pp -.Nm whatis -considers an -.Ar expression -to consist of an opaque keyword. -.Pp Results are sorted by manual sections and names, with output formatted as .Pp .D1 name[, name...](sec) \- description @@ -196,7 +231,7 @@ If an architecture is specified in the output, use 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. @@ -293,7 +328,7 @@ standard search path. .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 @@ -347,13 +382,21 @@ The following two invocations are equivalent: .Sh SEE ALSO .Xr man 1 , .Xr re_format 7 , -.Xr mandocdb 8 +.Xr makewhatis 8 .Sh HISTORY -An +Part of the functionality of +.Nm whatis +was already provided by the former +.Nm manwhere +utility in +.Bx 1 . +The .Nm -utility first appeared in +and +.Nm whatis +utilities first appeared in .Bx 2 . -It was rewritten from scratch for +They were rewritten from scratch for .Ox 5.6 . .Pp The @@ -373,13 +416,23 @@ and and .Fl s in -.Ox 4.5 . +.Ox 4.5 +for +.Nm +and in +.Ox 5.6 +for +.Nm whatis . .Sh AUTHORS .An -nosplit .An Bill Joy -wrote the original +wrote +.Nm manwhere +in 1977 and the original .Bx .Nm +and +.Nm whatis in February 1979. The current version was written by .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv