mirror of
https://github.com/RGBCube/serenity
synced 2025-07-28 09:27:45 +00:00
Base: Write some initial man pages
It ain't much, but it's honest work!
This commit is contained in:
parent
36eea6c04b
commit
fed96f455d
8 changed files with 256 additions and 0 deletions
46
Base/usr/share/man/man1/man.md
Normal file
46
Base/usr/share/man/man1/man.md
Normal file
|
@ -0,0 +1,46 @@
|
|||
## 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 Serenity manual. You're reading
|
||||
the manual page for `man` program itself right now.
|
||||
|
||||
## Sections
|
||||
|
||||
The Serenity manual is split into the following *sections*, or *chapters*:
|
||||
|
||||
1. Command-line programs
|
||||
2. System calls
|
||||
|
||||
More sections will be added 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`.
|
Loading…
Add table
Add a link
Reference in a new issue