mandoc/apropos.1 - diff

Return to apropos.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/apropos.1 between version 1.3 and 1.4

-version 1.3, 2011/11/09 10:53:48
+version 1.4, 2011/11/18 07:02:19
 Line 22
 Line 22
 Line 22
  .Nd search the manual page database
  .Sh SYNOPSIS
  .Nm
- .Op Fl I
  .Op Fl S Ar arch
  .Op Fl s Ar section
- .Op Fl t Ar types
+ .Ar expression...
- .Ar pattern
  .Sh DESCRIPTION
  The
  .Nm
- utility queries the manual page database.
+ utility queries a manual page database generated by
+ .Xr mandocdb 8 ,
+ evaluating on
+ .Ar expression
+ for each file in the database.
  Its arguments are as follows:
  .Bl -tag -width Ds
  .It Fl S Ar arch
-Line 40  Search only for a manual section.
+Line 42  Search only for a manual section.
 Line 40  Search only for a manual section.
 Line 42  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.
+ .Pp
+ .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
+ .Li key
+ is an
+ .Xr mdoc 7
+ macro to query and
+ .Li val
+ is its value.
+ 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
+ parses terms as case-sensitive regular expressions
- .Ar pattern
+ .Pq the Li \&~ operator
- in manual names and descriptions
+ over manual names and descriptions
- and displays results sorted by manual title.
+ .Pq the Li \&Nm No and Li \&Nd No macros .
- Output is formatted as
+ Multiple terms imply pairwise
+ .Fl o .
+ Results are sorted by manual title, with output formatted as
  .Pp
  .D1 title(sec) \- description
  .Pp
-Line 119  If an architecture is specified in the output, use
+Line 145  If an architecture is specified in the output, use
 Line 119  If an architecture is specified in the output, use
 Line 145  If an architecture is specified in the output, use
  .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
+ .Dl $ apropos \-\- \-i posix
  .\" .Sh DIAGNOSTICS
  .\" For sections 1, 4, 6, 7, & 8 only.
  .\" .Sh ERRORS

CVSweb