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 .\"
  27 .Dd December 8, 2013
  28 .Dt MAKEWHATIS 8
  29 .Os
  30 .Sh NAME
  31 .Nm makewhatis
  32 .Nd create whatis database
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Fl a
  36 .Op Fl i Ar column
  37 .Op Fl n Ar name
  38 .Op Fl o Ar file
  39 .Op Fl v
  40 .Op Fl L
  41 .Op Ar directories ...
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 utility collects the names and short descriptions from all the unformatted
  46 man pages in the
  47 .Ar directories
  48 and puts them into a file used by the
  49 .Xr whatis 1
  50 and
  51 .Xr apropos 1
  52 commands.
  53 Directories may be separated by colons instead of spaces.
  54 If no
  55 .Ar directories
  56 are specified, the contents of the
  57 .Ev MANPATH
  58 environment variable will be used, or if that is not set, the default directory
  59 .Pa /usr/share/man
  60 will be processed.
  61 .Pp
  62 The options are as follows:
  63 .Bl -tag -width ".Fl i Ar column"
  64 .It Fl a
  65 Appends to the output file(s) instead of replacing them.
  66 The output
  67 will be sorted with duplicate lines removed, but may have obsolete
  68 entries.
  69 .It Fl i Ar column
  70 Indents the description by
  71 .Ar column
  72 characters.
  73 The default value is 24.
  74 .It Fl n Ar name
  75 Uses
  76 .Ar name
  77 instead of
  78 .Pa whatis .
  79 .It Fl o Ar file
  80 Outputs all lines to the
  81 .Ar file
  82 instead of
  83 .Pa */man/whatis .
  84 .It Fl v
  85 Makes
  86 .Nm
  87 more verbose about what it is doing.
  88 .It Fl L
  89 Process only localized subdirectories corresponding to the locale specified
  90 in the standard environment variables.
  91 .El
  92 .Sh ENVIRONMENT
  93 .Bl -tag -width ".Ev MANPATH"
  94 .It Ev LC_ALL , LC_CTYPE , LANG
  95 These variables control what subdirectories will be processed if the
  96 .Fl L
  97 option is used.
  98 .It Ev MACHINE
  99 If set, its value is used to override the current
 100 machine type when searching machine specific subdirectories.
 101 .It Ev MANPATH
 102 Determines the set of directories to be processed if none are given on
 103 the command line.
 104 .El
 105 .Sh FILES
 106 .Bl -tag -width ".Pa /usr/share/man" -compact
 107 .It Pa /usr/share/man
 108 Default directory to process if the
 109 .Ev MANPATH
 110 environment variable is not set.
 111 .It Pa */man/whatis
 112 The default output file.
 113 .El
 114 .Sh EXIT STATUS
 115 .Ex -std
 116 .Sh SEE ALSO
 117 .Xr apropos 1 ,
 118 .Xr whatis 1
 119 .Sh HISTORY
 120 The
 121 .Nm
 122 command appeared in
 123 .Fx 2.1 .
 124 .Sh AUTHORS
 125 .An -nosplit
 126 The
 127 .Nm
 128 program was originally written in Perl and was contributed by
 129 .An Wolfram Schneider .
 130 The current version of
 131 .Nm
 132 was rewritten in C by
 133 .An John Rochester
 134 with additional contributions by
 135 .An Franco Fichtner Aq Mt franco@lastsummer.de .