=================================================================== RCS file: /cvs/mandoc/apropos.1,v retrieving revision 1.8 retrieving revision 1.25 diff -u -p -r1.8 -r1.25 --- mandoc/apropos.1 2011/11/23 10:09:30 1.8 +++ mandoc/apropos.1 2014/04/04 15:55:19 1.25 @@ -1,6 +1,7 @@ -.\" $Id: apropos.1,v 1.8 2011/11/23 10:09:30 kristaps Exp $ +.\" $Id: apropos.1,v 1.25 2014/04/04 15:55:19 schwarze Exp $ .\" -.\" Copyright (c) 2011 Kristaps Dzonsons +.\" 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,48 +15,85 @@ .\" 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 23 2011 $ +.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 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 O Ar outkey .Op Fl S Ar arch .Op Fl s Ar section -.Ar expression... +.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 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 . +.Nm whatis +maps terms only to case-sensitive manual names. +.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 -Append the colon-separated paths to the list of paths searched +.It Fl m Ar path +Prepend the colon-separated paths to the list of paths searched 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 -Search only for a particular architecture. -.It Fl s Ar cat -Search only for a manual section. +Restrict the search to pages for the specified +.Xr machine 1 +architecture. +.Ar arch +is case insensitive. +By default, pages for all architectures are shown. +.It Fl s Ar section +Restrict the search to the specified section of the manual. +By default, pages from all sections are shown. See .Xr man 1 -for a listing of manual sections. +for a listing of sections. .El .Pp An @@ -97,37 +135,33 @@ is satisfied. This has syntax .Li [key[,key]*(=~)]?val , where operand -.Li key +.Cm key is an .Xr mdoc 7 macro to query and -.Li val +.Cm val is its value. +See +.Sx Macro Keys +for a list of available keys. Operator .Li \&= evaluates a substring, while .Li \&~ evaluates a regular expression. .It Fl i Ar term -Same as -.Ar term , -but +If .Ar term +is a regular expression, it 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 macros . -Multiple terms imply pairwise -.Fl o . +.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 @@ -151,55 +185,197 @@ Resulting manuals may be accessed as If an architecture is specified in the output, use .Pp .Dl $ man \-s sec \-S arch title +.Ss Macro Keys +Queries evaluate over a subset of +.Xr mdoc 7 +macros indexed by +.Xr mandocdb 8 . +In addition to the macro keys listed below, the special key +.Cm any +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: +.Bl -column "xLix" description -offset indent -compact +.It Li \&Sh Ta section header (excluding standard sections) +.It Li \&Ss Ta subsection header +.It Li \&Xr Ta cross reference to another manual page +.It Li \&Rs Ta bibliographic reference +.El +.Pp +Semantic markup for command line utilities: +.Bl -column "xLix" description -offset indent -compact +.It Li \&Fl Ta command line options (flags) +.It Li \&Cm Ta command modifier +.It Li \&Ar Ta command argument +.It Li \&Ic Ta internal or interactive command +.It Li \&Ev Ta environmental variable +.It Li \&Pa Ta file system path +.El +.Pp +Semantic markup for function libraries: +.Bl -column "xLix" description -offset indent -compact +.It Li \&Lb Ta function library name +.It Li \&In Ta include file +.It Li \&Ft Ta function return type +.It Li \&Fn Ta function name +.It Li \&Fa Ta function argument type and name +.It Li \&Vt Ta variable type +.It Li \&Va Ta variable name +.It Li \&Dv Ta defined variable or preprocessor constant +.It Li \&Er Ta error constant +.It Li \&Ev Ta environmental variable +.El +.Pp +Various semantic markup: +.Bl -column "xLix" description -offset indent -compact +.It Li \&An Ta author name +.It Li \&Lk Ta hyperlink +.It Li \&Mt Ta Do mailto Dc hyperlink +.It Li \&Cd Ta kernel configuration declaration +.It Li \&Ms Ta mathematical symbol +.It Li \&Tn Ta tradename +.El +.Pp +Physical markup: +.Bl -column "xLix" description -offset indent -compact +.It Li \&Em Ta italic font or underline +.It Li \&Sy Ta boldface font +.It Li \&Li Ta typewriter font +.El +.Pp +Text production: +.Bl -column "xLix" description -offset indent -compact +.It Li \&St Ta reference to a standards document +.It Li \&At Ta At No version reference +.It Li \&Bx Ta Bx No version reference +.It Li \&Bsx Ta Bsx No version reference +.It Li \&Nx Ta Nx No version reference +.It Li \&Fx Ta Fx No version reference +.It Li \&Ox Ta Ox No version reference +.It Li \&Dx Ta Dx No version reference +.El .Sh ENVIRONMENT -.Bl -tag -width Ds +.Bl -tag -width MANPATH .It Ev MANPATH -Comma-separated paths overriding the default list of paths searched for -manual databases. +The standard search path used by +.Xr man 1 +may be changed by specifying a path in the +.Ev MANPATH +environment variable. Invalid paths, or paths without manual databases, are ignored. -Takes precedence over +Overridden by .Fl M . +If +.Ev MANPATH +begins with a colon, it is appended to the default list; +if it ends with a colon, it is prepended to the default list; +or if it contains two adjacent colons, +the standard search path is inserted between the colons. +If none of these conditions are met, it overrides the +standard search path. .El -.\" .Sh FILES +.Sh FILES +.Bl -tag -width "/etc/man.conf" -compact +.It Pa mandoc.db +name of the +.Xr mandocdb 8 +keyword database +.It Pa /etc/man.conf +default +.Xr man 1 +configuration file +.El .Sh EXIT STATUS .Ex -std .Sh EXAMPLES Search for -.Qq mdoc -within the manual name and description: +.Qq .cf +as a substring of manual names and descriptions: .Pp -.Dl $ apropos mdoc +.Dl $ apropos .cf .Pp -Two variants of searching for -.Qq mdoc , -.Qq roff , -or -.Qq man -within manual names and descriptions: +Include matches for +.Qq .cnf +and +.Qq .conf +as well: .Pp -.Dl $ apropos mdoc roff man -.Dl $ apropos mdoc \-o roff \-o man +.Dl $ apropos .cf .cnf .conf .Pp -Search for +Search in names and descriptions using a regular expression: +.Pp +.Dl $ apropos '~set.?[ug]id' +.Pp +Search for manuals in the library category mentioning both the .Qq optind -and +and the .Qq optarg -as variable names in the library category: +variables: .Pp -.Dl $ apropos \-s 3 \(dqVa~^optind$\(dq -a \(dqVa~^optarg$\(dq +.Dl $ apropos \-s 3 Va=optind \-a Va=optarg .Pp -Search for all manuals referencing -.Qq POSIX -in any letter case: +Do exactly the same as calling +.Xr whatis 1 +with the argument +.Qq ssh : .Pp -.Dl $ apropos \-\- \-i posix +.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 mandoc 1 , -.Xr re_format 7 -.Sh AUTHORS +.Xr re_format 7 , +.Xr mandocdb 8 +.Sh HISTORY +An +.Nm +utility first appeared in +.Bx 2 . +It was rewritten from scratch for +.Ox 5.6 . +.Pp The +.Fl M +option and the +.Ev MANPATH +variable first appeared in +.Bx 4.3 ; +.Fl m +in +.Bx 4.3 Reno ; +.Fl C +in +.Bx 4.4 Lite1 ; +and +.Fl S +and +.Fl s +in +.Ox 4.5 . +.Sh AUTHORS +.An -nosplit +.An Bill Joy +wrote the original +.Bx .Nm -utility was written by -.An Kristaps Dzonsons , -.Mt kristaps@bsd.lv . +in February 1979. +The current version was written by +.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv +and +.An Ingo Schwarze Aq Mt schwarze@openbsd.org .