apropos

Section: December 15, 1992 (1)
Updated: USER COMMANDS
Index Return to Main Contents

NAME

apropos - display a one-line summary about a keyword

SYNOPSIS

apropos [-M path ] keyword ...

DESCRIPTION

apropos prints out one-line summaries from the whatis database (table of contents) that contain any of the given keywords . You can then run the man(1) command to get more information. If the line starts `name( section ) ...' you can do `man section name' to get the documentation for it. Try `apropos reference' and then you should do `man 1 man' to get the manual page for man(1).

apropos is actually just the -k option to the man(1) command.

apropos uses the whatis database. This database can be created using the -w option of catman(8).

OPTIONS

-M path

: Change the search path for manual pages. path is a (semi)colon-separated list of subdirectories thar contain manual page directory subtrees. For example, /usr/man;/usr/local/man makes apropos search the whatis database in both /usr/man and /usr/local/man.

ENVIRONMENT

MANPATH: If set, its value overrides /usr/man as the default search path. (The -M flag, in turn, overrides this value.)

FILES

/usr/man/whatis: whatis data base

NOTES

apropos uses the /usr/man/whatis database, which is created by catman(8).

BUGS

apropos has not been tested under TOS (only MiNT).

apropos is not safe in respect to strings. A pathname that is too long can therefore crash apropos. The current limit is 255 characters, which should be long enough for must purposes.

apropos behaves differently from the UN*X version in several respects.

AUTHOR

Hildo Biersma (schuller@dutiag.tudelft.nl)

VERSION

This is version 0.2, the second released version.

This document was created by man2html, using the manual pages.
Time: 23:26:11 GMT, January 03, 2023