mirror of
https://github.com/LadybirdBrowser/ladybird.git
synced 2025-05-05 02:33:03 +00:00
98c0c5e9e6
The URLs of the form `help://man/<section>/<page>` link to another help page inside the help application. All previous relative page links are replaced by this new form. This doesn't change any behavior but it looks much nicer :^) Note that man doesn't handle these new links, but the previous relative links didn't work either.
63 lines
1 KiB
Markdown
63 lines
1 KiB
Markdown
## Name
|
|
|
|
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").
|
|
|
|
## Sections
|
|
|
|
The SerenityOS manual is split into the following *sections*, or *chapters*:
|
|
|
|
1. User 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 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
|
|
|