diff options
Diffstat (limited to 'linux/man/smolbote.7.ronn')
| -rw-r--r-- | linux/man/smolbote.7.ronn | 61 |
1 files changed, 38 insertions, 23 deletions
diff --git a/linux/man/smolbote.7.ronn b/linux/man/smolbote.7.ronn index ba60db6..40f6d5b 100644 --- a/linux/man/smolbote.7.ronn +++ b/linux/man/smolbote.7.ronn @@ -3,67 +3,76 @@ smolbote(7) -- yet another no-frills browser ## SYNOPSIS -`poi` [<options>...] URL +`poi` [<options>...] URL(s) ## DESCRIPTION smolbote is a keep-it-simple free software web browser. -## OPTIONS +## COMMAND-LINE OPTIONS ### General -* `-h`, `--help`: Displays this help. -* `-v`, `--version`: Displays version information. -* `--build`: Displays build information. +* `-h`, `--help`: Display this help. +* `-v`, `--version`: Display version information. +* `--build`: Display build branch and commit. ### Configuration * `-c`, `--config`: Set configuration file. * `--socket`: Local server socket -### Open URL -* `-p`, `--profile`: Use this profile. -* `--in-new-window`: Open URL in new window. +### Plugins +* `--command`: Run a plugin command. +* `--commands`: List all plugin commands. ## CONFIGURATION The Configuration is loaded from _~/.config/smolbote/smolbote.cfg_, and can be edited with the `poi-config` tool. -Settings are only loaded on launch, so re-run the browser to apply changes. +Settings are only loaded on launch; re-run the browser to apply changes. + +### Browser +* browser.stylesheet: path ### Main Window +A main window contains one or more subwindows. + * mainwindow.height: 720 * mainwindow.width: 1280 * mainwindow.maximized: true * mainwindow.title: smolbote - * mainwindow.shortcuts.newGroup: Ctrl+G -* mainwindow.shortcuts.newWindow: Ctrl+N (todo) - +* mainwindow.shortcuts.newWindow: Ctrl+N * mainwindow.shortcuts.about: F1 * mainwindow.shortcuts.quit: Ctrl+Q - * mainwindow.shortcuts.search: F3 * mainwindow.shortcuts.tileWindows: F9 +* mainwindow.shortcuts.cascadeWindows: F10 + +### Subwindow +A subwindow contains multiple tabs and functions similarly to a tab group. + +* window.shortcuts.new: Ctrl+T +* window.shortcuts.close: Ctrl+X +* window.shortcuts.left: Ctrl+O +* window.shortcuts.right: Ctrl+P +* window.shortcuts.fullscreen: F11 ### Navigation bar +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. + * navigation.movable: false * navigation.shortcuts.back: Ctrl+Left * navigation.shortcuts.forward: Ctrl+Right * navigation.shortcuts.refresh: F5 +* navigation.shortcuts.reload: Ctrl+F5 * navigation.shortcuts.home: Ctrl+Home ### Address bar * addressbar.shortcuts.focus: F4 -* addressbar.shortcuts.pageMenu: F2 -* addressbar.shortcuts.toolsMenu: F10 - -### Window -* window.shortcuts.new: Ctrl+T -* window.shortcuts.close: Ctrl+X -* window.shortcuts.left: Ctrl+O -* window.shortcuts.right: Ctrl+P -* window.shortcuts.fullscreen: F11 (todo) +* addressbar.shortcuts.menu: F2 ### Filter * filter.path: ~/.config/smolbote/hosts.d @@ -71,7 +80,13 @@ Settings are only loaded on launch, so re-run the browser to apply changes. * filter.cookies.block.thirdParty: true * filter.cookies.path: ~/.config/smolbote/cookies.d -### Plugins (to-redo) +### Plugins +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. + +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. + * plugins.path: ~/.config/smolbote/plugins.d ### Profiles |