74 lines
2.2 KiB
HTML
74 lines
2.2 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<TITLE>whatis(5)</TITLE>
|
|
</HEAD>
|
|
<BODY>
|
|
<H1>whatis(5)</H1>
|
|
<HR>
|
|
<PRE>
|
|
|
|
</PRE>
|
|
<H2>NAME</H2><PRE>
|
|
whatis - database of online manual pages
|
|
|
|
|
|
</PRE>
|
|
<H2>SYNOPSIS</H2><PRE>
|
|
<STRONG>/usr/man/*/whatis</STRONG>
|
|
<STRONG>/usr/man/whatis</STRONG>
|
|
|
|
|
|
</PRE>
|
|
<H2>DESCRIPTION</H2><PRE>
|
|
The <STRONG>whatis</STRONG> file in each manual page directory is a database of titles for
|
|
manual pages. This database is used by <STRONG><A HREF="../man1/man.1.html">man(1)</A></STRONG> to map titles to manual
|
|
pages names. The database is created by <STRONG><A HREF="../man1/makewhatis.1.html">makewhatis(1)</A></STRONG> from the NAME
|
|
sections of the manual pages.
|
|
|
|
The NAME secions must be simple lines with no troff fluff but one
|
|
backslash like these two:
|
|
|
|
whatis \- database of online manual pages
|
|
cawf, nroff \- C version of the nroff-like, Amazingly Workable
|
|
(text) Formatter
|
|
|
|
These lines are transformed by <STRONG>makewhatis</STRONG> to these two lines for the
|
|
database:
|
|
|
|
cawf, nroff (1) - C version of the nroff-like, Amazingly Workable
|
|
(text) Formatter
|
|
whatis (5) - database of online manual pages
|
|
|
|
As you can see they are in section number order, so that <STRONG>man</STRONG> searches
|
|
them in section order.
|
|
|
|
Each entry is just a single line, restricting the NAME section to a
|
|
single line too with just one dash, and commas and spaces before the dash
|
|
as you see above.
|
|
|
|
|
|
</PRE>
|
|
<H2>SEE ALSO</H2><PRE>
|
|
<STRONG><A HREF="../man1/man.1.html">man(1)</A></STRONG>, <STRONG><A HREF="../man1/whatis.1.html">whatis(1)</A></STRONG>, <STRONG><A HREF="../man1/makewhatis.1.html">makewhatis(1)</A></STRONG>, <STRONG><A HREF="../man7/man.7.html">man(7)</A></STRONG>.
|
|
|
|
|
|
</PRE>
|
|
<H2>BUGS</H2><PRE>
|
|
It seems to be impossible for many manual page writers to keep the NAME
|
|
section simple. They also like to use every font available in their
|
|
documents. My simple scripts can't read their NAME sections, my simple
|
|
me can't read their texts.
|
|
|
|
|
|
</PRE>
|
|
<H2>AUTHOR</H2><PRE>
|
|
Kees J. Bot (kjb@cs.vu.nl)
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
</BODY>
|
|
</HTML>
|