Forrest logo
tool overview
On this page you find all important commands for the CLI tool whatis. If the command you are looking for is missing please ask our AI.

whatis

The "whatis" command line tool is a utility that provides a brief description of a given command. It is primarily used in Unix-based systems and helps users quickly understand the purpose and function of various commands available.

When executed, "whatis" searches through a pre-built database known as the "whatis database" or "man pages." These man pages contain concise information about commands, including their usage and syntax.

The tool typically displays a single-line summary of the specified command, making it useful for quickly looking up commands without having to navigate lengthy documentation.

"whatis" is often paired with another command called "man," which stands for "manual pages." Once a user identifies a command using "whatis," they can then use "man" to access a more comprehensive documentation of that command.

Additionally, "whatis" can be used in conjunction with wildcards to search for commands with similar names or functions, providing users with a way to explore related commands or options they may not be aware of.

This command line tool is a handy resource for both beginners and experienced users who want to quickly get a high-level understanding of a command's purpose before delving deeper into its usage.

List of commands for whatis:

  • whatis:tldr:1ad65 whatis: Search man page descriptions with a regular expression.
    $ whatis --regex '${wish[0-9]\-[0-9]}'
    try on your machine
    explain this command
  • whatis:tldr:2eb6e whatis: Don't cut the description off at the end of the line.
    $ whatis --long ${command}
    try on your machine
    explain this command
  • whatis:tldr:31a6a whatis: Display descriptions of a specific language (requires `manpage-{{locale}}` package).
    $ whatis --locale=${en} ${command}
    try on your machine
    explain this command
  • whatis:tldr:91256 whatis: Display a description from a man page.
    $ whatis ${command}
    try on your machine
    explain this command
  • whatis:tldr:91512 whatis: Display descriptions for all commands matching a glob.
    $ whatis --wildcard ${net*}
    try on your machine
    explain this command
  • whatis:tldr:c0ae8 whatis: Search for information about multiple keywords.
    $ whatis ${keyword1} ${keyword2}
    try on your machine
    explain this command
tool overview