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

Diff for /mandoc/apropos.1 between version 1.14 and 1.37

version 1.14, 2011/12/24 22:37:16 version 1.37, 2015/02/16 16:23:54
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>  .\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
   .\" Copyright (c) 2011, 2012, 2014 Ingo Schwarze <schwarze@openbsd.org>
 .\"  .\"
 .\" 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 18 
Line 19 
 .Dt APROPOS 1  .Dt APROPOS 1
 .Os  .Os
 .Sh NAME  .Sh NAME
 .Nm apropos  .Nm apropos ,
   .Nm whatis
 .Nd search manual page databases  .Nd search manual page databases
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm  .Nm
   .Op Fl acfhklw
 .Op Fl C Ar file  .Op Fl C Ar file
 .Op Fl M Ar manpath  .Op Fl M Ar path
 .Op Fl m Ar manpath  .Op Fl m Ar path
   .Op Fl O Ar outkey
 .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 apropos
 utility queries manual page databases generated by  and
 .Xr mandocdb 8 ,  .Nm whatis
 evaluating on  utilities query manual page databases generated by
   .Xr makewhatis 8 ,
   evaluating
 .Ar expression  .Ar expression
 for each file in each database.  for each file in each database.
 Its arguments are as follows:  By default, they display the names, section numbers, and description lines
   of all matching manuals.
   .Pp
   By default,
   .Nm
   searches for
   .Xr makewhatis 8
   databases in the default paths stipulated by
   .Xr man 1
   and uses case-insensitive substring matching
   .Pq the Cm = No operator
   over manual names and descriptions
   .Pq the Li \&Nm No and Li \&Nd No macro keys .
   Multiple terms imply pairwise
   .Fl o .
   .Pp
   .Nm whatis
   is a synonym for
   .Nm
   .Fl f .
   .Pp
   The options are as follows:
 .Bl -tag -width Ds  .Bl -tag -width Ds
   .It Fl a
   Instead of showing only the title lines, show the complete manual pages,
   just like
   .Xr man 1
   .Fl a
   would.
   If the standard output is a terminal device and
   .Fl c
   is not specified, use
   .Xr more 1
   to paginate them.
   In
   .Fl a
   mode, the options
   .Fl IKOTW
   described in the
   .Xr mandoc 1
   manual are also available.
 .It Fl C Ar file  .It Fl C Ar file
 Specify an alternative configuration  Specify an alternative configuration
 .Ar file  .Ar file
 in  in
 .Xr man.conf 5  .Xr man.conf 5
 format.  format.
 .It Fl M Ar manpath  .It Fl c
   In
   .Fl a
   mode, copy the formatted manual pages to the standard output without using
   .Xr more 1
   to paginate them.
   .It Fl f
   Search for all words in
   .Ar expression
   in manual page names only.
   The search is case insensitive and matches whole words only.
   In this mode, macro keys, comparison operators, and logical operators
   are not available.
   This overrides any earlier
   .Fl k
   and
   .Fl l
   options.
   .It Fl h
   Instead of showing the title lines, show the SYNOPSIS sections, just like
   .Xr man 1
   .Fl h
   would.
   .It Fl k
   Support the full
   .Ar expression
   syntax.
   This overrides any earlier
   .Fl f
   and
   .Fl l
   options.
   It is the default for
   .Nm .
   .It Fl l
   An alias for
   .Xr mandoc 1
   .Fl a .
   This overrides any earlier
   .Fl f ,
   .Fl k ,
   and
   .Fl w
   options.
   .It Fl M Ar path
 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 makewhatis 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 manpath  .It Fl m Ar path
 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 makewhatis 8
 databases.  databases.
 Invalid paths, or paths without manual databases, are ignored.  Invalid paths, or paths without manual databases, are ignored.
   .It Fl O Ar outkey
   Show the values associated with the key
   .Ar outkey
   instead of the manual descriptions.
 .It Fl S Ar arch  .It Fl S Ar arch
 Search only for a particular architecture.  Restrict the search to pages for the specified
 .It Fl s Ar cat  .Xr machine 1
 Search only for a manual section.  architecture.
   .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 manual sections.  for a listing of sections.
   .It Fl w
   Instead of showing title lines, show the pathnames of the matching
   manual pages, just like
   .Xr man 1
   .Fl w
   would.
 .El  .El
 .Pp  .Pp
 An  An
