1*66601c7fSThomas Cort.\" $NetBSD: whatis.1,v 1.8 2003/08/07 11:17:16 agc Exp $ 2*66601c7fSThomas Cort.\" 3*66601c7fSThomas Cort.\" Copyright (c) 1989, 1990, 1993 4*66601c7fSThomas Cort.\" The Regents of the University of California. All rights reserved. 5*66601c7fSThomas Cort.\" 6*66601c7fSThomas Cort.\" Redistribution and use in source and binary forms, with or without 7*66601c7fSThomas Cort.\" modification, are permitted provided that the following conditions 8*66601c7fSThomas Cort.\" are met: 9*66601c7fSThomas Cort.\" 1. Redistributions of source code must retain the above copyright 10*66601c7fSThomas Cort.\" notice, this list of conditions and the following disclaimer. 11*66601c7fSThomas Cort.\" 2. Redistributions in binary form must reproduce the above copyright 12*66601c7fSThomas Cort.\" notice, this list of conditions and the following disclaimer in the 13*66601c7fSThomas Cort.\" documentation and/or other materials provided with the distribution. 14*66601c7fSThomas Cort.\" 3. Neither the name of the University nor the names of its contributors 15*66601c7fSThomas Cort.\" may be used to endorse or promote products derived from this software 16*66601c7fSThomas Cort.\" without specific prior written permission. 17*66601c7fSThomas Cort.\" 18*66601c7fSThomas Cort.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 19*66601c7fSThomas Cort.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20*66601c7fSThomas Cort.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21*66601c7fSThomas Cort.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 22*66601c7fSThomas Cort.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23*66601c7fSThomas Cort.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24*66601c7fSThomas Cort.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25*66601c7fSThomas Cort.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26*66601c7fSThomas Cort.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27*66601c7fSThomas Cort.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28*66601c7fSThomas Cort.\" SUCH DAMAGE. 29*66601c7fSThomas Cort.\" 30*66601c7fSThomas Cort.\" @(#)whatis.1 8.1 (Berkeley) 6/6/93 31*66601c7fSThomas Cort.\" 32*66601c7fSThomas Cort.Dd June 6, 1993 33*66601c7fSThomas Cort.Dt WHATIS 1 34*66601c7fSThomas Cort.Os 35*66601c7fSThomas Cort.Sh NAME 36*66601c7fSThomas Cort.Nm whatis 37*66601c7fSThomas Cort.Nd describe what a command is 38*66601c7fSThomas Cort.Sh SYNOPSIS 39*66601c7fSThomas Cort.Nm 40*66601c7fSThomas Cort.Op Fl C Ar path 41*66601c7fSThomas Cort.Op Fl M Ar path 42*66601c7fSThomas Cort.Op Fl m Ar path 43*66601c7fSThomas Cort.Ar command Ar ... 44*66601c7fSThomas Cort.Sh DESCRIPTION 45*66601c7fSThomas Cort.Nm 46*66601c7fSThomas Cortlooks up a given command and gives the header line from the manual page. 47*66601c7fSThomas CortYou can then use the 48*66601c7fSThomas Cort.Xr man 1 49*66601c7fSThomas Cortcommand to get more information. 50*66601c7fSThomas Cort.Pp 51*66601c7fSThomas CortThe options are as follows: 52*66601c7fSThomas Cort.Bl -tag -width Fl 53*66601c7fSThomas Cort.It Fl C Ar path 54*66601c7fSThomas CortUse different 55*66601c7fSThomas Cort.Xr man 1 56*66601c7fSThomas Cortconfiguration file than the default, 57*66601c7fSThomas Cort.Pa /etc/man.conf . 58*66601c7fSThomas Cort.It Fl M Ar path 59*66601c7fSThomas CortOverride the list of standard directories 60*66601c7fSThomas Cort.Nm 61*66601c7fSThomas Cortsearches for its database named 62*66601c7fSThomas Cort.Dq Pa whatis.db . 63*66601c7fSThomas CortThe supplied 64*66601c7fSThomas Cort.Ar path 65*66601c7fSThomas Cortmust be a colon 66*66601c7fSThomas Cort.Dq \&: 67*66601c7fSThomas Cortseparated list of directories. 68*66601c7fSThomas CortThis search path may also be set using the environment variable 69*66601c7fSThomas Cort.Ev MANPATH . 70*66601c7fSThomas Cort.It Fl m Ar path 71*66601c7fSThomas CortAugment the list of standard directories 72*66601c7fSThomas Cort.Nm 73*66601c7fSThomas Cortsearches for its database named 74*66601c7fSThomas Cort.Dq Pa whatis.db . 75*66601c7fSThomas CortThe supplied 76*66601c7fSThomas Cort.Ar path 77*66601c7fSThomas Cortmust be a colon 78*66601c7fSThomas Cort.Dq \&: 79*66601c7fSThomas Cortseparated list of directories. 80*66601c7fSThomas CortThese directories will be searched before the standard directories 81*66601c7fSThomas Cortor the directories supplied with the 82*66601c7fSThomas Cort.Fl M 83*66601c7fSThomas Cortoption or the 84*66601c7fSThomas Cort.Ev MANPATH 85*66601c7fSThomas Cortenvironment variable are searched. 86*66601c7fSThomas Cort.El 87*66601c7fSThomas Cort.Sh ENVIRONMENT 88*66601c7fSThomas Cort.Bl -tag -width MANPATH 89*66601c7fSThomas Cort.It Ev MANPATH 90*66601c7fSThomas CortThe standard search path used by 91*66601c7fSThomas Cort.Xr man 1 92*66601c7fSThomas Cortmay be overridden by specifying a path in the 93*66601c7fSThomas Cort.Ev MANPATH 94*66601c7fSThomas Cortenvironment variable. 95*66601c7fSThomas Cort.El 96*66601c7fSThomas Cort.Sh FILES 97*66601c7fSThomas Cort.Bl -tag -compact -width /etc/man.conf1 98*66601c7fSThomas Cort.It Pa whatis.db 99*66601c7fSThomas Cortname of the whatis databases 100*66601c7fSThomas Cort.It Pa /etc/man.conf 101*66601c7fSThomas Cort.Xr man 1 102*66601c7fSThomas Cortconfiguration file, used to get location of whatis databases if 103*66601c7fSThomas Cort.Ev MANPATH 104*66601c7fSThomas Cortis not set. 105*66601c7fSThomas Cort.El 106*66601c7fSThomas Cort.Sh SEE ALSO 107*66601c7fSThomas Cort.Xr apropos 1 , 108*66601c7fSThomas Cort.Xr man 1 , 109*66601c7fSThomas Cort.Xr whereis 1 , 110*66601c7fSThomas Cort.Xr man.conf 5 , 111*66601c7fSThomas Cort.Xr makewhatis 8 112*66601c7fSThomas Cort.Sh HISTORY 113*66601c7fSThomas CortThe 114*66601c7fSThomas Cort.Nm 115*66601c7fSThomas Cortcommand appeared in 116*66601c7fSThomas Cort.Bx 3.0 . 117