===================================================================
RCS file: /cvs/mandoc/apropos.1,v
retrieving revision 1.3
retrieving revision 1.10
diff -u -p -r1.3 -r1.10
--- mandoc/apropos.1	2011/11/09 10:53:48	1.3
+++ mandoc/apropos.1	2011/11/29 00:41:33	1.10
@@ -1,4 +1,4 @@
-.\"	$Id: apropos.1,v 1.3 2011/11/09 10:53:48 kristaps Exp $
+.\"	$Id: apropos.1,v 1.10 2011/11/29 00:41:33 kristaps Exp $
 .\"
 .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
@@ -14,25 +14,41 @@
 .\" 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 9 2011 $
+.Dd $Mdocdate: November 29 2011 $
 .Dt APROPOS 1
 .Os
 .Sh NAME
 .Nm apropos
-.Nd search the manual page database
+.Nd search manual page databases
 .Sh SYNOPSIS
 .Nm
-.Op Fl I
+.Op Fl M Ar manpath
+.Op Fl m Ar manpath
 .Op Fl S Ar arch
 .Op Fl s Ar section
-.Op Fl t Ar types
-.Ar pattern
+.Ar expression...
 .Sh DESCRIPTION
 The
 .Nm
-utility queries the manual page database.
+utility queries manual page databases generated by
+.Xr mandocdb 8 ,
+evaluating on
+.Ar expression
+for each file in each database.
 Its arguments are as follows:
 .Bl -tag -width Ds
+.It Fl M Ar manpath
+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
+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 S Ar arch
 Search only for a particular architecture.
 .It Fl s Ar cat
@@ -40,52 +56,82 @@ Search only for a manual section.
 See
 .Xr man 1
 for a listing of manual sections.
-.It Fl I
-Case-insensitive pattern matching.
-.It Fl t Ar types
-Consider only types of keyword match, where
-.Ar types
-is a comma-separated list consisting of the following:
-.Ar name ,
-manual names;
-.Ar func ,
-function names;
-.Ar utility ,
-utility names;
-.Ar incl ,
-include files;
-.Ar var ,
-variable names;
-.Ar stand ,
-standards ;
-.Ar auth ,
-authors;
-.Ar conf ,
-configuration strings;
-.Ar desc ,
-descriptive text;
-.Ar xref ,
-cross-references.
-.Ar path ,
-file pathnames;
-.Ar env ,
-environment variables; or
-.Ar err ,
-error codes.
-Specifying
-.Ar all
-will search for all types.
-.It Ar key
-The search key.
 .El
 .Pp
+An
+.Ar expression
+consists of search terms joined by logical operators
+.Fl a
+.Pq and
+and
+.Fl o
+.Pq or .
+The
+.Fl a
+operator has precedence over
+.Fl o
+and both are evaluated left-to-right.
+.Bl -tag -width Ds
+.It \&( Ar expr No \&)
+True if the subexpression
+.Ar expr
+is true.
+.It Ar expr1 Fl a Ar expr2
+True if both
+.Ar expr1
+and
+.Ar expr2
+are true (logical
+.Qq and ) .
+.It Ar expr1 Oo Fl o Oc Ar expr2
+True if
+.Ar expr1
+and/or
+.Ar expr2
+evaluate to true (logical
+.Qq or ) .
+.It Ar term
+True if
+.Ar term
+is satisfied.
+This has syntax
+.Li [key[,key]*(=~)]?val ,
+where operand
+.Cm key
+is an
+.Xr mdoc 7
+macro to query and
+.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
+.Ar term
+is evaluated case-insensitively.
+.El
+.Pp
 By default,
 .Nm
-searches for pattern matches of
-.Ar pattern
-in manual names and descriptions
-and displays results sorted by manual title.
-Output is formatted as
+searches for
+.Xr mandocdb 8
+databases in the default paths stipulated by
+.Xr man 1 ,
+parses terms as case-insensitive 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
 .Pp
@@ -108,44 +154,130 @@ Resulting manuals may be accessed as
 If an architecture is specified in the output, use
 .Pp
 .Dl $ man \-s sec \-S arch title
-.\" .Sh IMPLEMENTATION NOTES
-.\" Not used in OpenBSD.
-.\" .Sh RETURN VALUES
-.\" For sections 2, 3, & 9 only.
-.\" .Sh ENVIRONMENT
-.\" For sections 1, 6, 7, & 8 only.
+.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 \&Nm Ta manual name
+.It Li \&Nd Ta one-line manual description
+.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
+.It Ev MANPATH
+Colon-separated paths overriding the default list of paths searched for
+manual databases.
+Invalid paths, or paths without manual databases, are ignored.
+Overridden by
+.Fl M .
+.El
 .\" .Sh FILES
 .Sh EXIT STATUS
 .Ex -std
 .Sh EXAMPLES
 Search for
+.Qq mdoc
+within the manual name and description:
+.Pp
+.Dl $ apropos mdoc
+.Pp
+Two variants of searching for
+.Qq mdoc ,
+.Qq roff ,
+or
+.Qq man
+within manual names and descriptions:
+.Pp
+.Dl $ apropos mdoc roff man
+.Dl $ apropos mdoc \-o roff \-o man
+.Pp
+Search for
 .Qq optind
-as a variable name in the library category:
+and
+.Qq optarg
+as variable names in the library category:
 .Pp
-.Dl $ apropos \-tvar \-s 3 optind
+.Dl $ apropos \-s 3 \(dqVa~^optind$\(dq -a \(dqVa~^optarg$\(dq
 .Pp
-Search for all manuals referencing the term
+Search for all manuals referencing
 .Qq POSIX
 in any letter case:
 .Pp
-.Dl $ apropos \-tall \-I posix
-.\" .Sh DIAGNOSTICS
-.\" For sections 1, 4, 6, 7, & 8 only.
-.\" .Sh ERRORS
-.\" For sections 2, 3, & 9 only.
+.Dl $ apropos \-\- \-i posix
 .Sh SEE ALSO
 .Xr man 1 ,
 .Xr mandoc 1 ,
 .Xr re_format 7
-.\" .Sh STANDARDS
-.\" .Sh HISTORY
 .Sh AUTHORS
 The
 .Nm
 utility was written by
 .An Kristaps Dzonsons ,
 .Mt kristaps@bsd.lv .
-.\" .Sh CAVEATS
-.\" .Sh BUGS
-.\" .Sh SECURITY CONSIDERATIONS
-.\" Not used in OpenBSD.