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

   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: src/gnu/usr.bin/man/apropos/apropos.man,v 1.6.2.3 2002/08/11 11:18:51 ru Exp $
  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 .Nm
  30 searches a set of database files containing short descriptions
  31 of system commands for keywords and displays the result on the
  32 standard output.
  33 .Nm whatis
  34 displays only complete word matches.
  35 .Pp
  36 .Ar keyword
  37 really is an extended regular expression, please read
  38 .Xr grep 1
  39 manual page for more information about its format.
  40 .Sh DIAGNOSTICS
  41 The
  42 .Nm
  43 utility exits 0 on success, and 1 if no keyword matched.
  44 .Sh SEE ALSO
  45 .Xr grep 1 ,
  46 .Xr man 1 ,
  47 .Xr makewhatis 8