=================================================================== RCS file: /cvs/mandoc/apropos.1,v retrieving revision 1.30 retrieving revision 1.32 diff -u -p -r1.30 -r1.32 --- mandoc/apropos.1 2014/08/21 01:52:59 1.30 +++ mandoc/apropos.1 2014/08/22 03:42:18 1.32 @@ -1,4 +1,4 @@ -.\" $Id: apropos.1,v 1.30 2014/08/21 01:52:59 schwarze Exp $ +.\" $Id: apropos.1,v 1.32 2014/08/22 03:42:18 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: August 21 2014 $ +.Dd $Mdocdate: August 22 2014 $ .Dt APROPOS 1 .Os .Sh NAME @@ -24,6 +24,7 @@ .Nd search manual page databases .Sh SYNOPSIS .Nm +.Op Fl acfkw .Op Fl C Ar file .Op Fl M Ar path .Op Fl m Ar path @@ -56,17 +57,63 @@ 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. +If the standard output is a terminal device and +.Fl c +is not specified, use +.Xr more 1 +to paginate them. +In +.Fl a +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 c +In +.Fl a +mode, copy the formatted manual pages to the standard output without using +.Xr more 1 +to paginate them. +.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 @@ -96,6 +143,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 @@ -164,11 +217,6 @@ is a regular expression, it 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