=================================================================== RCS file: /cvs/mandoc/apropos.1,v retrieving revision 1.16.2.4 retrieving revision 1.25 diff -u -p -r1.16.2.4 -r1.25 --- mandoc/apropos.1 2014/03/17 09:52:42 1.16.2.4 +++ mandoc/apropos.1 2014/04/04 15:55:19 1.25 @@ -1,6 +1,7 @@ -.\" $Id: apropos.1,v 1.16.2.4 2014/03/17 09:52:42 schwarze Exp $ +.\" $Id: apropos.1,v 1.25 2014/04/04 15:55:19 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,24 +15,28 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: March 17 2014 $ +.Dd $Mdocdate: April 4 2014 $ .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 path .Op Fl m Ar path +.Op Fl O Ar outkey .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 @@ -49,6 +54,8 @@ over manual names and descriptions .Pq the Li \&Nm No and Li \&Nd No macro keys . Multiple terms imply pairwise .Fl o . +.Nm whatis +maps terms only to case-sensitive manual names. .Pp Its arguments are as follows: .Bl -tag -width Ds @@ -70,6 +77,10 @@ for .Xr mandocdb 8 databases. Invalid paths, or paths without manual databases, are ignored. +.It Fl O Ar outkey +Show the values associated with the key +.Ar outkey +instead of the manual descriptions. .It Fl S Ar arch Restrict the search to pages for the specified .Xr machine 1 @@ -146,6 +157,11 @@ 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 title, with output formatted as .Pp .D1 title(sec) \- description @@ -180,8 +196,11 @@ may be used to match any available macro key. .Pp Names and description: .Bl -column "xLix" description -offset indent -compact +.It Li NAME Ta manual name in the NAME section, subset of \&Nm .It Li \&Nm Ta manual name .It Li \&Nd Ta one-line manual description +.It Li arch Ta machine architecture (case-insensitive) +.It Li sec Ta manual section number .El .Pp Sections and cross references: @@ -270,10 +289,6 @@ standard search path. name of the .Xr mandocdb 8 keyword database -.It Pa mandoc.index -name of the -.Xr mandocdb 8 -filename database .It Pa /etc/man.conf default .Xr man 1 @@ -314,6 +329,15 @@ with the argument .Qq ssh : .Pp .Dl $ apropos \-\- \-i 'Nm~[[:<:]]ssh[[:>:]]' +.Pp +The following two invocations are equivalent: +.Pp +.D1 Li $ apropos -S Ar arch Li -s Ar section expression +.Bd -ragged -offset indent +.Li $ apropos \e( Ar expression Li \e) +.Li -a arch~^( Ns Ar arch Ns Li |any)$ +.Li -a sec~^ Ns Ar section Ns Li $ +.Ed .Sh SEE ALSO .Xr man 1 , .Xr re_format 7 , @@ -324,7 +348,7 @@ An utility first appeared in .Bx 2 . It was rewritten from scratch for -.Ox 5.1 . +.Ox 5.6 . .Pp The .Fl M @@ -352,4 +376,6 @@ wrote the original .Nm in February 1979. The current version was written by -.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . +.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv +and +.An Ingo Schwarze Aq Mt schwarze@openbsd.org .