diff options
author | Aqua-sama <aqua@iserlohn-fortress.net> | 2018-05-18 13:52:10 +0200 |
---|---|---|
committer | Aqua-sama <aqua@iserlohn-fortress.net> | 2018-05-18 13:52:10 +0200 |
commit | 13c36c432bcad740950d905629d0285c1037ed36 (patch) | |
tree | bc07704d20f960a4919d7ef9db42cba121368737 /linux/man/smolbote.7.html | |
parent | Plugin command-line parameters (diff) | |
download | smolbote-13c36c432bcad740950d905629d0285c1037ed36.tar.xz |
Update manpage
Diffstat (limited to 'linux/man/smolbote.7.html')
-rw-r--r-- | linux/man/smolbote.7.html | 84 |
1 files changed, 53 insertions, 31 deletions
diff --git a/linux/man/smolbote.7.html b/linux/man/smolbote.7.html index a7c99f8..c74783f 100644 --- a/linux/man/smolbote.7.html +++ b/linux/man/smolbote.7.html @@ -56,7 +56,7 @@ <a href="#NAME">NAME</a> <a href="#SYNOPSIS">SYNOPSIS</a> <a href="#DESCRIPTION">DESCRIPTION</a> - <a href="#OPTIONS">OPTIONS</a> + <a href="#COMMAND-LINE-OPTIONS">COMMAND-LINE OPTIONS</a> <a href="#CONFIGURATION">CONFIGURATION</a> </div> @@ -73,20 +73,20 @@ <h2 id="SYNOPSIS">SYNOPSIS</h2> -<p><code>poi</code> [<var>options</var>...] URL</p> +<p><code>poi</code> [<var>options</var>...] URL(s)</p> <h2 id="DESCRIPTION">DESCRIPTION</h2> <p>smolbote is a keep-it-simple free software web browser.</p> -<h2 id="OPTIONS">OPTIONS</h2> +<h2 id="COMMAND-LINE-OPTIONS">COMMAND-LINE OPTIONS</h2> <h3 id="General">General</h3> <ul> -<li><code>-h</code>, <code>--help</code>: Displays this help.</li> -<li><code>-v</code>, <code>--version</code>: Displays version information.</li> -<li><code>--build</code>: Displays build information.</li> +<li><code>-h</code>, <code>--help</code>: Display this help.</li> +<li><code>-v</code>, <code>--version</code>: Display version information.</li> +<li><code>--build</code>: Display build branch and commit.</li> </ul> @@ -98,11 +98,11 @@ </ul> -<h3 id="Open-URL">Open URL</h3> +<h3 id="Plugins">Plugins</h3> <ul> -<li><code>-p</code>, <code>--profile</code>: Use this profile.</li> -<li><code>--in-new-window</code>: Open URL in new window.</li> +<li><code>--command</code>: Run a plugin command.</li> +<li><code>--commands</code>: List all plugin commands.</li> </ul> @@ -111,31 +111,59 @@ <p>The Configuration is loaded from <em>~/.config/smolbote/smolbote.cfg</em>, and can be edited with the <code>poi-config</code> tool.</p> -<p>Settings are only loaded on launch, so re-run the browser to apply changes.</p> +<p>Settings are only loaded on launch; re-run the browser to apply changes.</p> + +<h3 id="Browser">Browser</h3> + +<ul> +<li>browser.stylesheet: path</li> +</ul> + <h3 id="Main-Window">Main Window</h3> +<p>A main window contains one or more subwindows.</p> + <ul> <li>mainwindow.height: 720</li> <li>mainwindow.width: 1280</li> <li>mainwindow.maximized: true</li> -<li><p>mainwindow.title: smolbote</p></li> -<li><p>mainwindow.shortcuts.newGroup: Ctrl+G</p></li> -<li><p>mainwindow.shortcuts.newWindow: Ctrl+N (todo)</p></li> -<li><p>mainwindow.shortcuts.about: F1</p></li> -<li><p>mainwindow.shortcuts.quit: Ctrl+Q</p></li> -<li><p>mainwindow.shortcuts.search: F3</p></li> +<li>mainwindow.title: smolbote</li> +<li>mainwindow.shortcuts.newGroup: Ctrl+G</li> +<li>mainwindow.shortcuts.newWindow: Ctrl+N</li> +<li>mainwindow.shortcuts.about: F1</li> +<li>mainwindow.shortcuts.quit: Ctrl+Q</li> +<li>mainwindow.shortcuts.search: F3</li> <li>mainwindow.shortcuts.tileWindows: F9</li> +<li>mainwindow.shortcuts.cascadeWindows: F10</li> +</ul> + + +<h3 id="Subwindow">Subwindow</h3> + +<p>A subwindow contains multiple tabs and functions similarly to a tab group.</p> + +<ul> +<li>window.shortcuts.new: Ctrl+T</li> +<li>window.shortcuts.close: Ctrl+X</li> +<li>window.shortcuts.left: Ctrl+O</li> +<li>window.shortcuts.right: Ctrl+P</li> +<li>window.shortcuts.fullscreen: F11</li> </ul> <h3 id="Navigation-bar">Navigation bar</h3> +<p>The navigation bar is the toolbar that holds the history, reload and home +buttons, as well as the address bar. It can be made movable through the +navigation.movable option.</p> + <ul> <li>navigation.movable: false</li> <li>navigation.shortcuts.back: Ctrl+Left</li> <li>navigation.shortcuts.forward: Ctrl+Right</li> <li>navigation.shortcuts.refresh: F5</li> +<li>navigation.shortcuts.reload: Ctrl+F5</li> <li>navigation.shortcuts.home: Ctrl+Home</li> </ul> @@ -144,19 +172,7 @@ edited with the <code>poi-config</code> tool.</p> <ul> <li>addressbar.shortcuts.focus: F4</li> -<li>addressbar.shortcuts.pageMenu: F2</li> -<li>addressbar.shortcuts.toolsMenu: F10</li> -</ul> - - -<h3 id="Window">Window</h3> - -<ul> -<li>window.shortcuts.new: Ctrl+T</li> -<li>window.shortcuts.close: Ctrl+X</li> -<li>window.shortcuts.left: Ctrl+O</li> -<li>window.shortcuts.right: Ctrl+P</li> -<li>window.shortcuts.fullscreen: F11 (todo)</li> +<li>addressbar.shortcuts.menu: F2</li> </ul> @@ -170,7 +186,13 @@ edited with the <code>poi-config</code> tool.</p> </ul> -<h3 id="Plugins-to-redo-">Plugins (to-redo)</h3> +<h3 id="Plugins">Plugins</h3> + +<p>Plugins a way of extending smolbote's functionality using the Qt plugin system. +They are not to be confused with NPAPI/PPAPI or WebExtension plugins.</p> + +<p>To enable a plugin either copy it or symlink it in the plugins.path location. A +set of default plugins is installed in /usr/lib/smolbote.</p> <ul> <li>plugins.path: ~/.config/smolbote/plugins.d</li> @@ -207,7 +229,7 @@ edited with the <code>poi-config</code> tool.</p> <ol class='man-decor man-foot man foot'> <li class='tl'></li> - <li class='tc'>April 2018</li> + <li class='tc'>May 2018</li> <li class='tr'>smolbote(7)</li> </ol> |