whatis Command in Linux

Introduction to the Linux whatis Command

In this tutorial, you'll explore the Linux whatis command and its role in system administration. The whatis command is a valuable tool for quickly understanding the functionality of commands or system components. It achieves this by searching the system's manual page database and providing a concise description. This guide will cover the command's purpose, syntax, and options, along with practical examples. This is especially beneficial for new Linux users and seasoned systemadmins alike who need a rapid overview of command functionalities.

Understanding the Core Function of the whatis Command

This section focuses on the fundamental purpose of the whatis command within a Linux environment. As a systemadmin tool, whatis efficiently retrieves a brief explanation of commands or system elements by querying the manual page database.

Let's begin with a basic demonstration of the whatis command in action:

whatis ls

Example output:

ls (1)           - list directory contents

The output clearly shows that whatis provides a one-line summary of the ls command, indicating its purpose: to list the contents of a directory.

The whatis command is particularly useful when you need to quickly grasp the function of a command or system component without delving into the complete manual page. This makes it an excellent resource, especially for those new to Linux, helping them navigate and understand the various commands and utilities available.

Delving into the Syntax and Available Options of the whatis Command

This section explores the syntax and various options available when using the whatis command.

The standard syntax for the whatis command is:

whatis [options] keyword

Here are some commonly used options with the whatis command:

  • -a or --appropos: This option expands the search to include manual page names in addition to descriptions, broadening the search scope.
  • -n or --section: Use this option to specify a particular manual section to search within. For instance, 1 designates user commands, while 5 pertains to file formats.
  • -r or --regex: Allows you to interpret the keyword as a regular expression, enabling more complex search patterns.
  • -s or --sections: Enables you to define a comma-separated list of manual sections to target in the search.

Let's illustrate these options with some practical examples:

whatis -a grep

Example output:

grep (1)         - print lines matching a pattern
grep (1p)        - a pattern matching utility

Using the -a option instructs whatis to search both the command name and description, leading to a more comprehensive set of results.

whatis -n 5 passwd

Example output:

passwd (5)       - password file

The -n 5 option restricts the search to only the manual section dedicated to file formats.

whatis -r '^ls'

Example output:

ls (1)           - list directory contents

Employing the -r option allows the use of a regular expression as the search term, offering greater flexibility in defining the search.

Practical Applications of the whatis Command for Systemadmins

In this section, we'll examine real-world scenarios where the whatis command proves invaluable for systemadmins.

A frequent use case is quickly determining the purpose of an unfamiliar command or system component. For instance, if you encounter the du command and need to understand its function:

whatis du

Example output:

du (1)           - estimate file space usage

This clearly indicates that the du command is designed to estimate file space usage.

Another practical application is discovering related commands or utilities when you have a general understanding of the desired function but lack the specific command name. If you're looking for commands related to user account management, the -a option can be very helpful:

whatis -a user

Example output:

adduser (8)      - add a new user or update default new user information
deluser (8)      - remove a user account and related files
usermod (8)      - modify a user account
useradd (8)      - create a new user or update default new user information
userdel (8)      - delete a user account

This provides a list of commands associated with user management, aiding in selecting the appropriate tool for the task.

Finally, the whatis command is useful for verifying the manual section of a particular command or component, especially when a command shares its name with a file format or system component. For example:

whatis -n 5 passwd

Example output:

passwd (5)       - password file

This demonstrates that passwd has a manual page in section 5, which deals with file formats, rather than the user command in section 1. This distinction is crucial for systemadmins.

Conclusion

In summary, this tutorial has covered the essential aspects of the whatis command in Linux, a key tool for any systemadmin. You've learned that it serves to provide a concise description of a command or system component by querying the system's manual page database. We explored its syntax and options, including the -a option for broader searches and the -n option for specifying manual sections. These insights equip you with the knowledge to effectively leverage the whatis command for quickly understanding Linux commands and utilities, making you a more efficient systemadmin.

400+ Linux Commands