[BACK]Return to apropos.1 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

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

version 1.3, 2011/11/09 10:53:48 version 1.17, 2012/03/24 01:46:25
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>  .\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"  .\"
 .\" Permission to use, copy, modify, and distribute this software for any  .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above  .\" purpose with or without fee is hereby granted, provided that the above
Line 19 
Line 19 
 .Os  .Os
 .Sh NAME  .Sh NAME
 .Nm apropos  .Nm apropos
 .Nd search the manual page database  .Nd search manual page databases
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm  .Nm
 .Op Fl I  .Op Fl C Ar file
   .Op Fl M Ar manpath
   .Op Fl m Ar manpath
 .Op Fl S Ar arch  .Op Fl S Ar arch
 .Op Fl s Ar section  .Op Fl s Ar section
 .Op Fl t Ar types  .Ar expression ...
 .Ar pattern  
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm  .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.
   .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:  Its arguments are as follows:
 .Bl -tag -width Ds  .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
   .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  .It Fl S Ar arch
 Search only for a particular architecture.  Search only for a particular architecture.
 .It Fl s Ar cat  .It Fl s Ar cat
Line 40  Search only for a manual section.
Line 77  Search only for a manual section.
 See  See
 .Xr man 1  .Xr man 1
 for a listing of manual sections.  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  .El
 .Pp  .Pp
 By default,  An
 .Nm  .Ar expression
 searches for pattern matches of  consists of search terms joined by logical operators
 .Ar pattern  .Fl a
 in manual names and descriptions  .Pq and
 and displays results sorted by manual title.  and
 Output is formatted as  .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
   If
   .Ar term
   is a regular expression, it
   is evaluated case-insensitively.
   Has no effect on substring terms.
   .El
 .Pp  .Pp
   Results are sorted by manual title, with output formatted as
   .Pp
 .D1 title(sec) \- description  .D1 title(sec) \- description
 .Pp  .Pp
 Where  Where
Line 101  If an architecture is specified for the manual, it is 
Line 156  If an architecture is specified for the manual, it is 
 .Pp  .Pp
 .D1 title(cat/arch) \- description  .D1 title(cat/arch) \- description
 .Pp  .Pp
 Resulting manuals may be accessed as  If on a TTY, results are prefixed with a numeric identifier.
 .Pp  .Pp
 .Dl $ man \-s sec title  .D1 [index] title(cat) \- description
 .Pp  .Pp
 If an architecture is specified in the output, use  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
   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  .Pp
 .Dl $ man \-s sec \-S arch title  Names and description:
 .\" .Sh IMPLEMENTATION NOTES  .Bl -column "xLix" description -offset indent -compact
 .\" Not used in OpenBSD.  .It Li \&Nm Ta manual name
 .\" .Sh RETURN VALUES  .It Li \&Nd Ta one-line manual description
 .\" For sections 2, 3, & 9 only.  .El
 .\" .Sh ENVIRONMENT  .Pp
 .\" For sections 1, 6, 7, & 8 only.  Sections and cross references:
 .\" .Sh FILES  .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 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 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  .Sh EXIT STATUS
 .Ex -std  .Ex -std
 .Sh EXAMPLES  .Sh EXAMPLES
 Search for  Search for
 .Qq optind  .Qq mdoc
 as a variable name in the library category:  as a substring and regular expression
   within each manual name and description:
 .Pp  .Pp
 .Dl $ apropos \-tvar \-s 3 optind  .Dl $ apropos mdoc
   .Dl $ apropos ~^mdoc$
 .Pp  .Pp
 Search for all manuals referencing the term  Include matches for
 .Qq POSIX  .Qq roff
 in any letter case:  and
   .Qq man
   for the regular expression case:
 .Pp  .Pp
 .Dl $ apropos \-tall \-I posix  .Dl $ apropos ~^mdoc$ roff man
 .\" .Sh DIAGNOSTICS  .Dl $ apropos ~^mdoc$ \-o roff \-o man
 .\" For sections 1, 4, 6, 7, & 8 only.  .Pp
 .\" .Sh ERRORS  Search for
 .\" For sections 2, 3, & 9 only.  .Qq optind
   and
   .Qq optarg
   as variable names in the library category:
   .Pp
   .Dl $ apropos \-s 3 Va~^optind \-a Va~^optarg$
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr man 1 ,  .Xr more 1
 .Xr mandoc 1 ,  .Xr re_format 7 ,
 .Xr re_format 7  .Xr mandocdb 8
 .\" .Sh STANDARDS  
 .\" .Sh HISTORY  
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm
 utility was written by  utility was written by
 .An Kristaps Dzonsons ,  .An Kristaps Dzonsons ,
 .Mt kristaps@bsd.lv .  .Mt kristaps@bsd.lv .
 .\" .Sh CAVEATS  
 .\" .Sh BUGS  
 .\" .Sh SECURITY CONSIDERATIONS  
 .\" Not used in OpenBSD.  
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.17
CVSweb