MKWHATIS

Section: Misc. Reference Manual Pages (8 )
Index Return to Main Contents

NAME

mkwhatis - tool for making entries in whatis(1) databases

SYNOPSIS

mkwhatis manpage...

DESCRIPTION

mkwhatis reads the input files (which should be manpage source files) and extracts information for the database used by whatis(1). It is not perfect, but should help substantially in this otherwise tedious task.

NOTES

For the format of the whatis database, see whatis(5).

whatis assumes manpages that look like this:

        .TH FOO 1X              <-- section, subsection
        .SH NAME
        foo \- blah blah blah   <-- name, desc
        .SH DESCIPTION
        .
        .
        .
        .SH "SEE ALSO"
        bar(1), foobar(5)       <-- cross references
        .SH SOMETHING  (or eof)

or

        .TH FOO 1 LOCAL
        .
        .
        .

It does not handle sourced files (aliases), ie:

        .so man1/foo.1

At a minimum, you will have to add keywords yourself.

AUTHOR

Bill Rosenkranz
rosenkra@convex.com

VERSION

mkwhatis 2.0.1 92/9/12 rosenkra

This document was created by man2html, using the manual pages.
Time: 03:58:29 GMT, September 10, 2022