From e4402ac5ca0966515b00c278bb8c6fa1df07fc66 Mon Sep 17 00:00:00 2001 From: Aqua-sama Date: Thu, 29 Nov 2018 15:44:40 +0100 Subject: Add --session and --pick-session -s,--session replaces --browser.session --pick-session shows the SessionDialog instead of creating a session on startup --- doc/Usage/CommandLine.asciidoc | 10 ++++-- doc/Usage/Configuration.asciidoc | 66 ++++++++-------------------------------- doc/Usage/Plugins.asciidoc | 7 +++++ doc/meson.build | 2 ++ doc/smolbote.7.asciidoc | 4 +++ 5 files changed, 33 insertions(+), 56 deletions(-) create mode 100644 doc/Usage/Plugins.asciidoc (limited to 'doc') diff --git a/doc/Usage/CommandLine.asciidoc b/doc/Usage/CommandLine.asciidoc index a21b7c2..00a8d6c 100644 --- a/doc/Usage/CommandLine.asciidoc +++ b/doc/Usage/CommandLine.asciidoc @@ -1,8 +1,14 @@ == Command-line Options === General -* `-h`, `--help`: Display this help. +* `-h`, `--help`: Display command-line options list.. * `-v`, `--version`: Display version information. -* `--build`: Display build branch and commit. +* `--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 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. diff --git a/doc/Usage/Plugins.asciidoc b/doc/Usage/Plugins.asciidoc new file mode 100644 index 0000000..1f2d3a0 --- /dev/null +++ b/doc/Usage/Plugins.asciidoc @@ -0,0 +1,7 @@ +== 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/meson.build b/doc/meson.build index 0e1b49d..6e51e39 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -2,6 +2,8 @@ if get_option('manpage').enabled() asciidoctor = find_program('asciidoctor', required: true) custom_target('manpage', + # list depend_files so the output can be updated if any of them are changed + depend_files: ['smolbote.7.asciidoc', 'Usage/CommandLine.asciidoc', 'Usage/Configuration.asciidoc', 'Usage/Profile.asciidoc', 'Usage/Plugins.asciidoc', 'Usage/Filter.asciidoc'], input: 'smolbote.7.asciidoc', output: 'smolbote.7', command: [asciidoctor, '--backend=manpage', '--out-file=@OUTPUT@', '@INPUT@'], diff --git a/doc/smolbote.7.asciidoc b/doc/smolbote.7.asciidoc index ec1150f..a950816 100644 --- a/doc/smolbote.7.asciidoc +++ b/doc/smolbote.7.asciidoc @@ -21,6 +21,10 @@ include::Usage/Configuration.asciidoc[] include::Usage/Profile.asciidoc[] +include::Usage/Plugins.asciidoc[] + +include::Usage/Filter.asciidoc[] + == Copyright This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License version 3 as -- cgit v1.2.1