1 .\" Copyright (c) 2002 John Rochester
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .Nd "create whatis database"
41 .Op Ar directories ...
45 utility collects the names and short descriptions from all the unformatted
48 and puts them into a file used by the
53 Directories may be separated by colons instead of spaces.
56 are specified, the contents of the
58 environment variable will be used, or if that is not set, the default directory
62 The options are as follows:
63 .Bl -tag -width ".Fl i Ar column"
65 Appends to the output file(s) instead of replacing them.
67 will be sorted with duplicate lines removed, but may have obsolete
70 Indents the description by
73 The default value is 24.
80 Outputs all lines to the
87 more verbose about what it is doing.
89 Process only localized subdirectories corresponding to the locale specified
90 in the standard environment variables.
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
99 If set, its value is used to override the current
100 machine type when searching machine specific subdirectories.
102 If set, its value is used to override the current
103 architecture when searching architecture specific subdirectories.
105 Determines the set of directories to be processed if none are given on
109 .Bl -tag -width ".Pa /usr/share/man" -compact
110 .It Pa /usr/share/man
111 Default directory to process if the
113 environment variable is not set.
115 The default output file.
131 program was originally written in Perl and was contributed by
132 .An Wolfram Schneider .
133 The current version of
135 was rewritten in C by