Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

makewhatis(8) [redhat man page]

MAKEWHATIS(8)						      System Manager's Manual						     MAKEWHATIS(8)

NAME
makewhatis - Create the whatis database SYNOPSIS
makewhatis [-u] [-v] [-w] [-s sections ] [-c [catpath]] [manpath] DESCRIPTION
makewhatis reads all the manual pages contained in the given sections of manpath or the preformatted pages contained in the given sections of catpath. For each page, it writes a line in the whatis database; each line consists of the name of the page and a short description, separated by a dash. The description is extracted using the content of the NAME section of the manual page. Since other languages use a different term for the NAME section, makewhatis recognizes the equivalent terms in Czech, Italian, Finnish, French, German and Spanish. If no manpath argument is given, /usr/man is assumed by default. OPTIONS
-u Update database with new pages. -v Verbose output -w Use manpath obtained from `man --path` -s sections Looks in the sections of manpath or catpath. If the option is absent, its value is assumed to be '1 2 3 4 5 6 7 8 9 n l' -c catpath The preformatted manual pages located in catpath are scanned. If the argument is not provided, it is assumed to be the first exist- ing directory between /usr/man/preformat and /usr/man. EXAMPLES
To rebuild only /usr/X11R6/man/whatis and /usr/local/man/whatis makewhatis /usr/X11R6/man /usr/local/man To rebuild all the databases, including those of the Finnish, French and Italian translations LANGUAGE=fi:fr:it makewhatis -w BUGS
makewhatis may not handle too well manual pages written with non-standard troff macros, such as the Tcl/Tk pages. makewhatis does not work on preformatted translations. SEE ALSO
apropos(1), man(1), whatis(1) 22 January 1999 MAKEWHATIS(8)

Check Out this Related Man Page

MAN.CONF(5)                                                     File Formats Manual                                                    MAN.CONF(5)

NAME
man.conf - configuration file for man DESCRIPTION
This is the configuration file for the man(1), apropos(1), and makewhatis(8) utilities. Its presence, and all directives, are optional. This file is an ASCII text file. Leading whitespace on lines, lines starting with '#', and blank lines are ignored. Words are separated by whitespace. The first word on each line is the name of a configuration directive. The following directives are supported: manpath path Override the default search path for man(1), apropos(1), and makewhatis(8). It can be used multiple times to specify multiple paths, with the order determining the manual page search order. Each path is a tree containing subdirectories whose names consist of the strings 'man' and/or 'cat' followed by the names of sections, usually single digits. The former are supposed to contain unformatted manual pages in mdoc(7) and/or man(7) format; file names should end with the name of the section preceded by a dot. The latter should contain preformatted manual pages; file names should end with '.0'. Creating a mandoc.db(5) database with makewhatis(8) in each directory configured with manpath is recommended and necessary for apropos(1) to work, but not strictly required for man(1). output option [value] Configure the default value of an output option. These directives are overridden by the -O command line options of the same names. For details, see the mandoc(1) manual. option value used by -T fragment none html includes string html indent integer ascii, utf8 man string html paper string ps, pdf style string html width integer ascii, utf8 _whatdb path/whatis.db This directive provides the same functionality as manpath, but using a historic and misleading syntax. It is kept for backward compatibility for now, but will eventually be removed. FILES
/etc/man.conf EXAMPLES
The following configuration file reproduces the defaults: installing it is equivalent to not having a man.conf file at all. manpath /usr/share/man manpath /usr/X11R6/man manpath /usr/local/man SEE ALSO
apropos(1), man(1), makewhatis(8) HISTORY
A relatively complicated man.conf file format first appeared in 4.3BSD-Reno. For OpenBSD 5.8, it was redesigned from scratch, aiming for simplicity. AUTHORS
Ingo Schwarze <schwarze@openbsd.org> Debian December 28, 2016 MAN.CONF(5)
Man Page

Featured Tech Videos