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

Diff for /mandoc/apropos.1 between version 1.16.2.4 and 1.18

version 1.16.2.4, 2014/03/17 09:52:42 version 1.18, 2012/06/08 10:44:52
Line 23 
Line 23 
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm  .Nm
 .Op Fl C Ar file  .Op Fl C Ar file
 .Op Fl M Ar path  .Op Fl M Ar manpath
 .Op Fl m Ar path  .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
 .Ar expression ...  .Ar expression ...
Line 42  By default,
Line 42  By default,
 searches for  searches for
 .Xr mandocdb 8  .Xr mandocdb 8
 databases in the default paths stipulated by  databases in the default paths stipulated by
 .Xr man 1 ,  .Xr man 1
 parses terms as case-sensitive regular expressions  and
 .Pq the Li \&~ operator  parses terms as case-sensitive words
 over manual names and descriptions  over manual names and descriptions.
 .Pq the Li \&Nm No and Li \&Nd No macro keys .  Multiple terms are OR'd.
 Multiple terms imply pairwise  
 .Fl o .  
 .Pp  .Pp
 Its arguments are as follows:  Its arguments are as follows:
 .Bl -tag -width Ds  .Bl -tag -width Ds
Line 58  Specify an alternative configuration
Line 56  Specify an alternative configuration
 in  in
 .Xr man.conf 5  .Xr man.conf 5
 format.  format.
 .It Fl M Ar path  .It Fl M Ar manpath
 Use the colon-separated path instead of the default list of paths  Use the colon-separated path instead of the default list of paths
 searched for  searched for
 .Xr mandocdb 8  .Xr mandocdb 8
 databases.  databases.
 Invalid paths, or paths without manual databases, are ignored.  Invalid paths, or paths without manual databases, are ignored.
 .It Fl m Ar path  .It Fl m Ar manpath
 Prepend the colon-separated paths to the list of paths searched  Prepend the colon-separated paths to the list of paths searched
 for  for
 .Xr mandocdb 8  .Xr mandocdb 8
 databases.  databases.
 Invalid paths, or paths without manual databases, are ignored.  Invalid paths, or paths without manual databases, are ignored.
 .It Fl S Ar arch  .It Fl S Ar arch
 Restrict the search to pages for the specified  Search only for a particular architecture.
 .Xr machine 1  .It Fl s Ar cat
 architecture.  Search only for a manual section.
 .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  See
 .Xr man 1  .Xr man 1
 for a listing of sections.  for a listing of manual sections.
 .El  .El
 .Pp  .Pp
 An  An
 .Ar expression  .Ar expression
 consists of search terms joined by logical operators  consists of type and keyword pairs.
 .Fl a  This pair syntax
 .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 ,  .Li [key[,key]*(=~)]?val ,
 where operand  where operand
 .Cm key  .Cm key
Line 135  See
Line 94  See
 for a list of available keys.  for a list of available keys.
 Operator  Operator
 .Li \&=  .Li \&=
 evaluates a substring, while  evaluates a full string, while
 .Li \&~  .Li \&~
 evaluates a regular expression.  evaluates a
 .It Fl i Ar term  .Xr glob 7
 If  pattern.
 .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  Results are sorted by manual title, with output formatted as
 .Pp  .Qq title(sec) \- description
 .D1 title(sec) \- description  where
 .Pp  
 Where  
 .Qq title  .Qq title
 is the manual's title (note multiple manual names may exist for one  is the manual's title (note multiple manual names may exist for one
 title),  title),
Line 159  is the manual section, and
Line 111  is the manual section, and
 .Qq description  .Qq description
 is the manual's short description.  is the manual's short description.
 If an architecture is specified for the manual, it is displayed as  If an architecture is specified for the manual, it is displayed as
 .Pp  .Qq title(cat/arch) \- description .
 .D1 title(cat/arch) \- description  
 .Pp  
 Resulting manuals may be accessed as  
 .Pp  
 .Dl $ man \-s sec title  
 .Pp  
 If an architecture is specified in the output, use  
 .Pp  
 .Dl $ man \-s sec \-S arch title  
 .Ss Macro Keys  .Ss Macro Keys
 Queries evaluate over a subset of  Queries evaluate over a subset of
 .Xr mdoc 7  .Xr mdoc 7
