ladybird/Base/usr/share/man/man1/Help.md
Brian Gianforcaro 64dfb3a28f Base: Add icons to man pages for GUI applications
Differentiate GUI applications in man pages with icons.

This is the revert of the revert commit, now that the icon processing
was fixed in 89c0f84a28.
Revert: dae298e9df
Original: 74238d0aba

Co-authored-by: electrikmilk <brandonjordan124@gmail.com>
2022-01-17 03:38:54 -08:00

1 KiB

Name

Icon 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