usr.sbin/makewhatis/makewhatis.8

   1 .\" Copyright (c) 2002 John Rochester
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/usr.bin/makewhatis/makewhatis.1,v 1.3 2002/05/18 15:39:56 ru Exp $
  26 .\" $DragonFly: src/usr.sbin/makewhatis/makewhatis.8,v 1.1 2004/03/25 18:05:48 joerg Exp $
  27 .\"
  28 .Dd May 12, 2002
  29 .Dt MAKEWHATIS 8
  30 .Os
  31 .Sh NAME
  32 .Nm makewhatis
  33 .Nd "create whatis database"
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Fl a
  37 .Op Fl i Ar column
  38 .Op Fl n Ar name
  39 .Op Fl o Ar file
  40 .Op Fl v
  41 .Op Fl L
  42 .Op Ar directories ...
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 utility collects the names and short descriptions from all the unformatted
  47 man pages in the
  48 .Ar directories
  49 and puts them into a file used by the
  50 .Xr whatis 1
  51 and
  52 .Xr apropos 1
  53 commands.
  54 Directories may be separated by colons instead of spaces.
  55 If no
  56 .Ar directories
  57 are specified, the contents of the
  58 .Ev MANPATH
  59 environment variable will be used, or if that is not set, the default directory
  60 .Pa /usr/share/man
  61 will be processed.
  62 .Pp
  63 The options are as follows:
  64 .Bl -tag -width ".Fl i Ar column"
  65 .It Fl a
  66 Appends to the output file(s) instead of replacing them.
  67 The output
  68 will be sorted with duplicate lines removed, but may have obsolete
  69 entries.
  70 .It Fl i Ar column
  71 Indents the description by
  72 .Ar column
  73 characters.
  74 The default value is 24.
  75 .It Fl n Ar name
  76 Uses
  77 .Ar name
  78 instead of
  79 .Pa whatis .
  80 .It Fl o Ar file
  81 Outputs all lines to the
  82 .Ar file
  83 instead of
  84 .Pa */man/whatis .
  85 .It Fl v
  86 Makes
  87 .Nm
  88 more verbose about what it is doing.
  89 .It Fl L
  90 Process only localized subdirectories corresponding to the locale specified
  91 in the standard environment variables.
  92 .El
  93 .Sh ENVIRONMENT
  94 .Bl -tag -width ".Ev MANPATH"
  95 .It Ev LC_ALL , LC_CTYPE , LANG
  96 These variables control what subdirectories will be processed if the
  97 .Fl L
  98 option is used.
  99 .It Ev MACHINE
 100 If set, its value is used to override the current
 101 machine type when searching machine specific subdirectories.
 102 .It Ev MANPATH
 103 Determines the set of directories to be processed if none are given on
 104 the command line.
 105 .El
 106 .Sh FILES
 107 .Bl -tag -width ".Pa /usr/share/man" -compact
 108 .It Pa /usr/share/man
 109 Default directory to process if the
 110 .Ev MANPATH
 111 environment variable is not set.
 112 .It Pa */man/whatis
 113 The default output file.
 114 .El
 115 .Sh EXIT STATUS
 116 .Ex -std
 117 .Sh SEE ALSO
 118 .Xr apropos 1 ,
 119 .Xr whatis 1
 120 .Sh HISTORY
 121 The
 122 .Nm
 123 command appeared in
 124 .Fx 2.1 .
 125 .Sh AUTHORS
 126 .An -nosplit
 127 The
 128 .Nm
 129 program was originally written in Perl and was contributed by
 130 .An Wolfram Schneider .
 131 The current version of
 132 .Nm
 133 was rewritten in C by
 134 .An John Rochester .