manual/man/original/man8/makewhatis.8

   1 .\"
   2 .\" Generated automatically from makewhatis.8.in by the
   3 .\" configure script.
   4 .\"
   5 .\" Copyright (c) 1999 Ottavio G. Rizzo <rizzo@pluto.linux.it>
   6 .\"
   7 .\" This is free documentation; you can redistribute it and/or
   8 .\" modify it under the terms of the GNU General Public License as
   9 .\" published by the Free Software Foundation; either version 2 of
  10 .\" the License, or (at your option) any later version.
  11 .\"
  12 .\" The GNU General Public License's references to "object code"
  13 .\" and "executables" are to be interpreted as the output of any
  14 .\" document formatting or typesetting system, including
  15 .\" intermediate and printed output.
  16 .\"
  17 .\" This manual is distributed in the hope that it will be useful,
  18 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 .\" GNU General Public License for more details.
  21 .\"
  22 .\" You should have received a copy of the GNU General Public
  23 .\" License along with this manual; if not, write to the Free
  24 .\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
  25 .\" USA.
  26 .\"
  27 .TH MAKEWHATIS 8 "22 January 1999"
  28 .SH NAME
  29 makewhatis \- Create the whatis database
  30 .SH SYNOPSIS
  31 .BI "makewhatis [-u] [-v] [-w] [-s " sections " ] [-c [" catpath "]] [" manpath "]"
  32 .SH DESCRIPTION
  33 .B makewhatis
  34 reads all the manual pages contained in the given
  35 .IR sections " of " manpath
  36 or the preformatted pages contained in the given
  37 .IR sections " of " catpath .
  38 For each page, it writes a line in the whatis database; each line
  39 consists of the name of the page and a short description, separated
  40 by a dash. The description is extracted using the content of the
  41 NAME section of the manual page.
  42 .LP
  43 Since other languages use a different term for the NAME section,
  44 .B makewhatis
  45 recognizes the equivalent terms in Czech, Italian, Finnish, French,
  46 German and Spanish.
  47 .LP
  48 If no
  49 .I manpath
  50 argument is given,
  51 .I /usr/man
  52 is assumed by default.
  53 .SH OPTIONS
  54 .TP
  55 .B -u
  56 Update database with new pages.
  57 .TP
  58 .B -v
  59 Verbose output
  60 .TP
  61 .B -w
  62 Use manpath obtained from `man --path`
  63 .TP
  64 .BI -s " sections"
  65 Looks in the
  66 .I sections
  67 of
  68 .IR manpath " or " catpath .
  69 If the option is absent, its value is assumed to be
  70 .I  \'1 2 3 4 5 6 7 8 9 n l\'
  71 .TP
  72 .BI -c " catpath"
  73 The preformatted manual pages located in
  74 .I catpath
  75 are scanned. If the argument is not provided, it is assumed to be the
  76 first existing directory between
  77 .IR /usr/man/preformat " and " /usr/man .
  78 .SH EXAMPLES
  79 .PP
  80 To rebuild only
  81 .IR /usr/X11R6/man/whatis " and " /usr/local/man/whatis
  82 .IP
  83 makewhatis /usr/X11R6/man /usr/local/man
  84 .PP
  85 To rebuild all the databases, including those of the Finnish, French
  86 and Italian translations
  87 .IP
  88 LANGUAGE=fi:fr:it makewhatis -w
  89 .SH BUGS
  90 .B makewhatis
  91 may not handle too well manual pages written with non-standard troff
  92 macros, such as the Tcl/Tk pages.
  93 .PP
  94 .B makewhatis
  95 does not work on preformatted translations.
  96 .SH SEE ALSO
  97 .BR apropos (1),
  98 .BR man (1),
  99 .BR whatis (1)