2019-09-21 00:47:00 +03:00
|
|
|
## Name
|
|
|
|
|
|
|
|
|
|
man - read manual pages
|
|
|
|
|
|
|
|
|
|
## Synopsis
|
|
|
|
|
|
|
|
|
|
```**sh
|
|
|
|
|
$ man page
|
|
|
|
|
$ man section page
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Description
|
|
|
|
|
|
|
|
|
|
`man` finds, loads and displays the so-called manual pages,
|
2020-02-18 16:54:29 +08:00
|
|
|
or man pages for short, from the SerenityOS manual. You're reading
|
2019-09-21 00:47:00 +03:00
|
|
|
the manual page for `man` program itself right now.
|
|
|
|
|
|
2023-03-30 22:57:12 +01:00
|
|
|
## Options
|
|
|
|
|
|
|
|
|
|
* `-P pager`, `--pager pager`: Pager to pipe the man page to
|
|
|
|
|
|
2019-09-21 00:47:00 +03:00
|
|
|
## Examples
|
|
|
|
|
|
|
|
|
|
To open documentation for the `echo` command:
|
|
|
|
|
```sh
|
|
|
|
|
$ man echo
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To open the documentation for the `mkdir` command:
|
|
|
|
|
```sh
|
|
|
|
|
$ man 1 mkdir
|
|
|
|
|
```
|
|
|
|
|
Conversely, to open the documentation about the `mkdir()` syscall:
|
|
|
|
|
```sh
|
|
|
|
|
$ man 2 mkdir
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Files
|
|
|
|
|
|
|
|
|
|
`man` looks for man pages under `/usr/share/man`. For example,
|
|
|
|
|
this man page should be located at `/usr/share/man/man1/man.md`.
|
2021-07-06 19:47:00 -06:00
|
|
|
|
|
|
|
|
## See Also
|
|
|
|
|
|
2022-01-07 14:15:44 +01:00
|
|
|
* [`less`(1)](help://man/1/less) For the terminal pager that `man` uses by default
|
2023-01-07 17:18:04 +01:00
|
|
|
* [`Help`(1)](help://man/1/Applications/Help) To read these same man pages in a GUI
|
2022-12-14 15:47:50 +01:00
|
|
|
* [`man`(7)](help://man/7/man) For an overview on how manpages are organized
|