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] NAMESquare 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
Usage examples
Open the SSH manual
man sshThe command manual opens in the configured pager.
Open the SSH configuration manual
man 5 ssh_configThe configuration-file manual is selected explicitly rather than the command page.
Find pages by keyword
man -k archiveManual 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.