RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-10-29 14:32:36 +00:00
Code Issues Activity Actions
serenity/Base/usr/share/man/man1/Help.md
kleines Filmröllchen 98c0c5e9e6 Help+Base: Add help://man URLs for links between man pages 
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.
2022-01-11 00:24:57 +01:00

1 KiB
Raw Blame History

Name

Help

Synopsis

$ 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:

$ Help

To open documentation for the echo command:

$ Help echo

To open the documentation for the mkdir command:

$ Help 1 mkdir

Conversely, to open the documentation about the mkdir() syscall:

$ 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) To read these same man pages from the terminal