aboutsummaryrefslogtreecommitdiff
path: root/linux/man/smolbote.md
blob: 320b9c68f84fcc4cf3833e9684e4a47cac527d6e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
smolbote(7)
===

## NAME
smolbote - yet another no-frills web browser

## SYNOPSIS
`poi` [<options>...] URL(s)

## DESCRIPTION
todo

## COMMAND-LINE OPTIONS

### General
* `-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.

## 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; 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
* 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.menu: F2

### 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 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
A Profile is a collection of settings, policies, scripts, cookies, cache and
history. Profiles can be used to isolate pages from each other.

Each window has a default profile it uses when opening new tabs. This can be
set by the profile.default option, and can be changed from the window's menu.
Additionally, tabs can have their profiles individually changed from their page
menu.

Because profiles store all their data separately, you can log in into the same
site with a different account from each profile. However, links opened into new
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
* bookmarks.path: ~/.config/smolbote/bookmarks.xbel
* bookmarks.shortcut: Ctrl+B

### Downloads
* downloads.path: ~/Downloads
* downloads.shortcut: Ctrl+D