libexec/makewhatis/makewhatis.8

   1 .\"     $NetBSD: makewhatis.8,v 1.13 2013/07/20 21:39:57 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 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd April 3, 2005
  31 .Dt MAKEWHATIS 8
  32 .Os
  33 .Sh NAME
  34 .Nm makewhatis
  35 .Nd create a whatis.db database
  36 .Sh SYNOPSIS
  37 .Nm /usr/libexec/makewhatis
  38 .Op Fl fw
  39 .Op Fl C Ar file
  40 .Op Ar manpath ...
  41 .Sh DESCRIPTION
  42 .Nm
  43 strips the NAME lines from compiled or raw
  44 .Xr man 1
  45 pages and creates a whatis.db database for use in
  46 .Xr apropos 1 ,
  47 .Xr whatis 1 ,
  48 or with
  49 .Xr man 1 Ns 's
  50 .Fl k
  51 option.
  52 Man pages compressed with
  53 .Xr compress 1
  54 and
  55 .Xr gzip 1
  56 are uncompressed before processing.
  57 .Pp
  58 When
  59 .Ar manpath
  60 is provided multiple times, the resulting database file
  61 is generated in the first directory specified, and contains
  62 entries for all the directories.
  63 .Pp
  64 If
  65 .Ar manpath
  66 is not provided,
  67 .Nm
  68 parses
  69 .Pa /etc/man.conf
  70 and regenerates the whatis database files specified there.
  71 Each database file is assumed to reside in the root of the appropriate
  72 man page hierarchy.
  73 .Pp
  74 The options are as follows:
  75 .Bl -tag -width XCXfileXX
  76 .It Fl C Ar file
  77 Use
  78 .Ar file
  79 (in
  80 .Xr man.conf 5
  81 format) as configuration file instead of the default,
  82 .Pa /etc/man.conf .
  83 .It Fl f
  84 Don't spawn child processes to generate the individual database files,
  85 but do all the work synchronously in the foreground.
  86 .It Fl w
  87 Print warnings about input files we don't like.
  88 .El
  89 .Sh FILES
  90 .Bl -tag -compact -width /etc/man.conf1
  91 .It Pa whatis.db
  92 name of the whatis database
  93 .It Pa /etc/man.conf
  94 .Xr man 1
  95 configuration file, used to get the location of the whatis databases when
  96 .Nm
  97 is called without arguments
  98 .El
  99 .Sh SEE ALSO
 100 .Xr apropos 1 ,
 101 .Xr man 1 ,
 102 .Xr whatis 1 ,
 103 .Xr man.conf 5
 104 .Sh HISTORY
 105 .An -nosplit
 106 .Nm
 107 first appeared in
 108 .Nx 1.0 ,
 109 as a shell script written by
 110 .An J.T. Conklin Aq Mt jtc@NetBSD.org
 111 and
 112 .An Thorsten Frueauf Aq Mt frueauf@ira.uka.de .
 113 Further work was done by
 114 .An Matthew Green ,
 115 .An Luke Mewburn ,
 116 and
 117 .An Chris Demetriou .
 118 .Pp
 119 .An Matthias Scheler
 120 has reimplemented
 121 .Nm
 122 in C in
 123 .Nx 1.5 .
 124 .Sh AUTHORS
 125 .An Matthias Scheler Aq Mt tron@NetBSD.org