summaryrefslogtreecommitdiff
path: root/Base/usr/share/man/man1/Help.md
blob: 2c505907a97a0dddf57fa1b1e050c092a3196015 (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
## Name

![Icon](/res/icons/16x16/app-help.png) Help - digital manual

[Open](file:///bin/Help)

## Synopsis

```**sh
$ Help
$ Help [section] page
$ Help search_query
$ Help file
```

## Description

`Help` is Serenity's digital manual, the GUI counterpart to `man`.
It lets you search for and read manual pages (or "man pages").

## Examples

To open Help:
```sh
$ Help
```

To open documentation for the `echo` command:
```sh
$ Help echo
```

To open the documentation for the `mkdir` command:
```sh
$ Help 1 mkdir
```
Conversely, to open the documentation about the `mkdir()` syscall:
```sh
$ Help 2 mkdir
```

## Files

`Help` looks for man pages under `/usr/share/man`. For example,
this man page should be located at `/usr/share/man/man1/Help.md`.

## See Also

* [`man`(1)](help://man/1/man) To read these same man pages from the terminal
* [`man`(7)](help://man/7/man) For an overview on how manpages are organized