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