freebsd-dev/gnu/usr.bin/man/apropos/apropos.man

.\" 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$
.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
.Nm
searches a set of database files containing short descriptions
of system commands for keywords and displays the result on the
standard output.
.Nm whatis
displays only complete word matches. 
.Pp
.Ar keyword
really is an extended regular expression, please read
.Xr grep 1
manual page for more information about its format.
.Sh DIAGNOSTICS
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
share the code between apropos and whatis 1996-03-10 18:52:33 +00:00			`.\" Man page for apropos an whatis`
Newer new man page reader. 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`
			`.\" distribution.`
			`.\"`
			`.\" John W. Eaton`
			`.\" jwe@che.utexas.edu`
			`.\" Department of Chemical Engineering`
			`.\" The University of Texas at Austin`
			`.\" Austin, Texas 78712`
			`.\"`
mdoc cleanup: use .Nm macro correctly, don't non mdoc macro 2000-05-10 13:43:36 +00:00			`.\" $FreeBSD$`
mdoc(7) police: use canonical form of .Dd macro. 2000-12-11 15:15:20 +00:00			`.Dd January 15, 1991`
Convert man page to mdoc format. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2154 1996-12-09 06:59:17 +00:00			`.Dt APROPOS 1`
			`.Os`
			`.Sh NAME`
mdoc cleanup: use .Nm macro correctly, don't non mdoc macro 2000-05-10 13:43:36 +00:00			`.Nm apropos ,`
			`.Nm whatis`
Convert man page to mdoc format. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2154 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`
mdoc cleanup: use .Nm macro correctly, don't non mdoc macro 2000-05-10 13:43:36 +00:00			`.Nm`
share the code between apropos and whatis 1996-03-10 18:52:33 +00:00			`searches a set of database files containing short descriptions`
Newer new man page reader. 1993-07-07 23:07:02 +00:00			`of system commands for keywords and displays the result on the`
			`standard output.`
Convert man page to mdoc format. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2154 1996-12-09 06:59:17 +00:00			`.Nm whatis`
Fix a spelling error. 1996-12-09 07:00:17 +00:00			`displays only complete word matches.`
apropos(1) manual page doesn't tell that keyword can be regular expression PR: gnu/31685 Submitted by: Andrey Simonenko <simon@simon.org.ua> 2002-03-09 20:00:08 +00:00			`.Pp`
			`.Ar keyword`
POSIX.1-2001 says ``man -k'' should produce results equivalent to the ``grep -Ei'' searching. MFC after: 3 days 2002-08-07 17:39:35 +00:00			`really is an extended regular expression, please read`
RETURN VALUES is for sections 2, 3 and 9, but here in section 1 man page, DIAGNOSTICS should be used instead. Reviewed by: wosch 2002-03-12 20:00:52 +00:00			`.Xr grep 1`
			`manual page for more information about its format.`
			`.Sh DIAGNOSTICS`
Exits 0 on success, and 1 if no keyword matched. Start $PAGER only if we find a manual page. 1996-07-08 20:03:18 +00:00			`The`
mdoc cleanup: use .Nm macro correctly, don't non mdoc macro 2000-05-10 13:43:36 +00:00			`.Nm`
Exits 0 on success, and 1 if no keyword matched. Start $PAGER only if we find a manual page. 1996-07-08 20:03:18 +00:00			`utility exits 0 on success, and 1 if no keyword matched.`
Convert man page to mdoc format. Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2154 1996-12-09 06:59:17 +00:00			`.Sh SEE ALSO`
RETURN VALUES is for sections 2, 3 and 9, but here in section 1 man page, DIAGNOSTICS should be used instead. Reviewed by: wosch 2002-03-12 20:00:52 +00:00			`.Xr grep 1 ,`
Various man page cleanup: - Sort xrefs - Be consistent with section names as outlined in mdoc(7). - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexey M. Zelkin <phantom@cris.net> 1999-08-15 09:06:06 +00:00			`.Xr makewhatis 1 ,`
			`.Xr man 1`