aboutsummaryrefslogtreecommitdiff
path: root/doc/Usage
diff options
context:
space:
mode:
Diffstat (limited to 'doc/Usage')
-rw-r--r--doc/Usage/CommandLine.asciidoc (renamed from doc/Usage/CommandLine.md)8
-rw-r--r--doc/Usage/Configuration.asciidoc (renamed from doc/Usage/Configuration.md)29
-rw-r--r--doc/Usage/Profile.asciidoc31
-rw-r--r--doc/Usage/Profile.md17
-rw-r--r--doc/Usage/Session.md30
5 files changed, 49 insertions, 66 deletions
diff --git a/doc/Usage/CommandLine.md b/doc/Usage/CommandLine.asciidoc
index 1c532ce..a21b7c2 100644
--- a/doc/Usage/CommandLine.md
+++ b/doc/Usage/CommandLine.asciidoc
@@ -1,12 +1,8 @@
-## Command-line options
+== Command-line Options
-### General
+=== General
* `-h`, `--help`: Display this help.
* `-v`, `--version`: Display version information.
* `--build`: Display build branch and commit.
* `-c`, `--config`: Set configuration file.
* `--no-remote`: Don't check for other instances when starting.
-
-### Tweaking configuration
-You can overwrite options at runtime using the option path as a command line
-parameter.
diff --git a/doc/Usage/Configuration.md b/doc/Usage/Configuration.asciidoc
index 3bf55b9..44e6b92 100644
--- a/doc/Usage/Configuration.md
+++ b/doc/Usage/Configuration.asciidoc
@@ -1,35 +1,38 @@
-## Configuration
+== Configuration
-The Configuration is loaded from _~/.config/smolbote/smolbote.cfg_. Most
+The Configuration is loaded from .config/smolbote/smolbote.cfg. Most
settings are only loaded on launch.
-For a full list of settings, check `--help`.
+For a full list of settings, check '--help'.
-### Browser (group: browser)
+You can overwrite options at runtime using the option path as a command line
+parameter.
-### Main Window (group: mainwindow)
+- Browser (group: browser)
+
+- Main Window (group: mainwindow)
A main window contains one or more subwindows.
-### Subwindow (group: window)
+- Subwindow (group: window)
A subwindow contains multiple tabs and functions similarly to a tab group.
-### Navigation bar (group: navigation)
+- 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)
+- Address bar (group: addressbar)
-### Filter (group: filter)
+- Filter (group: filter)
-### Plugins (group: 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.
-### Profiles (group: profile)
+- 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.
@@ -47,7 +50,7 @@ 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)
+- Bookmarks (group: bookmarks)
-### Downloads (group: downloads)
+- Downloads (group: downloads)
diff --git a/doc/Usage/Profile.asciidoc b/doc/Usage/Profile.asciidoc
new file mode 100644
index 0000000..9b00dbc
--- /dev/null
+++ b/doc/Usage/Profile.asciidoc
@@ -0,0 +1,31 @@
+== 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
+changed from the window's menu. Additionally, tabs can have their profiles
+individually changed from their context 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.
+
+Profiles are read from profile.path
+
+Settings
+
+- otr (defaults to true) - is this profile off-the-record
+- name (defaults to the configuration file name)
+- search (defaults to profile.search) - search engine url
+- homepage (defaults to profile.homepage)
+- newtab (defaults to profile.newtab)
+
+Properties
+Key is property name; value is property value
+
+Attributes
+see QWebEngineSetting::WebAttribute for list of IDs.
+Key is attribute id; value is attribute value (true/false)
+
diff --git a/doc/Usage/Profile.md b/doc/Usage/Profile.md
deleted file mode 100644
index d205a86..0000000
--- a/doc/Usage/Profile.md
+++ /dev/null
@@ -1,17 +0,0 @@
-Profiles are read from profile.path
-
-## Settings
-
-- otr (defaults to true) - is this profile off-the-record
-- name (defaults to the configuration file name)
-- search (defaults to profile.search) - search engine url
-- homepage (defaults to profile.homepage)
-- newtab (defaults to profile.newtab)
-
-### Properties
-Key is property name; value is property value
-
-### Attributes
-see QWebEngineSetting::WebAttribute for list of IDs.
-Key is attribute id; value is attribute value (true/false)
-
diff --git a/doc/Usage/Session.md b/doc/Usage/Session.md
deleted file mode 100644
index 3018253..0000000
--- a/doc/Usage/Session.md
+++ /dev/null
@@ -1,30 +0,0 @@
-## Session format
-A session is a single window, which contains a list of subwindows.
-
-Each subwindow has a profile (profile id), and a list of tabs.
-
-Each tab has a profile (profile id) and url.
-
-~~~json
-{
- "subwindows": [
- {
- "profile": "<profile id>",
- "tabs": [
- {
- "profile": "<profile id>",
- "url": "<url>"
- },
- {
- ...
- }
- ]
- }
- ]
-}
-
-~~~
-
-## --session
-This command-line option causes the browser to load the specified json file.
-