Line 89  True if both
Line 194  True if both
 and  and
 .Ar expr2  .Ar expr2
 are true (logical  are true (logical
 .Qq and ) .  .Sq and ) .
 .It Ar expr1 Oo Fl o Oc Ar expr2  .It Ar expr1 Oo Fl o Oc Ar expr2
 True if  True if
 .Ar expr1  .Ar expr1
 and/or  and/or
 .Ar expr2  .Ar expr2
 evaluate to true (logical  evaluate to true (logical
 .Qq or ) .  .Sq or ) .
 .It Ar term  .It Ar term
 True if  True if
 .Ar term  .Ar term
 is satisfied.  is satisfied.
 This has syntax  This has syntax
 .Li [key[,key]*(=~)]?val ,  .Sm off
 where operand  .Oo
 .Cm key  .Op Ar key Op , Ar key ...
   .Pq Cm = | ~
   .Oc
   .Ar val ,
   .Sm on
   where
   .Ar key
 is an  is an
 .Xr mdoc 7  .Xr mdoc 7
 macro to query and  macro to query and
 .Cm val  .Ar val
 is its value.  is its value.
 See  See
 .Sx Macro Keys  .Sx Macro Keys
 for a list of available keys.  for a list of available keys.
 Operator  Operator
 .Li \&=  .Cm =
 evaluates a substring, while  evaluates a substring, while
 .Li \&~  .Cm ~
 evaluates a regular expression.  evaluates a regular expression.
 .It Fl i Ar term  .It Fl i Ar term
 If  If
Line 126  is evaluated case-insensitively.
Line 237  is evaluated case-insensitively.
 Has no effect on substring terms.  Has no effect on substring terms.
 .El  .El
 .Pp  .Pp
 By default,  Results are sorted by manual sections and names, with output formatted as
 .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  
 .Pp  .Pp
 .D1 title(sec) \- description  .D1 name[, name...](sec) \- description
 .Pp  .Pp
 Where  Where
 .Qq title  .Dq name
 is the manual's title (note multiple manual names may exist for one  is the manual's name,
 title),  .Dq sec
 .Qq sec  
 is the manual section, and  is the manual section, and
 .Qq description  .Dq 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  .Pp
 .D1 title(cat/arch) \- description  .D1 name(sec/arch) \- description
 .Pp  .Pp
 Resulting manuals may be accessed as  Resulting manuals may be accessed as
 .Pp  .Pp
 .Dl $ man \-s sec title  .Dl $ man \-s sec name
 .Pp  .Pp
 If an architecture is specified in the output, use  If an architecture is specified in the output, use
 .Pp  .Pp
 .Dl $ man \-s sec \-S arch title  .Dl $ man \-s sec \-S arch name
 .Ss Macro Keys  .Ss Macro Keys
 Queries evaluate over a subset of  Queries evaluate over a subset of
 .Xr mdoc 7  .Xr mdoc 7
 macros indexed by  macros indexed by
 .Xr mandocdb 8 .  .Xr makewhatis 8 .
 In addition to the macro keys listed below, the special key  In addition to the macro keys listed below, the special key
 .Cm any  .Cm any
 may be used to match any available macro key.  may be used to match any available macro key.
Line 174  Names and description:
Line 272  Names and description:
 .Bl -column "xLix" description -offset indent -compact  .Bl -column "xLix" description -offset indent -compact
 .It Li \&Nm Ta manual name  .It Li \&Nm Ta manual name
 .It Li \&Nd Ta one-line manual description  .It Li \&Nd Ta one-line manual description
   .It Li arch Ta machine architecture (case-insensitive)
   .It Li sec  Ta manual section number
 .El  .El
 .Pp  .Pp
 Sections and cross references:  Sections and cross references:
