1.\" $NetBSD: apropos.1,v 1.10 2003/08/07 11:13:07 agc Exp $ 2.\" 3.\" Copyright (c) 1989, 1990, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. Neither the name of the University nor the names of its contributors 15.\" may be used to endorse or promote products derived from this software 16.\" without specific prior written permission. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28.\" SUCH DAMAGE. 29.\" 30.\" @(#)apropos.1 8.1 (Berkeley) 6/29/93 31.\" 32.Dd June 29, 1993 33.Dt APROPOS 1 34.Os 35.Sh NAME 36.Nm apropos 37.Nd locate commands by keyword lookup 38.Sh SYNOPSIS 39.Nm apropos 40.Op Fl C Ar path 41.Op Fl M Ar path 42.Op Fl m Ar path 43.Ar keyword ... 44.Sh DESCRIPTION 45.Nm 46shows which manual pages contain instances of any of the given 47.Ar keyword(s) 48in their title line. 49Each word is considered separately and case of letters is ignored. 50Words which are part of other words are considered; when looking for 51.Dq compile , 52.Nm 53will also list all instances of 54.Dq compiler . 55.Pp 56If the line output by 57.Nm 58starts 59.Dq Li name(section) ... 60you can enter 61.Dq Li man section name 62to get 63its documentation. 64.Pp 65The options are as follows: 66.Bl -tag -width flag 67.It Fl C 68Use different 69.Xr man 1 70configuration file than the default, 71.Pa /etc/man.conf . 72.It Fl M 73Override the list of standard directories 74.Nm 75searches for a database named 76.Pa whatis.db . 77The supplied 78.Ar path 79must be a colon 80.Dq \&: 81separated list of directories. 82This search path may also be set using the environment variable 83.Ev MANPATH . 84.It Fl m 85Augment the list of standard directories 86.Nm 87searches for its database. 88The supplied 89.Ar path 90must be a colon 91.Dq \&: 92separated list of directories. 93These directories will be searched before the standard directories, 94or the directories supplied with the 95.Fl M 96option or the 97.Ev MANPATH 98environment variable. 99.El 100.Sh ENVIRONMENT 101.Bl -tag -width MANPATH 102.It Ev MANPATH 103The standard search path used by 104.Xr man 1 105may be overridden by specifying a path in the 106.Ev MANPATH 107environment variable. 108The format of the path is a colon 109.Dq \&: 110separated list of directories. 111.El 112.Sh FILES 113.Bl -tag -width /etc/man.conf1 -compact 114.It Pa whatis.db 115name of the apropos database 116.It Pa /etc/man.conf 117.Xr man 1 118configuration file, used to get location of whatis database if 119.Ev MANPATH 120is not set. 121.El 122.Sh SEE ALSO 123.Xr man 1 , 124.Xr whatis 1 , 125.Xr whereis 1 , 126.Xr man.conf 5 , 127.Xr makewhatis 8 128.Sh HISTORY 129The 130.Nm 131command appeared in 132.Bx 3.0 . 133