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

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

version 1.11, 2011/11/29 10:53:42 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 22 
Line 22 
 .Nd search manual page databases  .Nd search manual page databases
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm  .Nm
   .Op Fl C Ar file
 .Op Fl M Ar manpath  .Op Fl M Ar manpath
 .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
 .Ar expression...  .Ar expression ...
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm  .Nm
Line 35  utility queries manual page databases generated by
Line 36  utility queries manual page databases generated by
 evaluating on  evaluating on
 .Ar expression  .Ar expression
 for each file in each database.  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  .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
Line 119  is evaluated case-insensitively.
Line 140  is evaluated case-insensitively.
 Has no effect on substring terms.  Has no effect on substring terms.
 .El  .El
 .Pp  .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 .  
 Results are sorted by manual title, with output formatted as  Results are sorted by manual title, with output formatted as
 .Pp  .Pp
 .D1 title(sec) \- description  .D1 title(sec) \- description
Line 147  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.
 .Pp  Valid choices are displayed using
 .Dl $ man \-s sec \-S arch title  .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  .Ss Macro Keys
 Queries evaluate over a subset of  Queries evaluate over a subset of
 .Xr mdoc 7  .Xr mdoc 7
Line 231  Text production:
Line 248  Text production:
 .El  .El
 .Sh ENVIRONMENT  .Sh ENVIRONMENT
 .Bl -tag -width Ds  .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  .It Ev MANPATH
 Colon-separated paths overriding the default list of paths searched for  Colon-separated paths modifying the default list of paths searched for
 manual databases.  manual databases.
 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
   .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  .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 mdoc  .Qq mdoc
 as a substring and regular expression  as a substring and regular expression
 within each manual name and description:  within each manual name and description:
 .Pp  .Pp
 .Dl $ apropos mdoc  .Dl $ apropos mdoc
Line 266  as variable names in the library category:
Line 317  as variable names in the library category:
 .Pp  .Pp
 .Dl $ apropos \-s 3 Va~^optind \-a Va~^optarg$  .Dl $ apropos \-s 3 Va~^optind \-a Va~^optarg$
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr man 1 ,  .Xr more 1
 .Xr re_format 7 ,  .Xr re_format 7 ,
 .Xr mandocdb 8  .Xr mandocdb 8
 .Sh AUTHORS  .Sh AUTHORS
Legend:
Removed from v.1.11  
changed lines
  Added in v.1.17
CVSweb