1*0407c1b8Swiz.\" $NetBSD: apropos.1,v 1.11 2009/05/08 12:48:43 wiz Exp $ 20a334e76Sglass.\" 344aa3887Scgd.\" Copyright (c) 1989, 1990, 1993 444aa3887Scgd.\" The Regents of the University of California. All rights reserved. 544aa3887Scgd.\" 644aa3887Scgd.\" Redistribution and use in source and binary forms, with or without 744aa3887Scgd.\" modification, are permitted provided that the following conditions 844aa3887Scgd.\" are met: 944aa3887Scgd.\" 1. Redistributions of source code must retain the above copyright 1044aa3887Scgd.\" notice, this list of conditions and the following disclaimer. 1144aa3887Scgd.\" 2. Redistributions in binary form must reproduce the above copyright 1244aa3887Scgd.\" notice, this list of conditions and the following disclaimer in the 1344aa3887Scgd.\" documentation and/or other materials provided with the distribution. 1489aaa1bbSagc.\" 3. Neither the name of the University nor the names of its contributors 1544aa3887Scgd.\" may be used to endorse or promote products derived from this software 1644aa3887Scgd.\" without specific prior written permission. 1744aa3887Scgd.\" 1844aa3887Scgd.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 1944aa3887Scgd.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 2044aa3887Scgd.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2144aa3887Scgd.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 2244aa3887Scgd.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2344aa3887Scgd.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2444aa3887Scgd.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2544aa3887Scgd.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2644aa3887Scgd.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2744aa3887Scgd.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2844aa3887Scgd.\" SUCH DAMAGE. 2944aa3887Scgd.\" 300a334e76Sglass.\" @(#)apropos.1 8.1 (Berkeley) 6/29/93 3144aa3887Scgd.\" 32*0407c1b8Swiz.Dd May 7, 2009 3344aa3887Scgd.Dt APROPOS 1 3444aa3887Scgd.Os 3544aa3887Scgd.Sh NAME 3644aa3887Scgd.Nm apropos 3744aa3887Scgd.Nd locate commands by keyword lookup 3844aa3887Scgd.Sh SYNOPSIS 3944aa3887Scgd.Nm apropos 40215ac5cfSjdolecek.Op Fl C Ar path 4144aa3887Scgd.Op Fl M Ar path 4244aa3887Scgd.Op Fl m Ar path 43*0407c1b8Swiz.Op Fl S Ar subsection 44*0407c1b8Swiz.Op Fl s Ar section 4544aa3887Scgd.Ar keyword ... 4644aa3887Scgd.Sh DESCRIPTION 47279552d3Slukem.Nm 4844aa3887Scgdshows which manual pages contain instances of any of the given 4944aa3887Scgd.Ar keyword(s) 5044aa3887Scgdin their title line. 5144aa3887ScgdEach word is considered separately and case of letters is ignored. 5244aa3887ScgdWords which are part of other words are considered; when looking for 5344aa3887Scgd.Dq compile , 54279552d3Slukem.Nm 5544aa3887Scgdwill also list all instances of 5644aa3887Scgd.Dq compiler . 5744aa3887Scgd.Pp 5844aa3887ScgdIf the line output by 59279552d3Slukem.Nm 6044aa3887Scgdstarts 6144aa3887Scgd.Dq Li name(section) ... 6244aa3887Scgdyou can enter 6344aa3887Scgd.Dq Li man section name 6444aa3887Scgdto get 6544aa3887Scgdits documentation. 6644aa3887Scgd.Pp 6744aa3887ScgdThe options are as follows: 6844aa3887Scgd.Bl -tag -width flag 69215ac5cfSjdolecek.It Fl C 70215ac5cfSjdolecekUse different 71215ac5cfSjdolecek.Xr man 1 72215ac5cfSjdolecekconfiguration file than the default, 73215ac5cfSjdolecek.Pa /etc/man.conf . 7444aa3887Scgd.It Fl M 7544aa3887ScgdOverride the list of standard directories 76279552d3Slukem.Nm 7744aa3887Scgdsearches for a database named 7844aa3887Scgd.Pa whatis.db . 7944aa3887ScgdThe supplied 8044aa3887Scgd.Ar path 8144aa3887Scgdmust be a colon 8244aa3887Scgd.Dq \&: 8344aa3887Scgdseparated list of directories. 8444aa3887ScgdThis search path may also be set using the environment variable 8544aa3887Scgd.Ev MANPATH . 8644aa3887Scgd.It Fl m 8744aa3887ScgdAugment the list of standard directories 88279552d3Slukem.Nm 8944aa3887Scgdsearches for its database. 9044aa3887ScgdThe supplied 9144aa3887Scgd.Ar path 9244aa3887Scgdmust be a colon 9344aa3887Scgd.Dq \&: 9444aa3887Scgdseparated list of directories. 9544aa3887ScgdThese directories will be searched before the standard directories, 9644aa3887Scgdor the directories supplied with the 9744aa3887Scgd.Fl M 9844aa3887Scgdoption or the 9944aa3887Scgd.Ev MANPATH 10044aa3887Scgdenvironment variable. 101*0407c1b8Swiz.It Fl S Ar subsection 102*0407c1b8SwizRestrict the search to pages for the specified machine architecture. 103*0407c1b8SwizBy default, pages for all architectures are shown. 104*0407c1b8Swiz.It Fl s Ar section 105*0407c1b8SwizRestrict the search to the specified section of the manual. 106*0407c1b8SwizBy default, pages from all sections are shown. 107034eedfeSross.El 10844aa3887Scgd.Sh ENVIRONMENT 10944aa3887Scgd.Bl -tag -width MANPATH 11044aa3887Scgd.It Ev MANPATH 11144aa3887ScgdThe standard search path used by 11244aa3887Scgd.Xr man 1 11344aa3887Scgdmay be overridden by specifying a path in the 11444aa3887Scgd.Ev MANPATH 11544aa3887Scgdenvironment variable. 11644aa3887ScgdThe format of the path is a colon 11744aa3887Scgd.Dq \&: 11844aa3887Scgdseparated list of directories. 11944aa3887Scgd.El 12044aa3887Scgd.Sh FILES 121215ac5cfSjdolecek.Bl -tag -width /etc/man.conf1 -compact 12244aa3887Scgd.It Pa whatis.db 12344aa3887Scgdname of the apropos database 124215ac5cfSjdolecek.It Pa /etc/man.conf 125215ac5cfSjdolecek.Xr man 1 126215ac5cfSjdolecekconfiguration file, used to get location of whatis database if 127215ac5cfSjdolecek.Ev MANPATH 128215ac5cfSjdolecekis not set. 12944aa3887Scgd.El 13044aa3887Scgd.Sh SEE ALSO 13144aa3887Scgd.Xr man 1 , 13244aa3887Scgd.Xr whatis 1 , 1332249fd4cSfair.Xr whereis 1 , 134215ac5cfSjdolecek.Xr man.conf 5 , 1352249fd4cSfair.Xr makewhatis 8 13644aa3887Scgd.Sh HISTORY 13744aa3887ScgdThe 138279552d3Slukem.Nm 13944aa3887Scgdcommand appeared in 14044aa3887Scgd.Bx 3.0 . 141