gnu/usr.bin/man/apropos/apropos.man

   1 .\" Man page for apropos an whatis
   2 .\"
   3 .\" Copyright (c) 1990, 1991, John W. Eaton.
   4 .\"
   5 .\" You may distribute under the terms of the GNU General Public
   6 .\" License as specified in the README file that comes with the man 1.0
   7 .\" distribution.
   8 .\"
   9 .\" John W. Eaton
  10 .\" jwe@che.utexas.edu
  11 .\" Department of Chemical Engineering
  12 .\" The University of Texas at Austin
  13 .\" Austin, Texas  78712
  14 .\"
  15 .\" $FreeBSD$
  16 .Dd January 15, 1991
  17 .Dt APROPOS 1
  18 .Os
  19 .Sh NAME
  20 .Nm apropos ,
  21 .Nm whatis
  22 .Nd search the whatis database
  23 .Sh SYNOPSIS
  24 .Nm apropos
  25 .Ar keyword ...
  26 .Nm whatis
  27 .Ar keyword ...
  28 .Sh DESCRIPTION
  29 The
  30 .Nm
  31 utility
  32 searches a set of database files containing short descriptions
  33 of system commands for keywords and displays the result on the
  34 standard output.
  35 The
  36 .Nm whatis
  37 utility
  38 displays only complete word matches.
  39 .Pp
  40 The
  41 .Ar keyword
  42 really is an extended regular expression, please read
  43 .Xr grep 1
  44 manual page for more information about its format.
  45 .Sh ENVIRONMENT
  46 .Bl -tag -width ".Ev PAGER"
  47 .It Ev PATH , MANPATH , MANLOCALES
  48 Used in finding the
  49 .Nm whatis
  50 database files.
  51 See
  52 .Xr manpath 1 .
  53 .It Ev PAGER
  54 Command used to page the output.
  55 The default is
  56 .Nm more Fl s .
  57 .El
  58 .Sh EXIT STATUS
  59 The
  60 .Nm
  61 utility exits 0 on success, and 1 if no keyword matched.
  62 .Sh SEE ALSO
  63 .Xr grep 1 ,
  64 .Xr makewhatis 1 ,
  65 .Xr man 1