summaryrefslogtreecommitdiff
path: root/Base/usr/share/man/man1/man.md
blob: 438cd6e2df827a3f1c6d181f912d8a20cc17e7f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
## Name

man - read manual pages

## Synopsis

```**sh
$ man page
$ man section page
```

## Description

`man` finds, loads and displays the so-called manual pages,
or man pages for short, from the SerenityOS manual. You're reading
the manual page for `man` program itself right now.

## Sections

The SerenityOS manual is split into the following *sections*, or *chapters*:

1. Command-line programs
2. System calls
3. Libraries
4. Special files
5. File formats
6. Games
7. Miscellanea
8. Sysadmin tools

Sections are subject to change in the future.

## 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`.