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

Diff for /mandoc/apropos.1 between version 1.33 and 1.41

version 1.33, 2014/08/22 04:52:55 version 1.41, 2017/03/17 17:24:41
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>  .\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2011, 2012, 2014 Ingo Schwarze <schwarze@openbsd.org>  .\" Copyright (c) 2011, 2012, 2014, 2017 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 24 
Line 24 
 .Nd search manual page databases  .Nd search manual page databases
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm  .Nm
 .Op Fl acfkw  .Op Fl acfhklw
 .Op Fl C Ar file  .Op Fl C Ar file
 .Op Fl M Ar path  .Op Fl M Ar path
 .Op Fl m Ar path  .Op Fl m Ar path
Line 79  to paginate them.
Line 79  to paginate them.
 In  In
 .Fl a  .Fl a
 mode, the options  mode, the options
 .Fl IOTW  .Fl IKOTW
 described in the  described in the
 .Xr mandoc 1  .Xr mandoc 1
 manual are also available.  manual are also available.
Line 104  In this mode, macro keys, comparison operators, and lo
Line 104  In this mode, macro keys, comparison operators, and lo
 are not available.  are not available.
 This overrides any earlier  This overrides any earlier
 .Fl k  .Fl k
 option.  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  .It Fl k
 Support the full  Support the full
 .Ar expression  .Ar expression
 syntax.  syntax.
 This overrides any earlier  This overrides any earlier
 .Fl f  .Fl f
 option.  and
   .Fl l
   options.
 It is the default for  It is the default for
 .Nm .  .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  .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
Line 191  This has syntax
Line 210  This has syntax
 .Sm off  .Sm off
 .Oo  .Oo
 .Op Ar key Op , Ar key ...  .Op Ar key Op , Ar key ...
 .Pq Cm = | ~  .Pq Cm = | \(ti
 .Oc  .Oc
 .Ar val ,  .Ar val ,
 .Sm on  .Sm on
Line 208  for a list of available keys.
Line 227  for a list of available keys.
 Operator  Operator
 .Cm =  .Cm =
 evaluates a substring, while  evaluates a substring, while
 .Cm ~  .Cm \(ti
 evaluates a regular expression.  evaluates a regular expression.
 .It Fl i Ar term  .It Fl i Ar term
 If  If
Line 218  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
 Results are sorted by manual sections and names, with output formatted as  Results are sorted according to the following criteria:
   .Bl -enum
   .It
   The manpath directory tree the page is found in, according to the
   order specified with
   .Fl M ,
   .Fl m ,
   the
   .Ev MANPATH
   environment variable, the
   .Xr man.conf 5
   configuration file, or the default documented in
   .Xr man.conf 5 .
   .It
   The section number in ascending numerical order.
   .It
   The page name in ascending
   .Xr ascii 7
   alphabetical order, case-insensitive.
   .El
 .Pp  .Pp
   Each output line is formatted as
   .Pp
 .D1 name[, name...](sec) \- description  .D1 name[, name...](sec) \- description
 .Pp  .Pp
 Where  Where
Line 346  Specifies the pagination program to use when
Line 386  Specifies the pagination program to use when
 .Ev MANPAGER  .Ev MANPAGER
 is not defined.  is not defined.
 If neither PAGER nor MANPAGER is defined,  If neither PAGER nor MANPAGER is defined,
 .Pa /usr/bin/more Fl s  .Xr more 1
   .Fl s
 will be used.  will be used.
 .El  .El
 .Sh FILES  .Sh FILES
Line 379  as well:
Line 420  as well:
 .Pp  .Pp
 Search in names and descriptions using a regular expression:  Search in names and descriptions using a regular expression:
 .Pp  .Pp
 .Dl $ apropos '~set.?[ug]id'  .Dl $ apropos \(aq\(tiset.?[ug]id\(aq
 .Pp  .Pp
 Search for manuals in the library section mentioning both the  Search for manuals in the library section mentioning both the
 .Qq optind  .Qq optind
Line 394  Do exactly the same as calling
Line 435  Do exactly the same as calling
 with the argument  with the argument
 .Qq ssh :  .Qq ssh :
 .Pp  .Pp
 .Dl $ apropos \-\- \-i 'Nm~[[:<:]]ssh[[:>:]]'  .Dl $ apropos \-\- \-i \(aqNm\(ti[[:<:]]ssh[[:>:]]\(aq
 .Pp  .Pp
 The following two invocations are equivalent:  The following two invocations are equivalent:
 .Pp  .Pp
 .D1 Li $ apropos -S Ar arch Li -s Ar section expression  .D1 Li $ apropos -S Ar arch Li -s Ar section expression
 .Bd -ragged -offset indent  .Bd -ragged -offset indent
 .Li $ apropos \e( Ar expression Li \e)  .Li $ apropos \e( Ar expression Li \e)
 .Li -a arch~^( Ns Ar arch Ns Li |any)$  .Li -a arch\(ti^( Ns Ar arch Ns Li |any)$
 .Li -a sec~^ Ns Ar section Ns Li $  .Li -a sec\(ti^ Ns Ar section Ns Li $
 .Ed  .Ed
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr man 1 ,  .Xr man 1 ,
Line 448  and in
Line 489  and in
 .Ox 5.6  .Ox 5.6
 for  for
 .Nm whatis .  .Nm whatis .
   The options
   .Fl acfhIKklOTWw
   appeared in
   .Ox 5.7 .
 .Sh AUTHORS  .Sh AUTHORS
 .An -nosplit  .An -nosplit
 .An Bill Joy  .An Bill Joy
Legend:
Removed from v.1.33  
changed lines
  Added in v.1.41
CVSweb