aboutsummaryrefslogtreecommitdiff
path: root/linux/man
diff options
context:
space:
mode:
authorAqua-sama <aqua@iserlohn-fortress.net>2018-08-05 13:15:11 +0200
committerAqua-sama <aqua@iserlohn-fortress.net>2018-08-05 13:15:11 +0200
commitbea71079849984e60ab86f4eb30a7613cb291960 (patch)
tree4948de93cf0ae899bc2d9a6f6bd1e21a47e9e667 /linux/man
parentWebView: add open image action to context menu (diff)
downloadsmolbote-bea71079849984e60ab86f4eb30a7613cb291960.tar.xz
Update manpage
Diffstat (limited to 'linux/man')
-rw-r--r--linux/man/smolbote.md80
1 files changed, 16 insertions, 64 deletions
diff --git a/linux/man/smolbote.md b/linux/man/smolbote.md
index 320b9c6..060b0da 100644
--- a/linux/man/smolbote.md
+++ b/linux/man/smolbote.md
@@ -8,7 +8,8 @@ smolbote - yet another no-frills web browser
`poi` [<options>...] URL(s)
## DESCRIPTION
-todo
+smolbote is a cross-platform keep-it-simple free software web browser based on
+Qt and QtWebEngine.
## COMMAND-LINE OPTIONS
@@ -16,81 +17,41 @@ todo
* `-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
-
-### Plugins
-* `--command`: Run a plugin command.
-* `--commands`: List all plugin commands.
+* `--no-remote`: Don't check for other instances when starting.
## CONFIGURATION
-The Configuration is loaded from _~/.config/smolbote/smolbote.cfg_, and can be
-edited with the `poi-config` tool.
+The Configuration is loaded from _~/.config/smolbote/smolbote.cfg_. Most
+settings are only loaded on launch.
-Settings are only loaded on launch; re-run the browser to apply changes.
+For a full list of settings, check `--help`.
-### Browser
-* browser.stylesheet: path
+### Browser (group: browser)
-### Main Window
+### Main Window (group: mainwindow)
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
-* mainwindow.shortcuts.about: F1
-* mainwindow.shortcuts.quit: Ctrl+Q
-* mainwindow.shortcuts.search: F3
-* mainwindow.shortcuts.tileWindows: F9
-* mainwindow.shortcuts.cascadeWindows: F10
-
-### Subwindow
+### Subwindow (group: window)
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
+### Navigation bar (group: navigation)
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 (group: addressbar)
-### Address bar
-* addressbar.shortcuts.focus: F4
-* addressbar.shortcuts.menu: F2
+### Filter (group: filter)
-### Filter
-* filter.path: ~/.config/smolbote/hosts.d
-* filter.cookies.block.all: false (todo: in qt5.11)
-* filter.cookies.block.thirdParty: true
-* filter.cookies.path: ~/.config/smolbote/cookies.d
-
-### Plugins
+### Plugins (group: 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,
or set its absolute path as the plugins.path.
-* plugins.path: ~/.config/smolbote/plugins.d
-
-### Profiles
+### Profiles (group: profile)
A Profile is a collection of settings, policies, scripts, cookies, cache and
history. Profiles can be used to isolate pages from each other.
@@ -105,16 +66,7 @@ tabs will still use the subwindow's default profile. For example, you can set a
profile to hold login information for a site, but all new tabs opened from that
site would still be using the default off-the-record profile.
-* profile.default: ''
-* profile.path: ~/.config/smolbote/profiles.d
-* profile.search: https://duckduckgo.com/?q=%1&ia=web
-* profile.homepage: about:blank
-* profile.newtab: about:blank
+### Bookmarks (group: bookmarks)
-### Bookmarks
-* bookmarks.path: ~/.config/smolbote/bookmarks.xbel
-* bookmarks.shortcut: Ctrl+B
+### Downloads (group: downloads)
-### Downloads
-* downloads.path: ~/Downloads
-* downloads.shortcut: Ctrl+D