From 2c20acb1981fc8fbd884dbece2a1115ca37732d2 Mon Sep 17 00:00:00 2001 From: Aqua-sama Date: Wed, 19 Sep 2018 23:35:43 +0200 Subject: Update documentation --- doc/Usage/Configuration.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 doc/Usage/Configuration.md (limited to 'doc/Usage/Configuration.md') diff --git a/doc/Usage/Configuration.md b/doc/Usage/Configuration.md new file mode 100644 index 0000000..3bf55b9 --- /dev/null +++ b/doc/Usage/Configuration.md @@ -0,0 +1,53 @@ +## Configuration + +The Configuration is loaded from _~/.config/smolbote/smolbote.cfg_. Most +settings are only loaded on launch. + +For a full list of settings, check `--help`. + +### Browser (group: browser) + +### Main Window (group: mainwindow) +A main window contains one or more subwindows. + +### Subwindow (group: window) +A subwindow contains multiple tabs and functions similarly to a tab group. + +### 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. + +### Address bar (group: addressbar) + +### Filter (group: filter) + +### 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. + +### 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. + +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 definitions are stored in the profiles.path location. To create a new +profile, create a profile-id.profile file in that location. + +### Bookmarks (group: bookmarks) + +### Downloads (group: downloads) + -- cgit v1.2.1