Line 237  Text production:
Line 337  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 Ds  .Bl -tag -width MANPAGER
   .It Ev MANPAGER
   Any non-empty value of the environment variable
   .Ev MANPAGER
   will be used instead of the standard pagination program,
   .Xr more 1 .
 .It Ev MANPATH  .It Ev MANPATH
 Colon-separated paths modifying the default list of paths searched for  The standard search path used by
 manual databases.  .Xr man 1
   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  begins with a colon, it is appended to the default list;
 .Sq \&: ,  if it ends with a colon, it is prepended to the default list;
 it is appended to the default list;  or if it contains two adjacent colons,
 else if it ends with  the standard search path is inserted between the colons.
 .Sq \&: ,  If none of these conditions are met, it overrides the
 it is prepended to the default list; else if it contains  standard search path.
 .Sq \&:: ,  .It Ev PAGER
 the default list is inserted between the colons.  Specifies the pagination program to use when
 If none of these conditions are met, it overrides the default list.  .Ev MANPAGER
   is not defined.
   If neither PAGER nor MANPAGER is defined,
   .Pa /usr/bin/more Fl s
   will be used.
 .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 mandoc.db
 name of the  name of the
 .Xr mandocdb 8  .Xr makewhatis 8
 keyword database  keyword database
 .It Pa mandoc.index  
 name of the  
 .Xr mandocdb 8  
 filename database  
 .It Pa /etc/man.conf  .It Pa /etc/man.conf
 default  default
 .Xr man 1  .Xr man 1
Line 275  configuration file
Line 383  configuration file
 .Ex -std  .Ex -std
 .Sh EXAMPLES  .Sh EXAMPLES
 Search for  Search for
 .Qq mdoc  .Qq .cf
 as a substring and regular expression  as a substring of manual names and descriptions:
 within each manual name and description:  
 .Pp  .Pp
 .Dl $ apropos mdoc  .Dl $ apropos .cf
 .Dl $ apropos ~^mdoc$  
 .Pp  .Pp
 Include matches for  Include matches for
 .Qq roff  .Qq .cnf
 and  and
 .Qq man  .Qq .conf
 for the regular expression case:  as well:
 .Pp  .Pp
 .Dl $ apropos ~^mdoc$ roff man  .Dl $ apropos .cf .cnf .conf
 .Dl $ apropos ~^mdoc$ \-o roff \-o man  
 .Pp  .Pp
 Search for  Search in names and descriptions using a regular expression:
   .Pp
   .Dl $ apropos '~set.?[ug]id'
   .Pp
   Search for manuals in the library section mentioning both the
 .Qq optind  .Qq optind
 and  and the
 .Qq optarg  .Qq optarg
 as variable names in the library category:  variables:
 .Pp  .Pp
 .Dl $ apropos \-s 3 Va~^optind \-a Va~^optarg$  .Dl $ apropos \-s 3 Va=optind \-a Va=optarg
   .Pp
   Do exactly the same as calling
   .Xr whatis 1
   with the argument
   .Qq ssh :
   .Pp
   .Dl $ apropos \-\- \-i 'Nm~[[:<:]]ssh[[:>:]]'
   .Pp
   The following two invocations are equivalent:
   .Pp
   .D1 Li $ apropos -S Ar arch Li -s Ar section expression
   .Bd -ragged -offset indent
   .Li $ apropos \e( Ar expression Li \e)
   .Li -a arch~^( Ns Ar arch Ns Li |any)$
   .Li -a sec~^ Ns Ar section Ns Li $
   .Ed
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr man 1 ,  .Xr man 1 ,
 .Xr re_format 7 ,  .Xr re_format 7 ,
 .Xr mandocdb 8  .Xr makewhatis 8
 .Sh AUTHORS  .Sh HISTORY
   Part of the functionality of
   .Nm whatis
   was already provided by the former
   .Nm manwhere
   utility in
   .Bx 1 .
 The  The
 .Nm  .Nm
 utility was written by  and
 .An Kristaps Dzonsons ,  .Nm whatis
 .Mt kristaps@bsd.lv .  utilities first appeared in
   .Bx 2 .
   They were rewritten from scratch for
   .Ox 5.6 .
   .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
   for
   .Nm
   and in
   .Ox 5.6
   for
   .Nm whatis .
   .Sh AUTHORS
   .An -nosplit
   .An Bill Joy
   wrote
   .Nm manwhere
   in 1977 and the original
   .Bx
   .Nm
   and
   .Nm whatis
   in February 1979.
   The current version was written by
   .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
   and
   .An Ingo Schwarze Aq Mt schwarze@openbsd.org .
Legend:
Removed from v.1.14  
changed lines
  Added in v.1.37
CVSweb