diff options
author | Sam Atkins <atkinssj@serenityos.org> | 2021-12-20 16:16:08 +0000 |
---|---|---|
committer | Brian Gianforcaro <b.gianfo@gmail.com> | 2021-12-20 10:58:41 -0800 |
commit | f11fbb6415ccee2a430dad834deebd10862dfc23 (patch) | |
tree | a8eed01ba34549eeb08fcc5a153e972cd343c506 /Base/usr/share | |
parent | 85a54261b3f7eb38001e98beb9ff9b9ef9d7b2cd (diff) | |
download | serenity-f11fbb6415ccee2a430dad834deebd10862dfc23.zip |
Base: Add a man page for Help
This is largely copied from the `man` man page, since the same
information applies.
Diffstat (limited to 'Base/usr/share')
-rw-r--r-- | Base/usr/share/man/man1/Help.md | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/Base/usr/share/man/man1/Help.md b/Base/usr/share/man/man1/Help.md new file mode 100644 index 0000000000..907796bfe9 --- /dev/null +++ b/Base/usr/share/man/man1/Help.md @@ -0,0 +1,63 @@ +## 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)](man.md) To read these same man pages from the terminal + |