aboutsummaryrefslogtreecommitdiff
path: root/doc/Usage/Configuration.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/Usage/Configuration.asciidoc')
-rw-r--r--doc/Usage/Configuration.asciidoc66
1 files changed, 12 insertions, 54 deletions
diff --git a/doc/Usage/Configuration.asciidoc b/doc/Usage/Configuration.asciidoc
index 44e6b92..b1dbec5 100644
--- a/doc/Usage/Configuration.asciidoc
+++ b/doc/Usage/Configuration.asciidoc
@@ -1,56 +1,14 @@
== 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)
-
+The Configuration is loaded from the path specified by `--config`, by default
+_~/.config/smolbote/smolbote.cfg_.
+
+You can set the value of configuration options using its name in a key=value
+pair, for example:
+[source, ini]
+----
+mainwindow.height=600
+----
+For a full list of options, check `--help`.
+
+You can overwrite options at runtime using the option name as a parameter.