=================================================================== RCS file: /cvs/mandoc/apropos.1,v retrieving revision 1.12 retrieving revision 1.17 diff -u -p -r1.12 -r1.17 --- mandoc/apropos.1 2011/11/29 10:59:19 1.12 +++ mandoc/apropos.1 2012/03/24 01:46:25 1.17 @@ -1,6 +1,6 @@ -.\" $Id: apropos.1,v 1.12 2011/11/29 10:59:19 kristaps Exp $ +.\" $Id: apropos.1,v 1.17 2012/03/24 01:46:25 kristaps Exp $ .\" -.\" Copyright (c) 2011 Kristaps Dzonsons +.\" Copyright (c) 2011, 2012 Kristaps Dzonsons .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -14,7 +14,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: November 29 2011 $ +.Dd $Mdocdate: March 24 2012 $ .Dt APROPOS 1 .Os .Sh NAME @@ -22,11 +22,12 @@ .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 S Ar arch .Op Fl s Ar section -.Ar expression... +.Ar expression ... .Sh DESCRIPTION The .Nm @@ -35,8 +36,28 @@ utility queries manual page databases generated by evaluating on .Ar expression for each file in each database. +.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 +over manual names and descriptions. +Multiple terms imply pairwise +.Fl o . +If standard output is a TTY, a result may be selected from a list and +its manual displayed with the pager. +.Pp Its arguments are as follows: .Bl -tag -width Ds +.It Fl C Ar file +Specify an alternative configuration +.Ar file +in +.Xr man.conf 5 +format. .It Fl M Ar manpath Use the colon-separated path instead of the default list of paths searched for @@ -119,18 +140,6 @@ is evaluated case-insensitively. Has no effect on substring terms. .El .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 -over manual names and descriptions -.Pq the Li \&Nm No and Li \&Nd No macro keys . -Multiple terms imply pairwise -.Fl o . Results are sorted by manual title, with output formatted as .Pp .D1 title(sec) \- description @@ -147,13 +156,21 @@ If an architecture is specified for the manual, it is .Pp .D1 title(cat/arch) \- description .Pp -Resulting manuals may be accessed as +If on a TTY, results are prefixed with a numeric identifier. .Pp -.Dl $ man \-s sec title +.D1 [index] title(cat) \- description .Pp -If an architecture is specified in the output, use -.Pp -.Dl $ man \-s sec \-S arch title +One may choose a manual be entering the index at the prompt. +Valid choices are displayed using +.Ev MANPAGER , +or failing that , +.Ev PAGER +or just +.Xr more 1 . +Source pages are formatted with +.Xr mandoc 1 ; +preformatted pages with +.Xr cat 1 . .Ss Macro Keys Queries evaluate over a subset of .Xr mdoc 7 @@ -231,13 +248,47 @@ Text production: .El .Sh ENVIRONMENT .Bl -tag -width Ds +.It Ev MANPAGER +Default pager for manuals. +If this is unset, falls back to +.Ev Pager . +.It Ev PAGER +The second choice for a manual pager. +If this is unset, use +.Xr more 1 . .It Ev MANPATH -Colon-separated paths overriding the default list of paths searched for +Colon-separated paths modifying the default list of paths searched for manual databases. Invalid paths, or paths without manual databases, are ignored. Overridden by .Fl M . +If +.Ev MANPATH +begins with a +.Sq \&: , +it is appended to the default list; +else if it ends with +.Sq \&: , +it is prepended to the default list; else if it contains +.Sq \&:: , +the default list is inserted between the colons. +If none of these conditions are met, it overrides the default list. .El +.Sh FILES +.Bl -tag -width "/etc/man.conf" -compact +.It Pa whatis.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 +configuration file +.El .Sh EXIT STATUS .Ex -std .Sh EXAMPLES @@ -266,7 +317,7 @@ as variable names in the library category: .Pp .Dl $ apropos \-s 3 Va~^optind \-a Va~^optarg$ .Sh SEE ALSO -.Xr man 1 , +.Xr more 1 .Xr re_format 7 , .Xr mandocdb 8 .Sh AUTHORS