Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

whatis(1)

Name

whatis - display a one-line summary about a keyword

Synopsis

whatis command...

Description

whatis looks up a given command and displays the header line from the manual section. You can then run the man(1) command to get more information. If the line starts name(section). . . you can do man –ssection name to get the documentation for it. Try whatis ed and then you should do man –s 1 ed to get the manual page for ed(1).

whatis is actually just the –f option to the man(1) command.

whatis uses the /usr/share/man/man_index/* index files. The index files are either automatically generated by an SMF service as described in man(1) or manually generated by using catman(8) with the –w option. If the index files do not exist, whatis is run slower since it looks directly into manual page files.

Files

/usr/share/man/man_index/*

Table of Contents and keyword database.

Generated files include:

  • /usr/share/man/man_index/man.idx

  • /usr/share/man/man_index/man.dic

  • /usr/share/man/man_index/man.frq

  • /usr/share/man/man_index/man.pos

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
text/doctools
CSI
Enabled
Interface Stability
Committed

See Also

apropos(1), man(1), attributes(7), catman(8)