diff options
author | Aqua-sama <aqua@iserlohn-fortress.net> | 2020-01-12 17:05:25 +0200 |
---|---|---|
committer | Aqua-sama <aqua@iserlohn-fortress.net> | 2020-01-12 17:05:25 +0200 |
commit | d8cc3eeeb55b92b0d7fe9a325937df11c28fbcaa (patch) | |
tree | b21f65bb973745eef52aacb24e5295c4451f2ef0 /doc/Usage | |
parent | Refactor WebViewContextMenu (diff) | |
download | smolbote-d8cc3eeeb55b92b0d7fe9a325937df11c28fbcaa.tar.xz |
Update doc/ and move various entries to wiki
Diffstat (limited to 'doc/Usage')
-rw-r--r-- | doc/Usage/CommandLine.asciidoc | 14 | ||||
-rw-r--r-- | doc/Usage/Configuration.asciidoc | 14 | ||||
-rw-r--r-- | doc/Usage/Filter.asciidoc | 12 | ||||
-rw-r--r-- | doc/Usage/Linux.asciidoc | 15 | ||||
-rw-r--r-- | doc/Usage/Plugins.asciidoc | 7 | ||||
-rw-r--r-- | doc/Usage/Profile.asciidoc | 37 |
6 files changed, 0 insertions, 99 deletions
diff --git a/doc/Usage/CommandLine.asciidoc b/doc/Usage/CommandLine.asciidoc deleted file mode 100644 index 00a8d6c..0000000 --- a/doc/Usage/CommandLine.asciidoc +++ /dev/null @@ -1,14 +0,0 @@ -== Command-line Options - -=== General -* `-h`, `--help`: Display command-line options list.. -* `-v`, `--version`: Display version information. -* `--build`: Display build commit. - -=== Configuration -* `-c`, `--config`: Set configuration file. -* `--no-remote`: Don't check for other instances when starting. - -=== Sessions -* `-s, --session`: Open the selected session. -* `--pick-session`: Open all available sessions and select which one to open. diff --git a/doc/Usage/Configuration.asciidoc b/doc/Usage/Configuration.asciidoc deleted file mode 100644 index b1dbec5..0000000 --- a/doc/Usage/Configuration.asciidoc +++ /dev/null @@ -1,14 +0,0 @@ -== Configuration - -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. diff --git a/doc/Usage/Filter.asciidoc b/doc/Usage/Filter.asciidoc deleted file mode 100644 index d23d57a..0000000 --- a/doc/Usage/Filter.asciidoc +++ /dev/null @@ -1,12 +0,0 @@ -== Url Request Filter -smolbote has a singular URL request filter that is installed onto all profiles. -Any setting applied to it will be applied to all profiles. - -=== filter.header - A list of header-value pairs, separated by a colon (':'). - -You can specify multiple headers by using --filter.header multiple times: -[source, sh] ----- -poi --filter.header "Dnt:1" --filter.header "Accept:text/html" ----- diff --git a/doc/Usage/Linux.asciidoc b/doc/Usage/Linux.asciidoc deleted file mode 100644 index 748ea10..0000000 --- a/doc/Usage/Linux.asciidoc +++ /dev/null @@ -1,15 +0,0 @@ -== Linux - -=== firejail -To launch poi by default with firejail, symlink /usr/bin/firejail to the poi -executable: - -[source, sh] ----- -# poi is installed to /usr/local/bin/poi, and local/sbin is before local/bin. -ln -s /usr/bin/firejail /usr/local/sbin/poi ----- - -To add the poi.profile to firejail, copy or symlink it to '/etc/firejail' or -'~/.config/firejail'. - diff --git a/doc/Usage/Plugins.asciidoc b/doc/Usage/Plugins.asciidoc deleted file mode 100644 index 1f2d3a0..0000000 --- a/doc/Usage/Plugins.asciidoc +++ /dev/null @@ -1,7 +0,0 @@ -== 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. - diff --git a/doc/Usage/Profile.asciidoc b/doc/Usage/Profile.asciidoc deleted file mode 100644 index 79506fd..0000000 --- a/doc/Usage/Profile.asciidoc +++ /dev/null @@ -1,37 +0,0 @@ -== Profiles -A Profile is a collection of settings, policies, scripts, cookies, cache and -history. Profiles can be used to isolate pages from each other. - -Off-the-record profiles only use in-memory cache and save no files to disk. - -Profiles can be either temporary or permanent. Temporary profiles are expire -when the application is closed, whereas permanent profiles are kept between -runs. - -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) - |