浏览代码

QuickShow: Add help documentation

Brendan Coles 4 年之前
父节点
当前提交
f21af0922a
共有 2 个文件被更改,包括 32 次插入0 次删除
  1. 23 0
      Base/usr/share/man/man1/QuickShow.md
  2. 9 0
      Userland/Applications/QuickShow/main.cpp

+ 23 - 0
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
+```

+ 9 - 0
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));