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