Skip to content

Commit

Permalink
Base: Move GUI application man pages into their own subsection
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
kleinesfilmroellchen authored and linusg committed Jan 8, 2023
1 parent b89be96 commit 66a68a9
Show file tree
Hide file tree
Showing 45 changed files with 46 additions and 11 deletions.
36 changes: 36 additions & 0 deletions Base/usr/share/man/man1/Applications.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## Name

Applications - SerenityOS GUI applications

## Description

SerenityOS comes with a suite of GUI applications. The applications are divided into multiple categories, through which they are available in the start menu.

Note that many applications can be disabled at SerenityOS build time if desired. Therefore, depending on your SerenityOS build configuration, not all applications may be available.

## See also

- Documentation for SerenityOS Games in section 6

### List of Application manpages

- [About](help:https://man/1/Applications/About)
- [Analog Clock](help:https://man/1/Applications/AnalogClock)
- [Assistant](help:https://man/1/Applications/Assistant)
- [Browser](help:https://man/1/Applications/Browser)
- [Calculator](help:https://man/1/Applications/Calculator)
- [Calendar](help:https://man/1/Applications/Calendar)
- [Character Map](help:https://man/1/Applications/CharacterMap)
- [Eyes](help:https://man/1/Applications/Eyes)
- [FontEditor](help:https://man/1/Applications/FontEditor)
- [GML Playground](help:https://man/1/Applications/GMLPlayground)
- [Hex Editor](help:https://man/1/Applications/HexEditor)
- [Image Viewer](help:https://man/1/Applications/ImageViewer)
- [Inspector](help:https://man/1/Applications/Inspector)
- [Magnifier](help:https://man/1/Applications/Magnifier)
- [Mail](help:https://man/1/Applications/Mail)
- [Mouse Settings](help:https://man/1/Applications/MouseSettings)
- [Presenter](help:https://man/1/Applications/Presenter)
- [SQL Studio](help:https://man/1/Applications/SQLStudio)
- [Terminal](help:https://man/1/Applications/Terminal)
- [Text Editor](help:https://man/1/Applications/TextEditor)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,4 @@ $ CharacterMap --search "yak"

## See Also

* [`FontEditor`(1)](help:https://man/1/FontEditor) To edit the fonts instead of just viewing them.

* [`FontEditor`(1)](help:https://man/1/Applications/FontEditor) To edit the fonts instead of just viewing them.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions Base/usr/share/man/man1/bt.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ $ watch -n 1 -- bt 124

## See also

* [`Inspector`(1)](help:https://man/1/Inspector)
* [`Inspector`(1)](help:https://man/1/Applications/Inspector)

* [`Profiler`(1)](help:https://man/1/Profiler)
* [`Profiler`(1)](help:https://man/1/Applications/Profiler)

* [`watch`(1)](help:https://man/1/watch)
2 changes: 1 addition & 1 deletion Base/usr/share/man/man1/man.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,5 @@ this man page should be located at `/usr/share/man/man1/man.md`.
## See Also

* [`less`(1)](help:https://man/1/less) For the terminal pager that `man` uses by default
* [`Help`(1)](help:https://man/1/Help) To read these same man pages in a GUI
* [`Help`(1)](help:https://man/1/Applications/Help) To read these same man pages in a GUI
* [`man`(7)](help:https://man/7/man) For an overview on how manpages are organized
2 changes: 1 addition & 1 deletion Base/usr/share/man/man1/profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ $ profile -t syscall -- echo "Hello friends!"

## See also

* [`Profiler`(1)](help:https://man/1/Profiler) GUI for viewing profiling data produced by `profile`.
* [`Profiler`(1)](help:https://man/1/Applications/Profiler) GUI for viewing profiling data produced by `profile`.
2 changes: 1 addition & 1 deletion Base/usr/share/man/man5/GML.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Or right clicking on a folder in the TreeView and using
## See also

- [gml-format(1)](help:https://man/1/gml-format) formats your GML files.
- [GML Playground(1)](help:https://man/1/GMLPlayground) is an interactive GML creation tool.
- [Applications/GML Playground(1)](help:https://man/1/Applications/GMLPlayground) is an interactive GML creation tool.

### List of GML manpages

Expand Down
4 changes: 2 additions & 2 deletions Base/usr/share/man/man5/presenter.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ presenter - Presenter slide presentation format (.presenter)

## Description

The presenter file format is a format for specifying slides and presentations in a JSON-based format. It is intentionally simple, allowing it to be written by hand. It is the native format of [Presenter](help:https://man/1/Presenter).
The presenter file format is a format for specifying slides and presentations in a JSON-based format. It is intentionally simple, allowing it to be written by hand. It is the native format of [Presenter](help:https://man/1/Applications/Presenter).

This manpage specifies version 1 of the presenter file format.

Expand Down Expand Up @@ -72,4 +72,4 @@ The following types with their own special properties exist:

## See also

- [Presenter(1)](help:https://man/1/Presenter)
- [Presenter(1)](help:https://man/1/Applications/Presenter)
4 changes: 2 additions & 2 deletions Base/usr/share/man/man7/man.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Note that documentation might cover standardized topics (such as standard POSIX

There are three ways of accessing the manual pages:

- [`Help`(1)](help:https://man/1/Help) provides a graphical user interface for the man pages.
- [`Help`(1)](help:https://man/1/Applications/Help) provides a graphical user interface for the man pages.
- [`man`(1)](help:https://man/1/man) implements the standard POSIX utility by accessing the man pages in the terminal.
- You can also choose to open the underlying Markdown files (see [Organization](#organization)) directly.

Expand Down Expand Up @@ -54,4 +54,4 @@ When you open a page via command-line arguments, the section is specified separa
## See Also

- [`man`(1)](help:https://man/1/man) To read manpages in the terminal
- [`Help`(1)](help:https://man/1/Help) To read manpages in a GUI
- [`Help`(1)](help:https://man/1/Applications/Help) To read manpages in a GUI

0 comments on commit 66a68a9

Please sign in to comment.