summaryrefslogtreecommitdiff
path: root/Base/usr/share/man/man1
diff options
context:
space:
mode:
authorChase Struck <chasestruck@outlook.com>2022-06-09 16:42:55 -0500
committerBrian Gianforcaro <b.gianfo@gmail.com>2022-07-29 20:48:04 +0000
commit835d516d10cc785d9504f88e42846da3300f9290 (patch)
tree705645fdb34d3549331c08abe44dded432a518e0 /Base/usr/share/man/man1
parentc84e2e2891a0a1ba82c04742b7d48dea8155869e (diff)
downloadserenity-835d516d10cc785d9504f88e42846da3300f9290.zip
Base: Add more manpages
This commit adds manpages for About(1), AnalogClock(1), Assistant(1), Browser(1), Calculator(1), and Calendar(1).
Diffstat (limited to 'Base/usr/share/man/man1')
-rw-r--r--Base/usr/share/man/man1/About.md15
-rw-r--r--Base/usr/share/man/man1/AnalogClock.md15
-rw-r--r--Base/usr/share/man/man1/Assistant.md15
-rw-r--r--Base/usr/share/man/man1/Browser.md34
-rw-r--r--Base/usr/share/man/man1/Calculator.md15
-rw-r--r--Base/usr/share/man/man1/Calendar.md15
6 files changed, 109 insertions, 0 deletions
diff --git a/Base/usr/share/man/man1/About.md b/Base/usr/share/man/man1/About.md
new file mode 100644
index 0000000000..5c72718840
--- /dev/null
+++ b/Base/usr/share/man/man1/About.md
@@ -0,0 +1,15 @@
+## Name
+
+![Icon](/res/icons/16x16/ladyball.png) About - About SerenityOS
+
+[Open](file:///bin/About)
+
+## Synopsis
+
+```**sh
+$ About
+```
+
+## Description
+
+`About` is an application that displays information about Serenity.
diff --git a/Base/usr/share/man/man1/AnalogClock.md b/Base/usr/share/man/man1/AnalogClock.md
new file mode 100644
index 0000000000..44f8522ddf
--- /dev/null
+++ b/Base/usr/share/man/man1/AnalogClock.md
@@ -0,0 +1,15 @@
+## Name
+
+![Icon](/res/icons/16x16/app-analog-clock.png) Analog Clock - Serenity analog clock
+
+[Open](file:///bin/AnalogClock)
+
+## Synopsis
+
+```**sh
+$ AnalogClock
+```
+
+## Description
+
+`Analog Clock` provides an Analog Clock that can be moved around the desktop.
diff --git a/Base/usr/share/man/man1/Assistant.md b/Base/usr/share/man/man1/Assistant.md
new file mode 100644
index 0000000000..d94626adfd
--- /dev/null
+++ b/Base/usr/share/man/man1/Assistant.md
@@ -0,0 +1,15 @@
+## Name
+
+Assistant - Serenity Assistant
+
+[Open](file:///bin/Assistant)
+
+## Synopsis
+
+```**sh
+$ Assistant
+```
+
+## Description
+
+`Assistant` is a helpful program that is used to search for and open applications, files, settings, and anything else a user may want to access. It can be opened by pressing `Super+Space` and closed by pressing `Esc`.
diff --git a/Base/usr/share/man/man1/Browser.md b/Base/usr/share/man/man1/Browser.md
new file mode 100644
index 0000000000..a4c97f9ca9
--- /dev/null
+++ b/Base/usr/share/man/man1/Browser.md
@@ -0,0 +1,34 @@
+## Name
+
+![Icon](/res/icons/16x16/app-browser.png) Browser - Serenity WWW Browser
+
+[Open](file:///bin/Browser)
+
+## Synopsis
+
+```**sh
+$ Browser
+$ Browser [options]
+$ Browser [url]
+```
+
+## Description
+
+`Browser` is an application used to view the World Wide Web. It is built on top of Serenity's own `LibWeb` and `LibJS` engines, allowing it to render HTML, CSS, and JavaScript.
+
+## Options
+
+* `--help`: Display help message and exit
+* `--version`: Display version number and exit
+
+## Arguments
+
+* `url`: URL to open
+
+## Examples
+
+```**sh
+$ Browser
+$ Browser --help
+$ Browser https://serenityos.org/
+```
diff --git a/Base/usr/share/man/man1/Calculator.md b/Base/usr/share/man/man1/Calculator.md
new file mode 100644
index 0000000000..b3b9aaf46a
--- /dev/null
+++ b/Base/usr/share/man/man1/Calculator.md
@@ -0,0 +1,15 @@
+## Name
+
+![Icon](/res/icons/16x16/app-calculator.png) Calculator - Serenity calculator
+
+[Open](file:///bin/Calculator)
+
+## Synopsis
+
+```**sh
+$ Calculator
+```
+
+## Description
+
+`Calculator` is a graphical calculator application. It supports basic arithmetic calculations in addition to special operations. It also has convenient shortcuts for mathmatical constants such as Pi.
diff --git a/Base/usr/share/man/man1/Calendar.md b/Base/usr/share/man/man1/Calendar.md
new file mode 100644
index 0000000000..4180a36ccb
--- /dev/null
+++ b/Base/usr/share/man/man1/Calendar.md
@@ -0,0 +1,15 @@
+## Name
+
+![Icon](/res/icons/16x16/app-calendar.png) Calendar - Serenity calendar
+
+[Open](file:///bin/Calendar)
+
+## Synopsis
+
+```**sh
+$ Calendar
+```
+
+## Description
+
+`Calendar` is a graphical calendar application for Serenity. It supports both Month View and Year View.