Apropos (Unix) Explained

apropos
Operating System:Unix and Unix-like
Genre:Command

In computing, is a command to search the man page files in Unix and Unix-like operating systems. Apropos takes its name from the French "à propos" (Latin "ad prōpositum") which means about. It is particularly useful when searching for commands without knowing their exact names.

Behavior

Often a wrapper for the command, the apropos command is used to search the "name" sections of all manual pages for the specified string or strings (called keywords). The output is a list of all manual pages containing the search term (case insensitive) in their name or description. This is often useful if one knows the action that is desired, but does not remember the exact command or page name.

usually searches in a precompiled database that is shared with, a command for obtaining the brief description of a specific command whose exact name is already known.

Sample usage

The following example demonstrates the output of the command:$ apropos mountfree (1) - Display amount of free and used memory in the systemmklost+found (8) - create a lost+found directory on a mounted Linux second extended file systemmount (8) - mount a file systemmountpoint (1) - see if a directory is a mountpointntfsmount (8) - Read/Write userspace NTFS driver.sleep (1) - delay for a specified amount of timeswitch_root (8) - switch to another filesystem as the root of the mount tree.umount (8) - unmount file systems

In this example, is used to search for the keyword "mount", and returns the indicated man pages that include the term "mount".

The following example demonstrates the output of the command with an regexp keyword (abc.n) and a regular keyword:

$ apropos abc.n xzlessXTestGrabControl (3) - XTest extension functionsxzless (1) - view xz or lzma compressed (text) files

In this example, is used to search for the keywords (with a regular expression) "abc.n" and xzless, and returns the indicated man pages that include the keywords.

Related utilities

is a command for obtaining the brief description of a specific command whose exact name is already known. It uses the same database as does. On systems with mandoc, it is a wrapper for (search by name only).

$ whatis whatiswhatis(1) - search the whatis database for complete words

is a command for indexing all on-disk manuals into a database that and can read from. It first appeared in the 2BSD of 1979, but has since been rewritten multiple times in different implementations of . is a command that performs the same function in man-db.

The database is traditionally plain text, but man-db, the implementation found on many Linux distributions, use a Berkeley DB instead.[1] The mandoc implementation used on many BSD distributions likewise has its own innovations on the format.

See also

External links

Notes and References

  1. Web site: Watson C. man-db, the on-line manual database . man-db.nongnu.org . 8 May 2019 . It uses a Berkeley DB database in place of the traditional flat-text whatis databases. man-db is used by several popular GNU/Linux distributions.