=================================================================== RCS file: /cvs/mandoc/apropos.1,v retrieving revision 1.11 retrieving revision 1.16.2.3 diff -u -p -r1.11 -r1.16.2.3 --- mandoc/apropos.1 2011/11/29 10:53:42 1.11 +++ mandoc/apropos.1 2013/10/05 01:25:20 1.16.2.3 @@ -1,4 +1,4 @@ -.\" $Id: apropos.1,v 1.11 2011/11/29 10:53:42 kristaps Exp $ +.\" $Id: apropos.1,v 1.16.2.3 2013/10/05 01:25:20 schwarze Exp $ .\" .\" Copyright (c) 2011 Kristaps Dzonsons .\" @@ -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: October 5 2013 $ .Dt APROPOS 1 .Os .Sh NAME @@ -22,11 +22,12 @@ .Nd search manual page databases .Sh SYNOPSIS .Nm -.Op Fl M Ar manpath -.Op Fl m Ar manpath +.Op Fl C Ar file +.Op Fl M Ar path +.Op Fl m Ar path .Op Fl S Ar arch .Op Fl s Ar section -.Ar expression... +.Ar expression ... .Sh DESCRIPTION The .Nm @@ -35,15 +36,35 @@ 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 +.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 . +.Pp Its arguments are as follows: .Bl -tag -width Ds -.It Fl M Ar manpath +.It Fl C Ar file +Specify an alternative configuration +.Ar file +in +.Xr man.conf 5 +format. +.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 @@ -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 @@ -232,18 +241,44 @@ Text production: .Sh ENVIRONMENT .Bl -tag -width Ds .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 mandoc.db +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 +configuration file +.El .Sh EXIT STATUS .Ex -std .Sh EXAMPLES Search for .Qq mdoc -as a substring and regular expression +as a substring and regular expression within each manual name and description: .Pp .Dl $ apropos mdoc @@ -273,5 +308,4 @@ as variable names 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 .