summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrendan Coles <bcoles@gmail.com>2021-03-12 14:34:36 +0000
committerAndreas Kling <kling@serenityos.org>2021-03-13 10:00:59 +0100
commitf21af0922aee3c5fe028f84846beed973b07926f (patch)
treeb2e8545c9eeab25433936144ed8c73b4a477f7fa
parent7f60090c433ae902e6766c786d365fb56b2ab121 (diff)
downloadserenity-f21af0922aee3c5fe028f84846beed973b07926f.zip
QuickShow: Add help documentation
-rw-r--r--Base/usr/share/man/man1/QuickShow.md23
-rw-r--r--Userland/Applications/QuickShow/main.cpp9
2 files changed, 32 insertions, 0 deletions
diff --git a/Base/usr/share/man/man1/QuickShow.md b/Base/usr/share/man/man1/QuickShow.md
new file mode 100644
index 0000000000..ae1b0b4959
--- /dev/null
+++ b/Base/usr/share/man/man1/QuickShow.md
@@ -0,0 +1,23 @@
+## Name
+
+QuickShow - Serenity image viewer
+
+## Synopsis
+
+```**sh
+$ QuickShow [file]
+```
+
+## Description
+
+QuickShow is an image viewing application for Serenity.
+
+## Arguments
+
+* `file`: The image file to be displayed.
+
+## Examples
+
+```sh
+$ QuickShow /res/graphics/buggie.png
+```
diff --git a/Userland/Applications/QuickShow/main.cpp b/Userland/Applications/QuickShow/main.cpp
index 1130729c41..331bffa714 100644
--- a/Userland/Applications/QuickShow/main.cpp
+++ b/Userland/Applications/QuickShow/main.cpp
@@ -68,6 +68,12 @@ int main(int argc, char** argv)
return 1;
}
+ if (!Desktop::Launcher::add_allowed_handler_with_only_specific_urls(
+ "/bin/Help", { URL::create_with_file_protocol("/usr/share/man/man1/QuickShow.md") })) {
+ warnln("Failed to set up allowed launch URLs");
+ return 1;
+ }
+
if (!Desktop::Launcher::seal_allowlist()) {
warnln("Failed to seal allowed launch URLs");
return 1;
@@ -299,6 +305,9 @@ int main(int argc, char** argv)
view_menu.add_action(hide_show_toolbar_action);
auto& help_menu = menubar->add_menu("Help");
+ help_menu.add_action(GUI::CommonActions::make_help_action([](auto&) {
+ Desktop::Launcher::open(URL::create_with_file_protocol("/usr/share/man/man1/QuickShow.md"), "/bin/Help");
+ }));
help_menu.add_action(GUI::CommonActions::make_about_action("QuickShow", app_icon, window));
app->set_menubar(move(menubar));