=================================================================== RCS file: /cvs/mandoc/apropos.1,v retrieving revision 1.18 retrieving revision 1.22 diff -u -p -r1.18 -r1.22 --- mandoc/apropos.1 2012/06/08 10:44:52 1.18 +++ mandoc/apropos.1 2013/10/01 20:56:18 1.22 @@ -1,4 +1,4 @@ -.\" $Id: apropos.1,v 1.18 2012/06/08 10:44:52 kristaps Exp $ +.\" $Id: apropos.1,v 1.22 2013/10/01 20:56:18 schwarze Exp $ .\" .\" Copyright (c) 2011, 2012 Kristaps Dzonsons .\" @@ -14,24 +14,27 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: June 8 2012 $ +.Dd $Mdocdate: October 1 2013 $ .Dt APROPOS 1 .Os .Sh NAME -.Nm apropos +.Nm apropos , +.Nm whatis .Nd search manual page databases .Sh SYNOPSIS .Nm .Op Fl C Ar file -.Op Fl M Ar manpath -.Op Fl m Ar manpath +.Op Fl M Ar path +.Op Fl m Ar path .Op Fl S Ar arch .Op Fl s Ar section .Ar expression ... .Sh DESCRIPTION The -.Nm -utility queries manual page databases generated by +.Nm apropos +and +.Nm whatis +utilities query manual page databases generated by .Xr mandocdb 8 , evaluating on .Ar expression @@ -44,9 +47,10 @@ searches for databases in the default paths stipulated by .Xr man 1 and -parses terms as case-sensitive words -over manual names and descriptions. +maps terms to case-sensitive manual names and descriptions. Multiple terms are OR'd. +.Nm whatis +maps terms only to case-sensitive manual names. .Pp Its arguments are as follows: .Bl -tag -width Ds @@ -56,13 +60,13 @@ Specify an alternative configuration in .Xr man.conf 5 format. -.It Fl M Ar manpath +.It Fl M Ar path Use the colon-separated path instead of the default list of paths searched for .Xr mandocdb 8 databases. Invalid paths, or paths without manual databases, are ignored. -.It Fl m Ar manpath +.It Fl m Ar path Prepend the colon-separated paths to the list of paths searched for .Xr mandocdb 8 @@ -77,9 +81,14 @@ See for a listing of manual sections. .El .Pp -An +.Nm whatis +considers an .Ar expression -consists of type and keyword pairs. +to consist of an opaque keyword. +.Nm apropos +parses a +.Ar expression +into type and keyword pairs. This pair syntax .Li [key[,key]*(=~)]?val , where operand @@ -113,7 +122,8 @@ is the manual's short description. If an architecture is specified for the manual, it is displayed as .Qq title(cat/arch) \- description . .Ss Macro Keys -Queries evaluate over a subset of +.Nm apropos +queries evaluate over a subset of .Xr mdoc 7 macros indexed by .Xr mandocdb 8 . @@ -209,14 +219,10 @@ If none of these conditions are met, it overrides the .El .Sh FILES .Bl -tag -width "/etc/man.conf" -compact -.It Pa whatis.db +.It Pa mandoc.db name of the .Xr mandocdb 8 keyword database -.It Pa whatis.index -name of the -.Xr mandocdb 8 -filename database .It Pa /etc/man.conf default .Xr man 1 @@ -256,5 +262,4 @@ as a variable name in the library category: The .Nm utility was written by -.An Kristaps Dzonsons , -.Mt kristaps@bsd.lv . +.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .