Shell and environment

Command man

Open command documentation

Linux · Bash examples · commands run on the selected server

When to use man

Use man to consult documentation installed for the server's actual tool version. Section numbers distinguish commands from configuration formats and other interfaces with the same name.

Syntax

man [SECTION] NAME

Square brackets mark optional arguments; an ellipsis means repetition. Replace example file names, user names and server addresses with your own values.

Common options and arguments

1
User commands.
5
File and configuration formats.
8
Administrative commands.

Usage examples

Open the SSH manual

man ssh

The command manual opens in the configured pager.

Open the SSH configuration manual

man 5 ssh_config

The configuration-file manual is selected explicitly rather than the command page.

Find pages by keyword

man -k archive

Manual descriptions are searched for the requested topic.

Notes and limitations

  • The availability of pages depends on the installed documentation packages.
  • The section helps to distinguish commands of the same name, system calls and file formats; q usually closes the viewer.

Common questions and troubleshooting

Why does man open the wrong topic?

Several sections can use the same name. Specify the section number for the interface you need.

Why is no manual available on a minimal image?

Documentation packages or the manual database may be absent. Consult the tool's built-in help and the correct upstream version documentation.

Further help

Options vary by version and distribution. Check the installed documentation with this command: man man.