aboutsummaryrefslogtreecommitdiff
path: root/doc/Usage/Configuration.asciidoc
diff options
context:
space:
mode:
authorAqua-sama <aqua@iserlohn-fortress.net>2018-10-03 16:48:26 +0200
committerAqua-sama <aqua@iserlohn-fortress.net>2018-10-03 16:48:26 +0200
commitae2a713f26fd58f397aaf93242f24c85dee98a2b (patch)
treedb69c96f6419e011cfc1c6e6081613d7a0f0d7cc /doc/Usage/Configuration.asciidoc
parentSubwindow: only keep tab history for restore tab action (diff)
downloadsmolbote-ae2a713f26fd58f397aaf93242f24c85dee98a2b.tar.xz
Convert documentation into asciidoc from markdown
Diffstat (limited to 'doc/Usage/Configuration.asciidoc')
-rw-r--r--doc/Usage/Configuration.asciidoc56
1 files changed, 56 insertions, 0 deletions
diff --git a/doc/Usage/Configuration.asciidoc b/doc/Usage/Configuration.asciidoc
new file mode 100644
index 0000000..44e6b92
--- /dev/null
+++ b/doc/Usage/Configuration.asciidoc
@@ -0,0 +1,56 @@
+== 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'.
+
+You can overwrite options at runtime using the option path as a command line
+parameter.
+
+- 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)
+