Line 245  Text production:
Line 188  Text production:
 .It Li \&Dx Ta Dx No version reference  .It Li \&Dx Ta Dx No version reference
 .El  .El
 .Sh ENVIRONMENT  .Sh ENVIRONMENT
 .Bl -tag -width MANPATH  .Bl -tag -width Ds
 .It Ev MANPATH  .It Ev MANPATH
 The standard search path used by  Colon-separated paths modifying the default list of paths searched for
 .Xr man 1  manual databases.
 may be changed by specifying a path in the  
 .Ev MANPATH  
 environment variable.  
 Invalid paths, or paths without manual databases, are ignored.  Invalid paths, or paths without manual databases, are ignored.
 Overridden by  Overridden by
 .Fl M .  .Fl M .
 If  If
 .Ev MANPATH  .Ev MANPATH
 begins with a colon, it is appended to the default list;  begins with a
 if it ends with a colon, it is prepended to the default list;  .Sq \&: ,
 or if it contains two adjacent colons,  it is appended to the default list;
 the standard search path is inserted between the colons.  else if it ends with
 If none of these conditions are met, it overrides the  .Sq \&: ,
 standard search path.  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  .El
 .Sh FILES  .Sh FILES
 .Bl -tag -width "/etc/man.conf" -compact  .Bl -tag -width "/etc/man.conf" -compact
 .It Pa mandoc.db  .It Pa whatis.db
 name of the  name of the
 .Xr mandocdb 8  .Xr mandocdb 8
 keyword database  keyword database
 .It Pa mandoc.index  .It Pa whatis.index
 name of the  name of the
 .Xr mandocdb 8  .Xr mandocdb 8
 filename database  filename database
Line 283  configuration file
Line 226  configuration file
 .Ex -std  .Ex -std
 .Sh EXAMPLES  .Sh EXAMPLES
 Search for  Search for
 .Qq .cf  .Qq mdoc
 as a substring of manual names and descriptions:  as a word or
   .Xr glob 7
   expression:
 .Pp  .Pp
 .Dl $ apropos .cf  .Dl $ apropos mdoc
   .Dl $ apropos any~mdoc*
 .Pp  .Pp
 Include matches for  Include matches for
 .Qq .cnf  .Qq roff
 and  and
 .Qq .conf  .Qq man
 as well:  using
   .Xr glob 7
   expressions:
 .Pp  .Pp
 .Dl $ apropos .cf .cnf .conf  .Dl $ apropos ~*mdoc* ~*roff*
 .Pp  .Pp
 Search in names and descriptions using a regular expression:  Search for
 .Pp  
 .Dl $ apropos '~set.?[ug]id'  
 .Pp  
 Search for manuals in the library category mentioning both the  
 .Qq optind  
 and the  
 .Qq optarg  .Qq optarg
 variables:  as a variable name in the library category:
 .Pp  .Pp
 .Dl $ apropos \-s 3 Va=optind \-a Va=optarg  .Dl $ apropos \-s 3 Va=optarg
 .Pp  
 Do exactly the same as calling  
 .Xr whatis 1  
 with the argument  
 .Qq ssh :  
 .Pp  
 .Dl $ apropos \-\- \-i 'Nm~[[:<:]]ssh[[:>:]]'  
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr man 1 ,  .Xr glob 7 ,
 .Xr re_format 7 ,  
 .Xr mandocdb 8  .Xr mandocdb 8
 .Sh HISTORY  
 An  
 .Nm  
 utility first appeared in  
 .Bx 2 .  
 It was rewritten from scratch for  
 .Ox 5.1 .  
 .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  .Sh AUTHORS
 .An -nosplit  The
 .An Bill Joy  
 wrote the original  
 .Bx  
 .Nm  .Nm
 in February 1979.  utility was written by
 The current version was written by  .An Kristaps Dzonsons ,
 .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .  .Mt kristaps@bsd.lv .
Legend:
Removed from v.1.16.2.4  
changed lines
  Added in v.1.18
CVSweb