Explorar el Código

Documentation+SQLStudio: Add manual page for SQL Studio

Dylan Katz hace 3 años
padre
commit
a79896bb44

+ 28 - 0
Base/usr/share/man/man1/SQLStudio.md

@@ -0,0 +1,28 @@
+## Name
+
+![Icon](/res/icons/16x16/app-sql-studio.png) SQL Studio - SerenityOS SQL Manager
+
+[Open](file:///bin/SQLStudio)
+
+## Synopsis
+
+```**sh
+$ SQLStudio [script.sql | database.db]
+```
+
+## Description
+
+SQL Studio is a graphical SQL manager program that allows the user to create and edit
+SQL scripts.
+
+## Arguments
+
+* `script.sql`: SQL script to open, edit or run
+* `database.db`: SQL database to open and run scripts against
+
+## Examples
+
+```sh
+$ SQLStudio
+$ SQLStudio /home/anon/Documents/sql/insert_values.sql
+```

+ 3 - 0
Userland/DevTools/SQLStudio/MainWidget.cpp

@@ -205,6 +205,9 @@ void MainWidget::initialize_menu(GUI::Window* window)
     edit_menu.add_action(*m_redo_action);
 
     auto& help_menu = window->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/SQLStudio.md"), "/bin/Help");
+    }));
     help_menu.add_action(GUI::CommonActions::make_about_action("SQL Studio", GUI::Icon::default_icon("app-sql-studio"), window));
 }