From c7532cf084dc459f13d7606ecbb383e091b185ef Mon Sep 17 00:00:00 2001 From: Cubic Love <7754483+cubiclove@users.noreply.github.com> Date: Sun, 21 May 2023 01:02:25 +0100 Subject: [PATCH] Base: Add 3DFileViewer, CatDog & CertificateSettings manpages Also update Applications.md to reflect this and some other previously missing pages. --- Base/usr/share/man/man1/Applications.md | 9 ++++- .../man/man1/Applications/3DFileViewer.md | 31 +++++++++++++++ .../usr/share/man/man1/Applications/CatDog.md | 38 +++++++++++++++++++ .../man1/Applications/CertificateSettings.md | 22 +++++++++++ 4 files changed, 98 insertions(+), 2 deletions(-) create mode 100644 Base/usr/share/man/man1/Applications/3DFileViewer.md create mode 100644 Base/usr/share/man/man1/Applications/CatDog.md create mode 100644 Base/usr/share/man/man1/Applications/CertificateSettings.md diff --git a/Base/usr/share/man/man1/Applications.md b/Base/usr/share/man/man1/Applications.md index 8eb5b067d21..72a495583c0 100644 --- a/Base/usr/share/man/man1/Applications.md +++ b/Base/usr/share/man/man1/Applications.md @@ -4,9 +4,9 @@ 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. +SerenityOS comes with a suite of GUI applications. The applications are divided into multiple categories, through which they are available in the System 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. +Note that many applications can be disabled at SerenityOS build time if desired. Therefore, depending on your SerenityOS build configuration, not all applications will be available. ## See also @@ -14,22 +14,27 @@ Note that many applications can be disabled at SerenityOS build time if desired. ### List of Application manpages +- [3D File Viewer](help://man/1/Applications/3DFileViewer) - [About](help://man/1/Applications/About) - [Analog Clock](help://man/1/Applications/AnalogClock) - [Assistant](help://man/1/Applications/Assistant) - [Browser](help://man/1/Applications/Browser) - [Calculator](help://man/1/Applications/Calculator) - [Calendar](help://man/1/Applications/Calendar) +- [CatDog](help://man/1/Applications/CatDog) +- [Certificate Settings](help://man/1/Applications/CertificateSettings) - [Character Map](help://man/1/Applications/CharacterMap) - [Eyes](help://man/1/Applications/Eyes) - [FontEditor](help://man/1/Applications/FontEditor) - [GML Playground](help://man/1/Applications/GMLPlayground) +- [Help](help://man/1/Applications/Help) - [Hex Editor](help://man/1/Applications/HexEditor) - [Image Viewer](help://man/1/Applications/ImageViewer) - [Magnifier](help://man/1/Applications/Magnifier) - [Mail](help://man/1/Applications/Mail) - [Mouse Settings](help://man/1/Applications/MouseSettings) - [Presenter](help://man/1/Applications/Presenter) +- [Profiler](help://man/1/Applications/Profiler) - [SQL Studio](help://man/1/Applications/SQLStudio) - [Terminal](help://man/1/Applications/Terminal) - [Text Editor](help://man/1/Applications/TextEditor) diff --git a/Base/usr/share/man/man1/Applications/3DFileViewer.md b/Base/usr/share/man/man1/Applications/3DFileViewer.md new file mode 100644 index 00000000000..5bf47db5fa8 --- /dev/null +++ b/Base/usr/share/man/man1/Applications/3DFileViewer.md @@ -0,0 +1,31 @@ +## Name + +![Icon](/res/icons/16x16/app-3d-file-viewer.png) 3D File Viewer + +[Open](file:///bin/3DFileViewer) + +## Synopsis + +```**sh +$ 3DFileViewer +``` + +## Description + +`3D File Viewer` is an application for viewing 3D models. + +It currently supports opening the Wavefront OBJ file format (`.obj`). + +### Features + +By default 3D File Viewer will open with a rotating [Utah teapot](https://en.wikipedia.org/wiki/Utah_teapot), a standard 3D test model. + +Rotate the model by grabbing it with the cursor. Zoom-in and out with the mouse wheel. + +The rotation axis and speed can be adjusted or turned off in the `View` menu. + +The model's texture can be adjusted or turned off in the `Texture` menu. + +View in Fullscreen by pressing `F11`. + +Drag and drop files into 3D File Viewer to open them. \ No newline at end of file diff --git a/Base/usr/share/man/man1/Applications/CatDog.md b/Base/usr/share/man/man1/Applications/CatDog.md new file mode 100644 index 00000000000..8176ebdfc89 --- /dev/null +++ b/Base/usr/share/man/man1/Applications/CatDog.md @@ -0,0 +1,38 @@ +## Name + +![Icon](/res/icons/16x16/app-catdog.png) CatDog - A helpful companion + +[Open](file:///bin/CatDog) + +## Synopsis + +```**sh +$ CatDog +``` + +## Description + +`CatDog` is an animated screenmate application in the form of a virtual pet. + +It was inspired by [Neko](https://en.wikipedia.org/wiki/Neko_(software)). The name derives from its ambiguous appearance: is it a cat, a dog, or a hybrid? + +Its helpful suggestions evoke the animated assistants popular at the turn of the millennium, such as [Clippy](https://en.wikipedia.org/wiki/Office_Assistant). + +Alongside [Buggie](https://en.wikipedia.org/wiki/SerenityOS#History) and the [Yaks](http://yaksplained.org/), CatDog is a much loved member of the SerenityOS family of mascots. As such it has a wider presence in the project’s online community, promotional materials and merchandise. + +### Features + +By default, CatDog will chase your mouse cursor around the screen. It will always stay on-top of other windows. + +Additionally, CatDog offers helpful suggestions depending on the currently active application. + +CatDog has multiple states: + +- *Sleeping* if the mouse cursor hasn’t moved in some time +- *Alert* if woken by the mouse cursor or speaking after being idle +- *Dressed as an Artist* if Pixel Paint or [Font Editor](help://man/1/Applications/FontEditor) are open +- *Dressed as an Inspector* if [Profiler](help://man/1/Applications/Profiler) or System Monitor are open + +To exit, right-click on CatDog and select `Quit` or, if active, press `Alt+F4`. + +CatDog brings good luck to those who keep it open. diff --git a/Base/usr/share/man/man1/Applications/CertificateSettings.md b/Base/usr/share/man/man1/Applications/CertificateSettings.md new file mode 100644 index 00000000000..38be3ab8c03 --- /dev/null +++ b/Base/usr/share/man/man1/Applications/CertificateSettings.md @@ -0,0 +1,22 @@ +## Name + +![Icon](/res/icons/16x16/certificate.png) Certificate Settings + +[Open](file:///bin/CertificateSettings) + +## Synopsis + +```**sh +$ CertificateSettings +``` + +## Description +`Certificate Settings` is an application for managing digital certificates in SerenityOS. + +Certificates are used for establishing a user's credentials when trying to create secure connection between a client and server by matching a public and private key. + +The *Certificate Store* lists all of the certificates currently stored in the system, the Trusted Root Certification Authorities (CAs) they were issued by and their expiration dates. + +### Features + +Import and export CAs as Privacy-Enhanced Mail files (`.pem`). \ No newline at end of file