Fix cross reference: makewhatis(1) -> makewhatis(8).
[dragonfly.git] / 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: src/gnu/usr.bin/man/apropos/apropos.man,v 1.6.2.3 2002/08/11 11:18:51 ru Exp $
16 .\" $DragonFly: src/gnu/usr.bin/man/apropos/apropos.man,v 1.3 2005/08/05 09:47:55 swildner Exp $
17 .Dd January 15, 1991
18 .Dt APROPOS 1
19 .Os
20 .Sh NAME
21 .Nm apropos ,
22 .Nm whatis
23 .Nd search the whatis database
24 .Sh SYNOPSIS
25 .Nm apropos
26 .Ar keyword ...
27 .Nm whatis
28 .Ar keyword ...
29 .Sh DESCRIPTION
30 .Nm
31 searches a set of database files containing short descriptions
32 of system commands for keywords and displays the result on the
33 standard output.
34 .Nm whatis
35 displays only complete word matches. 
36 .Pp
37 .Ar keyword
38 really is an extended regular expression, please read
39 .Xr grep 1
40 manual page for more information about its format.
41 .Sh DIAGNOSTICS
42 The 
43 .Nm
44 utility exits 0 on success, and 1 if no keyword matched.
45 .Sh SEE ALSO
46 .Xr grep 1 ,
47 .Xr man 1 ,
48 .Xr makewhatis 8