1996-03-10 18:52:33 +00:00
|
|
|
.\" Man page for apropos an whatis
|
1993-07-07 23:07:02 +00:00
|
|
|
.\"
|
|
|
|
|
.\" 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
|
2004-07-02 19:07:33 +00:00
|
|
|
.\" distribution.
|
1993-07-07 23:07:02 +00:00
|
|
|
.\"
|
|
|
|
|
.\" John W. Eaton
|
|
|
|
|
.\" jwe@che.utexas.edu
|
|
|
|
|
.\" Department of Chemical Engineering
|
|
|
|
|
.\" The University of Texas at Austin
|
|
|
|
|
.\" Austin, Texas 78712
|
|
|
|
|
.\"
|
2000-05-10 13:43:36 +00:00
|
|
|
.\" $FreeBSD$
|
2000-12-11 15:15:20 +00:00
|
|
|
.Dd January 15, 1991
|
1996-12-09 06:59:17 +00:00
|
|
|
.Dt APROPOS 1
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
2000-05-10 13:43:36 +00:00
|
|
|
.Nm apropos ,
|
|
|
|
|
.Nm whatis
|
1996-12-09 06:59:17 +00:00
|
|
|
.Nd search the whatis database
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.Nm apropos
|
|
|
|
|
.Ar keyword ...
|
|
|
|
|
.Nm whatis
|
|
|
|
|
.Ar keyword ...
|
|
|
|
|
.Sh DESCRIPTION
|
2000-05-10 13:43:36 +00:00
|
|
|
.Nm
|
1996-03-10 18:52:33 +00:00
|
|
|
searches a set of database files containing short descriptions
|
1993-07-07 23:07:02 +00:00
|
|
|
of system commands for keywords and displays the result on the
|
|
|
|
|
standard output.
|
1996-12-09 06:59:17 +00:00
|
|
|
.Nm whatis
|
2004-07-02 19:07:33 +00:00
|
|
|
displays only complete word matches.
|
2002-03-09 20:00:08 +00:00
|
|
|
.Pp
|
|
|
|
|
.Ar keyword
|
2002-08-07 17:39:35 +00:00
|
|
|
really is an extended regular expression, please read
|
2002-03-12 20:00:52 +00:00
|
|
|
.Xr grep 1
|
|
|
|
|
manual page for more information about its format.
|
2005-09-01 01:00:55 +00:00
|
|
|
.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
|
2005-11-17 12:16:33 +00:00
|
|
|
.Nm more Fl s .
|
2005-09-01 01:00:55 +00:00
|
|
|
.El
|
2005-01-17 07:44:44 +00:00
|
|
|
.Sh EXIT STATUS
|
2004-07-02 19:07:33 +00:00
|
|
|
The
|
2000-05-10 13:43:36 +00:00
|
|
|
.Nm
|
1996-07-08 20:03:18 +00:00
|
|
|
utility exits 0 on success, and 1 if no keyword matched.
|
1996-12-09 06:59:17 +00:00
|
|
|
.Sh SEE ALSO
|
2002-03-12 20:00:52 +00:00
|
|
|
.Xr grep 1 ,
|
1999-08-15 09:06:06 +00:00
|
|
|
.Xr makewhatis 1 ,
|
|
|
|
|
.Xr man 1
|
