usr.bin/man/apropos.1

   1 .\"-
   2 .\"  Copyright (c) 2010 Gordon Tetlow
   3 .\"  All rights reserved.
   4 .\"
   5 .\"  Redistribution and use in source and binary forms, with or without
   6 .\"  modification, are permitted provided that the following conditions
   7 .\"  are met:
   8 .\"  1. Redistributions of source code must retain the above copyright
   9 .\"     notice, this list of conditions and the following disclaimer.
  10 .\"  2. Redistributions in binary form must reproduce the above copyright
  11 .\"     notice, this list of conditions and the following disclaimer in the
  12 .\"     documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\"  THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\"  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\"  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\"  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\"  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\"  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\"  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\"  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\"  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\"  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\"  SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd September 1, 2010
  29 .Dt APROPOS 1
  30 .Os
  31 .Sh NAME
  32 .Nm apropos ,
  33 .Nm whatis
  34 .Nd keyword search whatis documentation databases
  35 .Sh SYNOPSIS
  36 .Nm
  37 .Op Fl d
  38 .Ar keyword ...
  39 .Nm whatis
  40 .Op Fl d
  41 .Ar keyword ...
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 utility searches a set of databases looking for documentation matching each
  46 .Ar keyword
  47 and displays the results.
  48 The
  49 .Nm whatis
  50 utility does the same search but only on complete words.
  51 .Bl -tag -width ".Fl d"
  52 .It Fl d
  53 Print extra debugging information.
  54 .El
  55 .Pp
  56 The
  57 .Ar keyword
  58 is simply passed to
  59 .Xr grep 1
  60 allowing for extended regular expression matches.
  61 .Sh ENVIRONMENT
  62 The following environment variables affect the execution of
  63 .Nm :
  64 .Bl -tag -width ".Ev PAGER"
  65 .It Ev MANLOCALES , MANPATH , PATH
  66 Used to find the location of the
  67 .Nm whatis
  68 database files. See
  69 .Xr manpath 1
  70 for additional information.
  71 .It Ev PAGER
  72 Program used to display files.
  73 If unset,
  74 .Ic "more -s"
  75 is used.
  76 .El
  77 .Sh DIAGNOSTICS
  78 The
  79 .Nm
  80 utility exits 0 if a keyword matched and 1 if no keywords are matched or no
  81 .Nm whatis
  82 databases are found.
  83 .Sh SEE ALSO
  84 .Xr grep 1 ,
  85 .Xr makewhatis 1 ,
  86 .Xr man 1 ,
  87 .Xr manpath 1 ,
  88 .Xr man.conf 5