serenity/Base/usr/share/man/man1/Applications/Help.md at 86781f0c085c607c9e22cbab8e929ea6bb2ad320

mirror of https://github.com/RGBCube/serenity synced 2025-10-24 06:42:07 +00:00

kleines Filmröllchen 66a68a9523 Base: Move GUI application man pages into their own subsection

We do not want to move POSIX utilities into subsections since they have
standard names, but we can do whatever we want with Applications :^).
This is particularly advantageous as many applications contain several
images, which declutters the man1 directory.

2023-01-08 13:35:29 +01:00

923 B

Raw Blame History

Name

Help - digital manual

Open

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").

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.

923 B Raw Blame History