1.\" $NetBSD: makewhatis.8,v 1.8 2002/03/08 22:10:00 wiz Exp $ 2.\" 3.\" Copyright (c) 1997, 2002 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Robert Dobbs <banshee@gabriella.resort.com>. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 3. All advertising materials mentioning features or use of this software 18.\" must display the following acknowledgement: 19.\" This product includes software developed by the NetBSD 20.\" Foundation, Inc. and its contributors. 21.\" 4. Neither the name of The NetBSD Foundation nor the names of its 22.\" contributors may be used to endorse or promote products derived 23.\" from this software without specific prior written permission. 24.\" 25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 28.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 35.\" POSSIBILITY OF SUCH DAMAGE. 36.\" 37.Dd March 8, 2002 38.Dt MAKEWHATIS 8 39.Os 40.Sh NAME 41.Nm makewhatis 42.Nd create a whatis.db database 43.Sh SYNOPSIS 44.Nm /usr/libexec/makewhatis 45.Op Fl C Ar file 46.Op Fl f 47.Op Ar manpath ... 48.Sh DESCRIPTION 49.Nm 50strips the NAME lines from compiled or raw 51.Xr man 1 52pages and creates 53a whatis.db database 54for use in 55.Xr apropos 1 , 56.Xr whatis 1 57or with 58.Xr man 1 Ns 's 59.Fl k 60option. 61Man pages compressed with 62.Xr compress 1 63and 64.Xr gzip 1 65are uncompressed before processing. 66.Pp 67When 68.Ar manpath 69is provided multiple times, the resulting database file 70is generated in the first directory specified, and contains 71entries for all the directories. 72.Pp 73If 74.Ar manpath 75is not provided, 76.Nm 77parses 78.Pa /etc/man.conf 79and regenerates the whatis database files specified there. 80Each database file is assumed to reside in the root of the appropriate 81man page hierarchy. 82.Pp 83The options are as follows: 84.Bl -tag -width flag 85.It Fl C Ar file 86Use 87.Ar file 88(in 89.Xr man.conf 5 90format) as configuration file instead of the default, 91.Pa /etc/man.conf . 92.It Fl f 93Don't spawn child processes to generate the individual database files, 94but do all the work synchronously in the foreground. 95.El 96.Sh FILES 97.Bl -tag -compact -width /etc/man.conf1 98.It Pa whatis.db 99name of the whatis database 100.It Pa /etc/man.conf 101.Xr man 1 102configuration file, used to get the location of the whatis databases when 103.Nm 104is called without arguments 105.El 106.Sh SEE ALSO 107.Xr apropos 1 , 108.Xr man 1 , 109.Xr whatis 1 , 110.Xr man.conf 5 111.Sh HISTORY 112.Nm 113first appeared in 114.Nx 1.0 , 115as a shell script written by 116.An J.T. Conklin Aq jtc@netbsd.org 117and 118.An Thorsten Frueauf Aq frueauf@ira.uka.de . 119Further work was done by 120Matthew Green, Luke Mewburn and 121Chris Demetriou. 122.Pp 123Matthias Scheler 124has reimplemented 125.Nm 126in C in 127.Nx 1.5 . 128.Sh AUTHORS 129.An Matthias Scheler Aq tron@netbsd.org 130