1.\" $NetBSD: whatis.1,v 1.4 2016/06/16 14:07:16 abhinav Exp $ 2.\" 3.\" Copyright (c) 2012 Joerg Sonnenberger <joerg@NetBSD.org> 4.\" 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.\" 10.\" 1. Redistributions of source code must retain the above copyright 11.\" notice, this list of conditions and the following disclaimer. 12.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" notice, this list of conditions and the following disclaimer in 14.\" the documentation and/or other materials provided with the 15.\" distribution. 16.\" 17.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 20.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 21.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 22.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, 23.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 24.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 25.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 26.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 27.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28.\" SUCH DAMAGE. 29.\" 30.Dd June 16, 2016 31.Dt WHATIS 1 32.Os 33.Sh NAME 34.Nm whatis 35.Nd describe what a command is 36.Sh SYNOPSIS 37.Nm 38.Op Fl C Ar path 39.Ar command Ar ... 40.Sh DESCRIPTION 41The 42.Nm 43program queries the apropos database built by 44.Xr makemandb 8 . 45It searches for manual pages with name 46.Ar command 47and outputs name of the matching manual pages along with the section and the 48brief description from the NAME section. 49.Pp 50It supports the following options: 51.Bl -tag -width indent 52.It Fl C Ar path 53Use different 54.Xr man 1 55configuration file than the default, 56.Pa /etc/man.conf . 57.El 58.Sh FILES 59.Bl -hang -width /etc/man.conf -compact 60.It Pa /etc/man.conf 61The location of the Sqlite FTS database can be configured using the 62.Cd _mandb 63tag. 64.El 65.Sh SEE ALSO 66.Xr apropos 1 , 67.Xr man 1 , 68.Xr man.conf 5 , 69.Xr makemandb 8 70.Sh HISTORY 71The 72.Nm 73command appeared in 3.0BSD. 74It was rewritten in 75.Nx 6.0 76to use the SQLite index created by 77.Xr makemandb 8 . 78