RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-27 10:37:45 +00:00
Code Issues Activity Actions

Base: Document manpage structure separately

Browse source 
This section is now removed from Help(1) and man(1).
This commit is contained in:
kleines Filmröllchen 2022-12-14 15:47:50 +01:00 • committed by Andrew Kaster
parent 2d08e53493
commit f824a67b3b
4 changed files with 63 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

17
Base/usr/share/man/man1/Help.md
View file

@ -18,21 +18,6 @@ $ Help file
`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. Library Functions
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:
@ -62,4 +47,4 @@ 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

17
Base/usr/share/man/man1/man.md
View file

@ -15,21 +15,6 @@ $ man section page
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. User Programs
2. System Calls
3. Library Functions
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:
@ -54,3 +39,5 @@ this man page should be located at `/usr/share/man/man1/man.md`.
## See Also
* [`less`(1)](help://man/1/less) For the terminal pager that `man` uses by default
* [`Help`(1)](help://man/1/Help) To read these same man pages in a GUI
* [`man`(7)](help://man/7/man) For an overview on how manpages are organized