\" $NetBSD: apropos.1,v 1.11 2009/05/08 12:48:43 wiz Exp $
\"
\" Copyright (c) 1989, 1990, 1993
\" The Regents of the University of California. All rights reserved.
\"
\" Redistribution and use in source and binary forms, with or without
\" modification, are permitted provided that the following conditions
\" are met:
\" 1. Redistributions of source code must retain the above copyright
\" notice, this list of conditions and the following disclaimer.
\" 2. Redistributions in binary form must reproduce the above copyright
\" notice, this list of conditions and the following disclaimer in the
\" documentation and/or other materials provided with the distribution.
\" 3. Neither the name of the University nor the names of its contributors
\" may be used to endorse or promote products derived from this software
\" without specific prior written permission.
\"
\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
\" SUCH DAMAGE.
\"
\" @(#)apropos.1 8.1 (Berkeley) 6/29/93
\"
Dd May 7, 2009
Dt APROPOS 1
Os
Sh NAME
Nm apropos
Nd locate commands by keyword lookup
Sh SYNOPSIS
Nm apropos
Op Fl C Ar path
Op Fl M Ar path
Op Fl m Ar path
Op Fl S Ar subsection
Op Fl s Ar section
Ar keyword ...
Sh DESCRIPTION
Nm
shows which manual pages contain instances of any of the given
Ar keyword(s)
in their title line.
Each word is considered separately and case of letters is ignored.
Words which are part of other words are considered; when looking for
Dq compile ,
Nm
will also list all instances of
Dq compiler .
Pp
If the line output by
Nm
starts
Dq Li name(section) ...
you can enter
Dq Li man section name
to get
its documentation.
Pp
The options are as follows:
Bl -tag -width flag
It Fl C
Use different
Xr man 1
configuration file than the default,
Pa /etc/man.conf .
It Fl M
Override the list of standard directories
Nm
searches for a database named
Pa whatis.db .
The supplied
Ar path
must be a colon
Dq \&:
separated list of directories.
This search path may also be set using the environment variable
Ev MANPATH .
It Fl m
Augment the list of standard directories
Nm
searches for its database.
The supplied
Ar path
must be a colon
Dq \&:
separated list of directories.
These directories will be searched before the standard directories,
or the directories supplied with the
Fl M
option or the
Ev MANPATH
environment variable.
It Fl S Ar subsection
Restrict the search to pages for the specified machine architecture.
By default, pages for all architectures are shown.
It Fl s Ar section
Restrict the search to the specified section of the manual.
By default, pages from all sections are shown.
El
Sh ENVIRONMENT
Bl -tag -width MANPATH
It Ev MANPATH
The standard search path used by
Xr man 1
may be overridden by specifying a path in the
Ev MANPATH
environment variable.
The format of the path is a colon
Dq \&:
separated list of directories.
El
Sh FILES
Bl -tag -width /etc/man.conf1 -compact
It Pa whatis.db
name of the apropos database
It Pa /etc/man.conf
Xr man 1
configuration file, used to get location of whatis database if
Ev MANPATH
is not set.
El
Sh SEE ALSO
Xr man 1 ,
Xr whatis 1 ,
Xr whereis 1 ,
Xr man.conf 5 ,
Xr makewhatis 8
Sh HISTORY
The
Nm
command appeared in
Bx 3.0 .
