4114 lines
113 KiB
YAML
4114 lines
113 KiB
YAML
## general
|
|
|
|
aliases:
|
|
default:
|
|
w: session-save
|
|
q: close
|
|
qa: quit
|
|
wq: quit --save
|
|
wqa: quit --save
|
|
type:
|
|
name: Dict
|
|
keytype:
|
|
name: String
|
|
forbidden: ' '
|
|
valtype: Command
|
|
none_ok: true
|
|
desc: >-
|
|
Aliases for commands.
|
|
|
|
The keys of the given dictionary are the aliases, while the values are the
|
|
commands they map to.
|
|
|
|
confirm_quit:
|
|
type: ConfirmQuit
|
|
default: [never]
|
|
desc: Require a confirmation before quitting the application.
|
|
|
|
history_gap_interval:
|
|
type: Int
|
|
default: 30
|
|
desc: >-
|
|
Maximum time (in minutes) between two history items for them to be
|
|
considered being from the same browsing session.
|
|
|
|
Items with less time between them are grouped when being displayed in
|
|
`:history`. Use -1 to disable separation.
|
|
|
|
changelog_after_upgrade:
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- major: Show changelog for major upgrades (e.g. v2.0.0 -> v3.0.0).
|
|
- minor: Show changelog for major and minor upgrades (e.g. v2.0.0 -> v2.1.0).
|
|
- patch: Show changelog for major, minor and patch upgrades
|
|
(e.g. v2.0.0 -> v2.0.1).
|
|
- never: Never show changelog after upgrades.
|
|
default: minor
|
|
desc: When to show a changelog after qutebrowser was upgraded.
|
|
|
|
ignore_case:
|
|
renamed: search.ignore_case
|
|
|
|
search.ignore_case:
|
|
type: IgnoreCase
|
|
default: smart
|
|
desc: When to find text on a page case-insensitively.
|
|
|
|
search.incremental:
|
|
type: Bool
|
|
default: true
|
|
desc: >-
|
|
Find text on a page incrementally, renewing the search for each typed
|
|
character.
|
|
|
|
search.wrap:
|
|
type: Bool
|
|
default: true
|
|
desc: >-
|
|
Wrap around at the top and bottom of the page when advancing through text
|
|
matches using `:search-next` and `:search-prev`.
|
|
|
|
search.wrap_messages:
|
|
type: Bool
|
|
default: true
|
|
desc: >-
|
|
Display messages when advancing through text matches at the top and bottom
|
|
of the page, e.g. `Search hit TOP`.
|
|
|
|
new_instance_open_target:
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- tab: Open a new tab in the existing window and activate the window.
|
|
- tab-bg: Open a new background tab in the existing window and activate
|
|
the window.
|
|
- tab-silent: Open a new tab in the existing window without activating
|
|
the window.
|
|
- tab-bg-silent: Open a new background tab in the existing window without
|
|
activating the window.
|
|
- window: Open in a new window.
|
|
- private-window: Open in a new private window.
|
|
default: tab
|
|
desc: >-
|
|
How to open links in an existing instance if a new one is launched.
|
|
|
|
This happens when e.g. opening a link from a terminal.
|
|
|
|
See `new_instance_open_target_window` to customize in which window the link
|
|
is opened in.
|
|
|
|
new_instance_open_target_window:
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- first-opened: Open new tabs in the first (oldest) opened window.
|
|
- last-opened: Open new tabs in the last (newest) opened window.
|
|
- last-focused: Open new tabs in the most recently focused window.
|
|
- last-visible: Open new tabs in the most recently visible window.
|
|
default: last-focused
|
|
desc: >-
|
|
Which window to choose when opening links as new tabs.
|
|
|
|
When `new_instance_open_target` is set to `window`, this is ignored.
|
|
|
|
session_default_name:
|
|
renamed: session.default_name
|
|
|
|
session.default_name:
|
|
type:
|
|
name: SessionName
|
|
none_ok: true
|
|
default: null
|
|
desc: >-
|
|
Name of the session to save by default.
|
|
|
|
If this is set to null, the session which was last loaded is saved.
|
|
|
|
session.lazy_restore:
|
|
type: Bool
|
|
default: false
|
|
desc: Load a restored tab as soon as it takes focus.
|
|
|
|
backend:
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- webengine: "Use QtWebEngine (based on Chromium - recommended)."
|
|
- webkit: "Use QtWebKit (based on WebKit, similar to Safari - many known security
|
|
issues!)."
|
|
default: webengine
|
|
restart: true
|
|
desc: >-
|
|
Backend to use to display websites.
|
|
|
|
qutebrowser supports two different web rendering engines / backends,
|
|
QtWebEngine and QtWebKit (not recommended).
|
|
|
|
QtWebEngine is Qt's official successor to QtWebKit, and both the default/recommended
|
|
backend. It's based on a stripped-down Chromium and regularly updated with security
|
|
fixes and new features by the Qt project: https://wiki.qt.io/QtWebEngine
|
|
|
|
QtWebKit was qutebrowser's original backend when the project was started. However,
|
|
support for QtWebKit was discontinued by the Qt project with Qt 5.6 in 2016. The
|
|
development of QtWebKit was picked up in an official fork:
|
|
https://github.com/qtwebkit/qtwebkit - however, the project seems to have stalled
|
|
again. The latest release (5.212.0 Alpha 4) from March 2020 is based on a WebKit
|
|
version from 2016, with many known security vulnerabilities. Additionally, there is
|
|
no process isolation and sandboxing. Due to all those issues, while support for
|
|
QtWebKit is still available in qutebrowser for now, using it is strongly
|
|
discouraged.
|
|
|
|
|
|
## qt
|
|
|
|
qt_args:
|
|
renamed: qt.args
|
|
|
|
qt.args:
|
|
type:
|
|
name: List
|
|
valtype: String
|
|
none_ok: true
|
|
default: []
|
|
restart: true
|
|
desc: >-
|
|
Additional arguments to pass to Qt, without leading `--`.
|
|
|
|
With QtWebEngine, some Chromium arguments (see
|
|
https://peter.sh/experiments/chromium-command-line-switches/ for a list)
|
|
will work.
|
|
|
|
qt.environ:
|
|
type:
|
|
name: Dict
|
|
keytype: String
|
|
valtype:
|
|
name: String
|
|
none_ok: true
|
|
none_ok: true
|
|
default: {}
|
|
restart: true
|
|
desc: >-
|
|
Additional environment variables to set.
|
|
|
|
Setting an environment variable to null/None will unset it.
|
|
|
|
force_software_rendering:
|
|
renamed: qt.force_software_rendering
|
|
|
|
qt.force_software_rendering:
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- software-opengl: Tell LibGL to use a software implementation of GL
|
|
(`LIBGL_ALWAYS_SOFTWARE` / `QT_XCB_FORCE_SOFTWARE_OPENGL`)
|
|
- qt-quick: Tell Qt Quick to use a software renderer instead of OpenGL.
|
|
(`QT_QUICK_BACKEND=software`)
|
|
- chromium: Tell Chromium to disable GPU support and use Skia software
|
|
rendering instead. (`--disable-gpu`)
|
|
- none: Don't force software rendering.
|
|
default: none
|
|
backend: QtWebEngine
|
|
restart: true
|
|
desc: >-
|
|
Force software rendering for QtWebEngine.
|
|
|
|
This is needed for QtWebEngine to work with Nouveau drivers and can be
|
|
useful in other scenarios related to graphic issues.
|
|
|
|
qt.force_platform:
|
|
type:
|
|
name: String
|
|
none_ok: true
|
|
default: null
|
|
restart: true
|
|
desc: >-
|
|
Force a Qt platform to use.
|
|
|
|
This sets the `QT_QPA_PLATFORM` environment variable and is useful to force
|
|
using the XCB plugin when running QtWebEngine on Wayland.
|
|
|
|
qt.force_platformtheme:
|
|
type:
|
|
name: String
|
|
none_ok: true
|
|
default: null
|
|
restart: true
|
|
desc: >-
|
|
Force a Qt platformtheme to use.
|
|
|
|
This sets the `QT_QPA_PLATFORMTHEME` environment variable which controls
|
|
dialogs like the filepicker. By default, Qt determines the platform theme
|
|
based on the desktop environment.
|
|
|
|
qt.process_model:
|
|
renamed: qt.chromium.process_model
|
|
|
|
qt.chromium.process_model:
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- process-per-site-instance: Pages from separate sites are put into
|
|
separate processes and separate visits to the same site are also
|
|
isolated.
|
|
- process-per-site: Pages from separate sites are put into separate
|
|
processes. Unlike Process per Site Instance, all visits to the same
|
|
site will share an OS process. The benefit of this model is reduced
|
|
memory consumption, because more web pages will share processes.
|
|
The drawbacks include reduced security, robustness, and
|
|
responsiveness.
|
|
- single-process: Run all tabs in a single process. This should be used
|
|
for debugging purposes only, and it disables `:open --private`.
|
|
default: process-per-site-instance
|
|
backend: QtWebEngine
|
|
restart: true
|
|
desc: >-
|
|
Which Chromium process model to use.
|
|
|
|
Alternative process models use less resources, but decrease security and
|
|
robustness.
|
|
|
|
See the following pages for more details:
|
|
|
|
- https://www.chromium.org/developers/design-documents/process-models
|
|
- https://doc.qt.io/qt-6/qtwebengine-features.html#process-models
|
|
|
|
qt.low_end_device_mode:
|
|
renamed: qt.chromium.low_end_device_mode
|
|
|
|
qt.chromium.low_end_device_mode:
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- always: Always use low-end device mode.
|
|
- auto: Decide automatically (uses low-end mode with < 1 GB available
|
|
RAM).
|
|
- never: Never use low-end device mode.
|
|
default: auto
|
|
backend: QtWebEngine
|
|
restart: true
|
|
desc: >-
|
|
When to use Chromium's low-end device mode.
|
|
|
|
This improves the RAM usage of renderer processes, at the expense of
|
|
performance.
|
|
|
|
qt.chromium.sandboxing:
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- enable-all: Enable all available sandboxing mechanisms.
|
|
- disable-seccomp-bpf: Disable the Seccomp BPF filter sandbox (Linux only).
|
|
- disable-all: Disable all sandboxing (**not recommended!**).
|
|
default: enable-all
|
|
backend: QtWebEngine
|
|
restart: true
|
|
no_autoconfig: true # due to it being dangerous
|
|
# yamllint disable rule:line-length
|
|
desc: >-
|
|
What sandboxing mechanisms in Chromium to use.
|
|
|
|
Chromium has various sandboxing layers, which should be enabled for normal
|
|
browser usage. Mainly for testing and development, it's possible to disable
|
|
individual sandboxing layers via this setting.
|
|
|
|
Open `chrome://sandbox` to see the current sandbox status.
|
|
|
|
Changing this setting is only recommended if you know what you're doing, as
|
|
it **disables one of Chromium's security layers**. To avoid sandboxing being
|
|
accidentally disabled persistently, this setting can only be set via
|
|
`config.py`, not via `:set`.
|
|
|
|
See the Chromium documentation for more details:
|
|
|
|
- https://chromium.googlesource.com/chromium/src/\+/HEAD/sandbox/linux/README.md[Linux]
|
|
- https://chromium.googlesource.com/chromium/src/\+/HEAD/docs/design/sandbox.md[Windows]
|
|
- https://chromium.googlesource.com/chromium/src/\+/HEAD/sandbox/mac/README.md[Mac]
|
|
- https://chromium.googlesource.com/chromium/src/\+/HEAD/docs/design/sandbox_faq.md[FAQ (Windows-centric)]
|
|
# yamllint enable rule:line-length
|
|
|
|
qt.chromium.experimental_web_platform_features:
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- always: Enable experimental web platform features.
|
|
- auto: Enable experimental web platform features when using Qt 5.
|
|
- never: Disable experimental web platform features.
|
|
default: auto
|
|
backend: QtWebEngine
|
|
restart: true
|
|
desc: >-
|
|
Enables Web Platform features that are in development.
|
|
|
|
This passes the `--enable-experimental-web-platform-features` flag to
|
|
Chromium. By default, this is enabled with Qt 5 to maximize compatibility
|
|
despite an aging Chromium base.
|
|
|
|
qt.highdpi:
|
|
type: Bool
|
|
default: false
|
|
restart: true
|
|
desc: >-
|
|
Turn on Qt HighDPI scaling.
|
|
|
|
This is equivalent to setting QT_ENABLE_HIGHDPI_SCALING=1 (Qt >= 5.14) in
|
|
the environment.
|
|
|
|
It's off by default as it can cause issues with some bitmap fonts.
|
|
As an alternative to this, it's possible to set font sizes and the
|
|
`zoom.default` setting.
|
|
|
|
qt.workarounds.remove_service_workers:
|
|
type: Bool
|
|
default: false
|
|
desc: >-
|
|
Delete the QtWebEngine Service Worker directory on every start.
|
|
|
|
This workaround can help with certain crashes caused by an unknown QtWebEngine bug
|
|
related to Service Workers. Those crashes happen seemingly immediately on Windows;
|
|
after one hour of operation on other systems.
|
|
|
|
Note however that enabling this option *can lead to data loss* on some pages (as
|
|
Service Worker data isn't persisted) and will negatively impact start-up time.
|
|
|
|
qt.workarounds.locale:
|
|
type: Bool
|
|
default: false
|
|
backend: QtWebEngine
|
|
desc: >-
|
|
Work around locale parsing issues in QtWebEngine 5.15.3.
|
|
|
|
With some locales, QtWebEngine 5.15.3 is unusable without this workaround.
|
|
In affected scenarios, QtWebEngine will log "Network service crashed,
|
|
restarting service." and only display a blank page.
|
|
|
|
However, It is expected that distributions shipping QtWebEngine 5.15.3
|
|
follow up with a proper fix soon, so it is disabled by default.
|
|
|
|
qt.workarounds.disable_accelerated_2d_canvas:
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- always: Disable accelerated 2d canvas
|
|
- auto: Disable on Qt versions with known issues, enable otherwise
|
|
- never: Enable accelerated 2d canvas
|
|
default: auto
|
|
backend: QtWebEngine
|
|
restart: true
|
|
desc: >-
|
|
Disable accelerated 2d canvas to avoid graphical glitches.
|
|
|
|
On some setups graphical issues can occur on sites like Google sheets
|
|
and PDF.js. These don't occur when accelerated 2d canvas is turned off,
|
|
so we do that by default.
|
|
|
|
So far these glitches only occur on some Intel graphics devices.
|
|
|
|
qt.workarounds.disable_hangouts_extension:
|
|
type: Bool
|
|
default: false
|
|
backend: QtWebEngine
|
|
restart: true
|
|
desc: >-
|
|
Disable the Hangouts extension.
|
|
|
|
The Hangouts extension provides additional APIs for Google domains only.
|
|
|
|
Hangouts has been replaced with Meet,
|
|
which appears to work without this extension.
|
|
|
|
Note this setting gets ignored and the Hangouts extension is always
|
|
disabled to avoid crashes on Qt 6.5.0 to 6.5.3 if dark mode is enabled,
|
|
as well as on Qt 6.6.0.
|
|
|
|
qt.workarounds.disable_accessibility:
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- always: Disable renderer accessibility
|
|
- auto: Disable on Qt versions with known issues, enable otherwise
|
|
- never: Enable renderer accessibility
|
|
default: auto
|
|
backend: QtWebEngine
|
|
restart: true
|
|
desc: >-
|
|
Disable accessibility to avoid crashes on Qt 6.10.1.
|
|
|
|
## auto_save
|
|
|
|
auto_save.interval:
|
|
type:
|
|
name: Int
|
|
minval: 0
|
|
maxval: maxint
|
|
default: 15000
|
|
desc: Time interval (in milliseconds) between auto-saves of
|
|
config/cookies/etc.
|
|
|
|
auto_save.session:
|
|
type: Bool
|
|
default: false
|
|
desc: >-
|
|
Always restore open sites when qutebrowser is reopened.
|
|
|
|
Without this option set, `:wq` (`:quit --save`) needs to be used to save
|
|
open tabs (and restore them), while quitting qutebrowser in any other way
|
|
will not save/restore the session.
|
|
|
|
By default, this will save to the session which was last loaded. This
|
|
behavior can be customized via the `session.default_name` setting.
|
|
|
|
## content
|
|
|
|
content.autoplay:
|
|
default: true
|
|
type: Bool
|
|
backend: QtWebEngine
|
|
supports_pattern: true
|
|
desc: >-
|
|
Automatically start playing `<video>` elements.
|
|
|
|
content.cache.size:
|
|
default: null
|
|
type:
|
|
name: Int
|
|
none_ok: true
|
|
minval: 0
|
|
maxval: maxint64
|
|
desc: >-
|
|
Size (in bytes) of the HTTP network cache. Null to use the default value.
|
|
|
|
With QtWebEngine, the maximum supported value is 2147483647 (~2 GB).
|
|
|
|
content.canvas_reading:
|
|
default: true
|
|
type: Bool
|
|
backend: QtWebEngine
|
|
supports_pattern: true
|
|
desc: >-
|
|
Allow websites to read canvas elements.
|
|
|
|
Note this is needed for some websites to work properly.
|
|
|
|
On QtWebEngine < 6.6, this setting requires a restart and does not support
|
|
URL patterns, only the global setting is applied.
|
|
|
|
# Defaults from QWebSettings::QWebSettings() in
|
|
# qtwebkit/Source/WebKit/qt/Api/qwebsettings.cpp
|
|
|
|
content.cache.maximum_pages:
|
|
default: 0
|
|
type:
|
|
name: Int
|
|
minval: 0
|
|
maxval: maxint
|
|
backend: QtWebKit
|
|
desc: >-
|
|
Maximum number of pages to hold in the global memory page cache.
|
|
|
|
The page cache allows for a nicer user experience when navigating forth or
|
|
back to pages in the forward/back history, by pausing and resuming up to
|
|
_n_ pages.
|
|
|
|
For more information about the feature, please refer to:
|
|
https://webkit.org/blog/427/webkit-page-cache-i-the-basics/
|
|
|
|
content.cache.appcache:
|
|
default: true
|
|
type: Bool
|
|
backend: QtWebKit
|
|
supports_pattern: true
|
|
desc: >-
|
|
Enable support for the HTML 5 web application cache feature.
|
|
|
|
An application cache acts like an HTTP cache in some sense. For documents
|
|
that use the application cache via JavaScript, the loader engine will first
|
|
ask the application cache for the contents, before hitting the network.
|
|
|
|
content.cookies.accept:
|
|
default: all
|
|
supports_pattern: true
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- all: "Accept all cookies."
|
|
- no-3rdparty: "Accept cookies from the same origin only. This is known
|
|
to break some sites, such as GMail."
|
|
- no-unknown-3rdparty: "Accept cookies from the same origin only, unless
|
|
a cookie is already set for the domain. On QtWebEngine, this is the
|
|
same as no-3rdparty."
|
|
- never: "Don't accept cookies at all."
|
|
desc: >-
|
|
Which cookies to accept.
|
|
|
|
With QtWebEngine, this setting also controls other features with tracking
|
|
capabilities similar to those of cookies; including IndexedDB, DOM storage,
|
|
filesystem API, service workers, and AppCache.
|
|
|
|
Note that with QtWebKit, only `all` and `never` are supported as per-domain
|
|
values. Setting `no-3rdparty` or `no-unknown-3rdparty` per-domain on
|
|
QtWebKit will have the same effect as `all`.
|
|
|
|
If this setting is used with URL patterns, the pattern gets applied to the
|
|
origin/first party URL of the page making the request, not the request URL.
|
|
|
|
With QtWebEngine 5.15.0+, paths will be stripped from URLs, so URL patterns
|
|
using paths will not match. With QtWebEngine 5.15.2+, subdomains are
|
|
additionally stripped as well, so you will typically need to set this
|
|
setting for `example.com` when the cookie is set on
|
|
`somesubdomain.example.com` for it to work properly.
|
|
|
|
To debug issues with this setting, start qutebrowser with `--debug
|
|
--logfilter network --debug-flag log-cookies` which will show all cookies
|
|
being set.
|
|
|
|
content.cookies.store:
|
|
default: true
|
|
type: Bool
|
|
desc: Store cookies.
|
|
|
|
content.default_encoding:
|
|
type: String
|
|
default: iso-8859-1
|
|
desc: >-
|
|
Default encoding to use for websites.
|
|
|
|
The encoding must be a string describing an encoding such as _utf-8_,
|
|
_iso-8859-1_, etc.
|
|
|
|
content.unknown_url_scheme_policy:
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- disallow: "Disallows all navigation requests to URLs with unknown
|
|
schemes."
|
|
- allow-from-user-interaction: "Allows navigation requests to URLs with
|
|
unknown schemes that are issued from user-interaction (like a
|
|
mouse-click), whereas other navigation requests (for example from
|
|
JavaScript) are suppressed."
|
|
- allow-all: "Allows all navigation requests to URLs with unknown
|
|
schemes."
|
|
default: allow-from-user-interaction
|
|
backend: QtWebEngine
|
|
supports_pattern: true
|
|
desc: >-
|
|
How navigation requests to URLs with unknown schemes are handled.
|
|
|
|
content.windowed_fullscreen:
|
|
renamed: content.fullscreen.window
|
|
|
|
content.fullscreen.window:
|
|
type: Bool
|
|
default: false
|
|
desc: >-
|
|
Limit fullscreen to the browser window (does not expand to fill the screen).
|
|
|
|
content.fullscreen.overlay_timeout:
|
|
type:
|
|
name: Int
|
|
minval: 0
|
|
maxval: maxint
|
|
default: 3000
|
|
desc: >-
|
|
Set fullscreen notification overlay timeout in milliseconds.
|
|
|
|
If set to 0, no overlay will be displayed.
|
|
|
|
content.desktop_capture:
|
|
type: BoolAsk
|
|
default: ask
|
|
supports_pattern: true
|
|
desc: Allow websites to share screen content.
|
|
|
|
content.developer_extras:
|
|
deleted: true
|
|
|
|
content.dns_prefetch:
|
|
default: true
|
|
type: Bool
|
|
backend: QtWebEngine
|
|
supports_pattern: true
|
|
desc: Try to pre-fetch DNS entries to speed up browsing.
|
|
|
|
content.frame_flattening:
|
|
default: false
|
|
type: Bool
|
|
backend: QtWebKit
|
|
supports_pattern: true
|
|
desc: >-
|
|
Expand each subframe to its contents.
|
|
|
|
This will flatten all the frames to become one scrollable page.
|
|
|
|
content.prefers_reduced_motion:
|
|
default: false
|
|
type: Bool
|
|
backend: QtWebEngine
|
|
restart: true
|
|
desc: >-
|
|
Request websites to minimize non-essentials animations and motion.
|
|
|
|
This results in the `prefers-reduced-motion` CSS media query to evaluate to
|
|
`reduce` (rather than `no-preference`).
|
|
|
|
On Windows, if this setting is set to False, the system-wide animation
|
|
setting is considered.
|
|
|
|
content.site_specific_quirks:
|
|
renamed: content.site_specific_quirks.enabled
|
|
|
|
content.site_specific_quirks.enabled:
|
|
default: true
|
|
restart: true
|
|
type: Bool
|
|
desc: 'Enable quirks (such as faked user agent headers) needed to get
|
|
specific sites to work properly.'
|
|
|
|
content.site_specific_quirks.skip:
|
|
type:
|
|
name: FlagList
|
|
valid_values:
|
|
- ua-google
|
|
- ua-googledocs
|
|
- ua-gnome-gitlab
|
|
- js-whatsapp-web
|
|
- js-discord
|
|
- js-string-replaceall
|
|
- js-array-at
|
|
- misc-krunker
|
|
- misc-mathml-darkmode
|
|
none_ok: true
|
|
default: []
|
|
desc: >-
|
|
Disable a list of named quirks.
|
|
|
|
# emacs: '
|
|
|
|
content.geolocation:
|
|
default: ask
|
|
type: BoolAsk
|
|
supports_pattern: true
|
|
desc: Allow websites to request geolocations.
|
|
|
|
content.mouse_lock:
|
|
default: ask
|
|
type: BoolAsk
|
|
supports_pattern: true
|
|
backend: QtWebEngine
|
|
desc: Allow websites to lock your mouse pointer.
|
|
|
|
content.headers.accept_language:
|
|
type:
|
|
name: String
|
|
none_ok: true
|
|
encoding: ascii
|
|
supports_pattern: true
|
|
default: en-US,en;q=0.9
|
|
desc: >-
|
|
Value to send in the `Accept-Language` header.
|
|
|
|
Note that the value read from JavaScript is always the global value.
|
|
|
|
content.headers.custom:
|
|
default: {}
|
|
type:
|
|
name: Dict
|
|
keytype:
|
|
name: String
|
|
encoding: ascii
|
|
valtype:
|
|
name: String
|
|
encoding: ascii
|
|
none_ok: true
|
|
none_ok: true
|
|
supports_pattern: true
|
|
desc: Custom headers for qutebrowser HTTP requests.
|
|
|
|
content.headers.do_not_track:
|
|
type:
|
|
name: Bool
|
|
none_ok: true
|
|
default: true
|
|
supports_pattern: true
|
|
desc: >-
|
|
Value to send in the `DNT` header.
|
|
|
|
When this is set to true, qutebrowser asks websites to not track your
|
|
identity. If set to null, the DNT header is not sent at all.
|
|
|
|
content.headers.referer:
|
|
default: same-domain
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- always: "Always send the Referer. With QtWebEngine 6.2+, this value is
|
|
unavailable and will act like `same-domain`."
|
|
- never: "Never send the Referer. This is not recommended, as some sites
|
|
may break."
|
|
- same-domain: "Only send the Referer for the same domain. This will
|
|
still protect your privacy, but shouldn't break any sites. With
|
|
QtWebEngine, the referer will still be sent for other domains, but
|
|
with stripped path information."
|
|
restart: true
|
|
desc: >-
|
|
When to send the Referer header.
|
|
|
|
The Referer header tells websites from which website you were coming from
|
|
when visiting them. Note that with QtWebEngine, websites can override this
|
|
preference by setting the `Referrer-Policy:` header, so that any websites
|
|
visited from them get the full referer.
|
|
|
|
No restart is needed with QtWebKit.
|
|
|
|
content.headers.user_agent:
|
|
default: 'Mozilla/5.0 ({os_info})
|
|
AppleWebKit/{webkit_version} (KHTML, like Gecko)
|
|
{upstream_browser_key}/{upstream_browser_version_short}
|
|
Safari/{webkit_version}'
|
|
type:
|
|
name: FormatString
|
|
encoding: ascii
|
|
fields:
|
|
- os_info
|
|
- webkit_version
|
|
- qt_key
|
|
- qt_version
|
|
- upstream_browser_key
|
|
- upstream_browser_version
|
|
- upstream_browser_version_short
|
|
- qutebrowser_version
|
|
completions:
|
|
# See https://techblog.willshouse.com/2012/01/03/most-common-user-agents/
|
|
#
|
|
# To update the following list of user agents, run the script
|
|
# 'ua_fetch.py'
|
|
# Vim-protip: Place your cursor below this comment and run
|
|
# :r!python scripts/dev/ua_fetch.py
|
|
- - "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
|
|
(KHTML, like Gecko) Chrome/142.0.0.0 Safari/537.36"
|
|
- Chrome 142 macOS
|
|
- - "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML,
|
|
like Gecko) Chrome/142.0.0.0 Safari/537.36"
|
|
- Chrome 142 Win10
|
|
- - "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like
|
|
Gecko) Chrome/142.0.0.0 Safari/537.36"
|
|
- Chrome 142 Linux
|
|
supports_pattern: true
|
|
desc: |
|
|
User agent to send.
|
|
|
|
The following placeholders are defined:
|
|
|
|
* `{os_info}`: Something like "X11; Linux x86_64".
|
|
* `{webkit_version}`: The underlying WebKit version (set to a fixed value
|
|
with QtWebEngine).
|
|
* `{qt_key}`: "Qt" for QtWebKit, "QtWebEngine" for QtWebEngine.
|
|
* `{qt_version}`: The underlying Qt version.
|
|
* `{upstream_browser_key}`: "Version" for QtWebKit, "Chrome" for
|
|
QtWebEngine.
|
|
* `{upstream_browser_version}`: The corresponding Safari/Chrome version.
|
|
* `{upstream_browser_version_short}`: The corresponding Safari/Chrome
|
|
version, but only with its major version.
|
|
* `{qutebrowser_version}`: The currently running qutebrowser version.
|
|
|
|
The default value is equal to the default user agent of
|
|
QtWebKit/QtWebEngine, but with the `QtWebEngine/...` part removed for
|
|
increased compatibility.
|
|
|
|
Note that the value read from JavaScript is always the global value.
|
|
|
|
content.host_blocking.enabled:
|
|
renamed: content.blocking.enabled
|
|
|
|
content.host_blocking.lists:
|
|
renamed: content.blocking.hosts.lists
|
|
|
|
content.host_blocking.whitelist:
|
|
renamed: content.blocking.whitelist
|
|
|
|
content.blocking.enabled:
|
|
default: true
|
|
supports_pattern: true
|
|
type: Bool
|
|
desc: Enable the ad/host blocker
|
|
|
|
content.blocking.hosts.lists:
|
|
default:
|
|
- "https://raw.githubusercontent.com/StevenBlack/hosts/master/hosts"
|
|
type:
|
|
name: List
|
|
valtype: Url
|
|
none_ok: true
|
|
desc: |
|
|
List of URLs to host blocklists for the host blocker.
|
|
|
|
Only used when the simple host-blocker is used (see `content.blocking.method`).
|
|
|
|
The file can be in one of the following formats:
|
|
|
|
- An `/etc/hosts`-like file
|
|
- One host per line
|
|
- A zip-file of any of the above, with either only one file, or a file
|
|
named `hosts` (with any extension).
|
|
|
|
It's also possible to add a local file or directory via a `file://` URL. In
|
|
case of a directory, all files in the directory are read as adblock lists.
|
|
|
|
The file `~/.config/qutebrowser/blocked-hosts` is always read if it exists.
|
|
|
|
content.blocking.hosts.block_subdomains:
|
|
default: true
|
|
type: Bool
|
|
desc: >-
|
|
Block subdomains of blocked hosts.
|
|
|
|
Note: If only a single subdomain is blocked but should be allowed, consider
|
|
using `content.blocking.whitelist` instead.
|
|
|
|
content.blocking.method:
|
|
default: auto
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- auto: "Use Brave's ABP-style adblocker if available, host blocking
|
|
otherwise"
|
|
- adblock: Use Brave's ABP-style adblocker
|
|
- hosts: Use hosts blocking
|
|
- both: Use both hosts blocking and Brave's ABP-style adblocker
|
|
desc: |
|
|
Which method of blocking ads should be used.
|
|
|
|
Support for Adblock Plus (ABP) syntax blocklists using Brave's Rust library requires
|
|
the `adblock` Python package to be installed, which is an optional dependency of
|
|
qutebrowser. It is required when either `adblock` or `both` are selected.
|
|
|
|
content.blocking.adblock.lists:
|
|
default:
|
|
- "https://easylist.to/easylist/easylist.txt"
|
|
- "https://easylist.to/easylist/easyprivacy.txt"
|
|
type:
|
|
name: List
|
|
valtype: Url
|
|
none_ok: true
|
|
desc: |
|
|
List of URLs to ABP-style adblocking rulesets.
|
|
|
|
Only used when Brave's ABP-style adblocker is used (see `content.blocking.method`).
|
|
|
|
You can find an overview of available lists here:
|
|
https://adblockplus.org/en/subscriptions - note that the special
|
|
`subscribe.adblockplus.org` links aren't handled by qutebrowser, you will instead
|
|
need to find the link to the raw `.txt` file (e.g. by extracting it from the
|
|
`location` parameter of the subscribe URL and URL-decoding it).
|
|
|
|
content.blocking.whitelist:
|
|
default: []
|
|
type:
|
|
name: List
|
|
valtype: UrlPattern
|
|
none_ok: true
|
|
desc: >-
|
|
A list of patterns that should always be loaded, despite being blocked by the
|
|
ad-/host-blocker.
|
|
|
|
Local domains are always exempt from adblocking.
|
|
|
|
Note this whitelists otherwise blocked requests, not first-party URLs. As
|
|
an example, if `example.org` loads an ad from `ads.example.org`, the
|
|
whitelist entry could be `https://ads.example.org/*`. If you want to
|
|
disable the adblocker on a given page, use the
|
|
`content.blocking.enabled` setting with a URL pattern instead.
|
|
|
|
content.hyperlink_auditing:
|
|
default: false
|
|
type: Bool
|
|
supports_pattern: true
|
|
desc: Enable hyperlink auditing (`<a ping>`).
|
|
|
|
content.images:
|
|
default: true
|
|
type: Bool
|
|
desc: Load images automatically in web pages.
|
|
supports_pattern: true
|
|
|
|
content.javascript.alert:
|
|
default: true
|
|
type: Bool
|
|
desc: Show javascript alerts.
|
|
|
|
content.javascript.clipboard:
|
|
default: ask
|
|
type:
|
|
name: JSClipboardPermission
|
|
valid_values:
|
|
- none: Disable access to clipboard.
|
|
- access: Allow reading from and writing to the clipboard.
|
|
- access-paste: Allow accessing the clipboard and pasting clipboard content.
|
|
- ask: Prompt when requested (grants 'access-paste' permission).
|
|
supports_pattern: true
|
|
desc: >-
|
|
Allow JavaScript to read from or write to the clipboard.
|
|
|
|
With QtWebEngine, writing the clipboard as response to a user interaction
|
|
is always allowed.
|
|
|
|
On Qt < 6.8, the `ask` setting is equivalent to `none` and permission needs
|
|
to be granted manually via this setting.
|
|
|
|
content.javascript.can_close_tabs:
|
|
default: false
|
|
type: Bool
|
|
backend: QtWebKit
|
|
supports_pattern: true
|
|
desc: Allow JavaScript to close tabs.
|
|
|
|
content.javascript.can_open_tabs_automatically:
|
|
default: false
|
|
type: Bool
|
|
supports_pattern: true
|
|
desc: Allow JavaScript to open new tabs without user interaction.
|
|
|
|
content.javascript.enabled:
|
|
default: true
|
|
type: Bool
|
|
supports_pattern: true
|
|
desc: Enable JavaScript.
|
|
|
|
content.javascript.log:
|
|
type:
|
|
name: Dict
|
|
fixed_keys: ['unknown', 'info', 'warning', 'error']
|
|
keytype: String
|
|
valtype:
|
|
name: String
|
|
valid_values:
|
|
- none: "Don't log messages."
|
|
- debug: Log messages with debug level.
|
|
- info: Log messages with info level.
|
|
- warning: Log messages with warning level.
|
|
- error: Log messages with error level.
|
|
default:
|
|
unknown: debug
|
|
info: debug
|
|
warning: debug
|
|
error: debug
|
|
desc: >-
|
|
Log levels to use for JavaScript console logging messages.
|
|
|
|
When a JavaScript message with the level given in the dictionary key is
|
|
logged, the corresponding dictionary value selects the qutebrowser logger
|
|
to use.
|
|
|
|
On QtWebKit, the "unknown" setting is always used.
|
|
|
|
The following levels are valid: `none`, `debug`, `info`, `warning`,
|
|
`error`.
|
|
|
|
content.javascript.log_message:
|
|
renamed: content.javascript.log_message.levels
|
|
|
|
content.javascript.log_message.levels:
|
|
type:
|
|
name: Dict
|
|
none_ok: true
|
|
keytype: String
|
|
valtype:
|
|
name: FlagList
|
|
none_ok: true
|
|
valid_values:
|
|
- info: Show JS info as messages.
|
|
- warning: Show JS warnings as messages.
|
|
- error: Show JS errors as messages.
|
|
default:
|
|
"qute:*": ["error"]
|
|
"userscript:GM-*": []
|
|
"userscript:*": ["error"]
|
|
desc: >-
|
|
Javascript message sources/levels to show in the qutebrowser UI.
|
|
|
|
When a JavaScript message is logged from a location matching the glob
|
|
pattern given in the key, and is from one of the levels listed as value,
|
|
it's surfaced as a message in the qutebrowser UI.
|
|
|
|
By default, errors happening in qutebrowser internally are shown to the
|
|
user.
|
|
|
|
content.javascript.log_message.excludes:
|
|
type:
|
|
name: Dict
|
|
keytype: String
|
|
none_ok: true
|
|
valtype:
|
|
name: List
|
|
valtype: String
|
|
default:
|
|
"userscript:_qute_stylesheet":
|
|
- "*Refused to apply inline style because it violates the following Content
|
|
Security Policy directive: *"
|
|
desc: >-
|
|
Javascript messages to *not* show in the UI, despite a corresponding
|
|
`content.javascript.log_message.levels` setting.
|
|
|
|
Both keys and values are glob patterns, with the key matching the location
|
|
of the error, and the value matching the error message.
|
|
|
|
By default, the https://web.dev/csp/[Content security policy] violations
|
|
triggered by qutebrowser's stylesheet handling are excluded, as those errors
|
|
are to be expected and can't be easily handled by the underlying code.
|
|
|
|
content.javascript.modal_dialog:
|
|
type: Bool
|
|
default: false
|
|
desc: Use the standard JavaScript modal dialog for `alert()` and `confirm()`.
|
|
|
|
content.javascript.prompt:
|
|
default: true
|
|
type: Bool
|
|
desc: Show javascript prompts.
|
|
|
|
content.javascript.legacy_touch_events:
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- always: Legacy touch events are always enabled. This might cause some
|
|
websites to assume a mobile device.
|
|
- auto: Legacy touch events are only enabled if a touch screen was
|
|
detected on startup.
|
|
- never: Legacy touch events are always disabled.
|
|
default: never
|
|
backend: QtWebEngine
|
|
restart: true
|
|
desc: >-
|
|
Enables the legacy touch event feature.
|
|
|
|
This affects JS APIs such as:
|
|
|
|
- ontouch* members on window, document, Element
|
|
- document.createTouch, document.createTouchList
|
|
- document.createEvent("TouchEvent")
|
|
|
|
Newer Chromium versions have those disabled by default:
|
|
https://bugs.chromium.org/p/chromium/issues/detail?id=392584
|
|
https://groups.google.com/a/chromium.org/g/blink-dev/c/KV6kqDJpYiE
|
|
|
|
content.local_content_can_access_remote_urls:
|
|
default: false
|
|
type: Bool
|
|
supports_pattern: true
|
|
desc: Allow locally loaded documents to access remote URLs.
|
|
|
|
content.local_content_can_access_file_urls:
|
|
default: true
|
|
type: Bool
|
|
supports_pattern: true
|
|
desc: Allow locally loaded documents to access other local URLs.
|
|
|
|
content.local_storage:
|
|
default: true
|
|
type: Bool
|
|
supports_pattern: true
|
|
desc: Enable support for HTML 5 local storage and Web SQL.
|
|
|
|
content.media.audio_capture:
|
|
default: ask
|
|
type: BoolAsk
|
|
supports_pattern: true
|
|
backend: QtWebEngine
|
|
desc: Allow websites to record audio.
|
|
|
|
content.media.audio_video_capture:
|
|
default: ask
|
|
type: BoolAsk
|
|
supports_pattern: true
|
|
backend: QtWebEngine
|
|
desc: Allow websites to record audio and video.
|
|
|
|
content.media.video_capture:
|
|
default: ask
|
|
type: BoolAsk
|
|
supports_pattern: true
|
|
backend: QtWebEngine
|
|
desc: Allow websites to record video.
|
|
|
|
content.netrc_file:
|
|
default: null
|
|
type:
|
|
name: File
|
|
none_ok: true
|
|
desc: >-
|
|
Netrc-file for HTTP authentication.
|
|
|
|
If unset, `~/.netrc` is used.
|
|
|
|
content.notifications:
|
|
renamed: content.notifications.enabled
|
|
|
|
content.notifications.enabled:
|
|
default: ask
|
|
type: BoolAsk
|
|
supports_pattern: true
|
|
desc: Allow websites to show notifications.
|
|
|
|
content.notifications.presenter:
|
|
default: auto
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- auto: Tries `libnotify`, `systray` and `messages`, uses the first one available
|
|
without showing error messages.
|
|
- qt: Use Qt's native notification presenter, based on a system tray icon.
|
|
Switching from or to this value requires a restart of qutebrowser.
|
|
- libnotify: Shows messages via DBus in a libnotify-compatible way. If DBus isn't
|
|
available, falls back to `systray` or `messages`, but shows an error
|
|
message.
|
|
- systray: Use a notification presenter based on a systray icon. Falls back to
|
|
`libnotify` or `messages` if not systray is available. This is a
|
|
reimplementation of the `qt` setting value, but with the possibility to
|
|
switch to it at runtime.
|
|
- messages: Show notifications as qutebrowser messages. Most notification features
|
|
aren't available.
|
|
- herbe: (experimental!) Show notifications using herbe (github.com/dudik/herbe).
|
|
Most notification features aren't available.
|
|
backend: QtWebEngine
|
|
desc: >-
|
|
What notification presenter to use for web notifications.
|
|
|
|
Note that not all implementations support all features of notifications:
|
|
|
|
- The `qt` and `systray` options only support showing one notification at the time
|
|
and ignore the `tag` option to replace existing notifications.
|
|
- The `herbe` option only supports showing one notification at the time and doesn't
|
|
show icons.
|
|
- The `messages` option doesn't show icons and doesn't support the `click` and
|
|
`close` events.
|
|
|
|
content.notifications.show_origin:
|
|
default: true
|
|
type: Bool
|
|
supports_pattern: true
|
|
backend: QtWebEngine
|
|
desc: >-
|
|
Whether to show the origin URL for notifications.
|
|
|
|
Note that URL patterns with this setting only get matched against the origin part of
|
|
the URL, so e.g. paths in patterns will never match.
|
|
|
|
Note that with the `qt` presenter, origins are never shown.
|
|
|
|
content.pdfjs:
|
|
default: false
|
|
type: Bool
|
|
supports_pattern: true
|
|
desc: >-
|
|
Display PDF files via PDF.js in the browser without showing a download prompt.
|
|
|
|
Note that the files can still be downloaded by clicking the download button
|
|
in the pdf.js viewer. With this set to `false`, the `:prompt-open-download
|
|
--pdfjs` command (bound to `<Ctrl-p>` by default) can be used in the
|
|
download prompt.
|
|
|
|
content.persistent_storage:
|
|
default: ask
|
|
type: BoolAsk
|
|
supports_pattern: true
|
|
backend: QtWebEngine
|
|
desc: Allow websites to request persistent storage quota via
|
|
`navigator.webkitPersistentStorage.requestQuota`.
|
|
|
|
content.plugins:
|
|
default: false
|
|
type: Bool
|
|
supports_pattern: true
|
|
desc: Enable plugins in Web pages.
|
|
|
|
content.print_element_backgrounds:
|
|
type: Bool
|
|
default: true
|
|
backend: QtWebEngine
|
|
supports_pattern: true
|
|
desc: >-
|
|
Draw the background color and images also when the page is printed.
|
|
|
|
content.private_browsing:
|
|
type: Bool
|
|
default: false
|
|
desc: Open new windows in private browsing mode which does not record visited
|
|
pages.
|
|
|
|
content.proxy:
|
|
default: system
|
|
type: Proxy
|
|
desc: >-
|
|
Proxy to use.
|
|
|
|
In addition to the listed values, you can use a `socks://...` or
|
|
`http://...` URL.
|
|
|
|
Note that with QtWebEngine, it will take a couple of seconds until the
|
|
change is applied, if this value is changed at runtime. Authentication for
|
|
SOCKS proxies isn't supported due to Chromium limitations.
|
|
|
|
content.proxy_dns_requests:
|
|
default: true
|
|
type: Bool
|
|
backend: QtWebKit
|
|
desc: Send DNS requests over the configured proxy.
|
|
|
|
content.register_protocol_handler:
|
|
default: ask
|
|
type: BoolAsk
|
|
supports_pattern: true
|
|
backend: QtWebEngine
|
|
desc: Allow websites to register protocol handlers via
|
|
`navigator.registerProtocolHandler`.
|
|
|
|
content.tls.certificate_errors:
|
|
default: ask
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- ask: Ask how to proceed for every certificate error (unless non-overridable due
|
|
to HSTS).
|
|
- ask-block-thirdparty: Ask how to proceed for normal page loads, but silently
|
|
block resource loads.
|
|
- block: Automatically block loading on certificate errors.
|
|
- load-insecurely: Force loading pages despite certificate errors. This is
|
|
*insecure* and should be avoided. Instead of using this, consider fixing the
|
|
underlying issue or importing a self-signed certificate via `certutil` (or
|
|
Chromium) instead.
|
|
supports_pattern: true
|
|
desc: How to proceed on TLS certificate errors.
|
|
|
|
content.user_stylesheets:
|
|
type:
|
|
name: ListOrValue
|
|
valtype: File
|
|
none_ok: true
|
|
default: []
|
|
desc: List of user stylesheet filenames to use.
|
|
|
|
content.webgl:
|
|
default: true
|
|
type: Bool
|
|
supports_pattern: true
|
|
desc: Enable WebGL.
|
|
|
|
content.webrtc_ip_handling_policy:
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- all-interfaces: WebRTC has the right to enumerate all interfaces and
|
|
bind them to discover public interfaces.
|
|
- default-public-and-private-interfaces: WebRTC should only use the
|
|
default route used by http. This also exposes the associated
|
|
default private address. Default route is the route chosen by the
|
|
OS on a multi-homed endpoint.
|
|
- default-public-interface-only: WebRTC should only use the default route
|
|
used by http. This doesn't expose any local addresses.
|
|
- disable-non-proxied-udp: WebRTC should only use TCP to contact peers or
|
|
servers unless the proxy server supports UDP. This doesn't expose
|
|
any local addresses either.
|
|
default: all-interfaces
|
|
backend: QtWebEngine
|
|
restart: true
|
|
desc: >-
|
|
Which interfaces to expose via WebRTC.
|
|
|
|
content.xss_auditing:
|
|
type: Bool
|
|
default: false
|
|
supports_pattern: true
|
|
desc: >-
|
|
Monitor load requests for cross-site scripting attempts.
|
|
|
|
Suspicious scripts will be blocked and reported in the devtools
|
|
JavaScript console.
|
|
|
|
Note that bypasses for the XSS auditor are widely known and it can be
|
|
abused for cross-site info leaks in some scenarios, see:
|
|
https://www.chromium.org/developers/design-documents/xss-auditor
|
|
|
|
content.mute:
|
|
default: false
|
|
type: Bool
|
|
supports_pattern: true
|
|
desc: >-
|
|
Automatically mute tabs.
|
|
|
|
Note that if the `:tab-mute` command is used, the mute status for the
|
|
affected tab is now controlled manually, and this setting doesn't have any
|
|
effect.
|
|
|
|
# emacs: '
|
|
|
|
## completion
|
|
|
|
completion.cmd_history_max_items:
|
|
default: 100
|
|
type:
|
|
name: Int
|
|
minval: -1
|
|
desc: >-
|
|
Number of commands to save in the command history.
|
|
|
|
0: no history / -1: unlimited
|
|
|
|
completion.height:
|
|
type:
|
|
name: PercOrInt
|
|
minperc: 0
|
|
maxperc: 100
|
|
minint: 1
|
|
default: 50%
|
|
desc: Height (in pixels or as percentage of the window) of the completion.
|
|
|
|
completion.quick:
|
|
default: true
|
|
type: Bool
|
|
desc: "Move on to the next part when there's only one possible completion
|
|
left."
|
|
|
|
completion.show:
|
|
default: always
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- always: Whenever a completion is available.
|
|
- auto: Whenever a completion is requested.
|
|
- never: Never.
|
|
desc: When to show the autocompletion window.
|
|
|
|
completion.shrink:
|
|
default: false
|
|
type: Bool
|
|
desc: Shrink the completion to be smaller than the configured size if
|
|
there are no scrollbars.
|
|
|
|
completion.scrollbar.width:
|
|
default: 12
|
|
type:
|
|
name: Int
|
|
minval: 0
|
|
desc: Width (in pixels) of the scrollbar in the completion window.
|
|
|
|
completion.scrollbar.padding:
|
|
default: 2
|
|
type:
|
|
name: Int
|
|
minval: 0
|
|
desc: Padding (in pixels) of the scrollbar handle in the completion window.
|
|
|
|
completion.timestamp_format:
|
|
type:
|
|
name: String
|
|
none_ok: true
|
|
default: '%Y-%m-%d %H:%M'
|
|
desc: >-
|
|
Format of timestamps (e.g. for the history completion).
|
|
|
|
See https://sqlite.org/lang_datefunc.html and
|
|
https://docs.python.org/3/library/datetime.html#strftime-strptime-behavior
|
|
for allowed substitutions, qutebrowser uses both sqlite and Python to
|
|
format its timestamps.
|
|
|
|
completion.web_history.exclude:
|
|
type:
|
|
name: List
|
|
valtype: UrlPattern
|
|
none_ok: true
|
|
default: []
|
|
restart: true
|
|
desc: >-
|
|
A list of patterns which should not be shown in the history.
|
|
|
|
This only affects the completion. Matching URLs are still saved in the
|
|
history (and visible on the `:history` page), but hidden in the
|
|
completion.
|
|
|
|
Changing this setting will cause the completion history to be regenerated
|
|
on the next start, which will take a short while.
|
|
|
|
completion.web_history_max_items:
|
|
renamed: completion.web_history.max_items
|
|
|
|
completion.web_history.max_items:
|
|
default: -1
|
|
type:
|
|
name: Int
|
|
minval: -1
|
|
maxval: maxint64
|
|
desc: >-
|
|
Number of URLs to show in the web history.
|
|
|
|
0: no history / -1: unlimited
|
|
|
|
completion.delay:
|
|
default: 0
|
|
type:
|
|
name: Int
|
|
minval: 0
|
|
desc: Delay (in milliseconds) before updating completions after typing a
|
|
character.
|
|
|
|
completion.min_chars:
|
|
default: 1
|
|
type:
|
|
name: Int
|
|
minval: 1
|
|
desc: Minimum amount of characters needed to update completions.
|
|
|
|
completion.use_best_match:
|
|
type: Bool
|
|
default: false
|
|
desc: Execute the best-matching command on a partial match.
|
|
|
|
## downloads
|
|
|
|
downloads.location.directory:
|
|
default: null
|
|
type:
|
|
name: Directory
|
|
none_ok: true
|
|
desc: >-
|
|
Directory to save downloads to.
|
|
|
|
If unset, a sensible OS-specific default is used.
|
|
|
|
downloads.location.prompt:
|
|
default: true
|
|
type: Bool
|
|
desc: >-
|
|
Prompt the user for the download location.
|
|
|
|
If set to false, `downloads.location.directory` will be used.
|
|
|
|
downloads.location.remember:
|
|
default: true
|
|
type: Bool
|
|
desc: Remember the last used download directory.
|
|
|
|
downloads.location.suggestion:
|
|
default: path
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- path: Show only the download path.
|
|
- filename: Show only download filename.
|
|
- both: Show download path and filename.
|
|
desc: What to display in the download filename input.
|
|
|
|
completion.open_categories:
|
|
type:
|
|
name: FlagList
|
|
valid_values: [searchengines, quickmarks, bookmarks, history, filesystem]
|
|
none_ok: true
|
|
default:
|
|
- searchengines
|
|
- quickmarks
|
|
- bookmarks
|
|
- history
|
|
- filesystem
|
|
desc: Which categories to show (in which order) in the :open completion.
|
|
|
|
completion.favorite_paths:
|
|
type:
|
|
name: List
|
|
none_ok: true
|
|
valtype:
|
|
name: String
|
|
default: []
|
|
desc: >-
|
|
Default filesystem autocomplete suggestions for :open.
|
|
|
|
The elements of this list show up in the completion window under the Filesystem
|
|
category when the command line contains `:open` but no argument.
|
|
|
|
downloads.open_dispatcher:
|
|
type:
|
|
name: String
|
|
none_ok: true
|
|
default: null
|
|
desc: >-
|
|
Default program used to open downloads.
|
|
|
|
If null, the default internal handler is used.
|
|
|
|
Any `{}` in the string will be expanded to the filename, else the filename
|
|
will be appended.
|
|
|
|
downloads.position:
|
|
type: VerticalPosition
|
|
default: top
|
|
desc: Where to show the downloaded files.
|
|
|
|
downloads.prevent_mixed_content:
|
|
type: Bool
|
|
default: true
|
|
supports_pattern: true
|
|
desc:
|
|
Automatically abort insecure (HTTP) downloads originating from secure
|
|
(HTTPS) pages.
|
|
|
|
For per-domain settings, the relevant URL is the URL initiating the
|
|
download, not the URL the download itself is coming from. It's not
|
|
recommended to set this setting to false globally.
|
|
|
|
downloads.remove_finished:
|
|
default: -1
|
|
type:
|
|
name: Int
|
|
minval: -1
|
|
desc: >-
|
|
Duration (in milliseconds) to wait before removing finished downloads.
|
|
|
|
If set to -1, downloads are never removed.
|
|
|
|
## editor
|
|
|
|
editor.command:
|
|
type:
|
|
name: ShellCommand
|
|
placeholder: true
|
|
default: ["gvim", "-f", "{file}", "-c", "normal {line}G{column0}l"]
|
|
desc: |
|
|
Editor (and arguments) to use for the `edit-*` commands.
|
|
The following placeholders are defined:
|
|
|
|
* `{file}`: Filename of the file to be edited.
|
|
* `{line}`: Line in which the caret is found in the text.
|
|
* `{column}`: Column in which the caret is found in the text.
|
|
* `{line0}`: Same as `{line}`, but starting from index 0.
|
|
* `{column0}`: Same as `{column}`, but starting from index 0.
|
|
|
|
editor.encoding:
|
|
type: Encoding
|
|
default: utf-8
|
|
desc: Encoding to use for the editor.
|
|
|
|
editor.remove_file:
|
|
default: true
|
|
type: Bool
|
|
desc: Delete the temporary file upon closing the editor.
|
|
|
|
## fileselect
|
|
|
|
fileselect.handler:
|
|
default: default
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- default: "Use the default file selector."
|
|
- external: "Use an external command."
|
|
desc: >-
|
|
Handler for selecting file(s) in forms. If `external`, then the commands
|
|
specified by `fileselect.single_file.command`,
|
|
`fileselect.multiple_files.command` and `fileselect.folder.command` are
|
|
used to select one file, multiple files, and folders, respectively.
|
|
|
|
fileselect.single_file.command:
|
|
type:
|
|
name: ShellCommand
|
|
placeholder: false
|
|
completions:
|
|
- ['["xterm", "-e", "ranger", "--choosefile={}"]', "Ranger in xterm"]
|
|
- ['["xterm", "-e", "vifm", "--choose-files", "{}"]', "vifm in xterm"]
|
|
- ['["xterm", "-e", "nnn", "-p", "{}"]', "nnn in xterm"]
|
|
- ['["xterm", "-e", "fff", "-p", "{}"]', "fff in xterm"]
|
|
- ['["xterm", "-e", "lf", "-selection-path", "{}"]', "lf in xterm"]
|
|
- ['["xterm", "-e", "yazi", "--chooser-file", "{}"]', "yazi in xterm"]
|
|
default: ['xterm', '-e', 'ranger', '--choosefile={}']
|
|
desc: >-
|
|
Command (and arguments) to use for selecting a single file in forms.
|
|
The command should write the selected file path to the specified file or stdout.
|
|
|
|
The following placeholders are defined:
|
|
|
|
* `{}`: Filename of the file to be written to. If not contained in any argument, the
|
|
standard output of the command is read instead.
|
|
|
|
fileselect.multiple_files.command:
|
|
type:
|
|
name: ShellCommand
|
|
placeholder: false
|
|
completions:
|
|
- ['["xterm", "-e", "ranger", "--choosefiles={}"]', "Ranger in xterm"]
|
|
- ['["xterm", "-e", "vifm", "--choose-files", "{}"]', "vifm in xterm"]
|
|
- ['["xterm", "-e", "nnn", "-p", "{}"]', "nnn in xterm"]
|
|
- ['["xterm", "-e", "fff", "-p", "{}"]', "fff in xterm"]
|
|
- ['["xterm", "-e", "lf", "-selection-path", "{}"]', "lf in xterm"]
|
|
- ['["xterm", "-e", "yazi", "--chooser-file", "{}"]', "yazi in xterm"]
|
|
default: ['xterm', '-e', 'ranger', '--choosefiles={}']
|
|
desc: >-
|
|
Command (and arguments) to use for selecting multiple files in forms.
|
|
The command should write the selected file paths to the specified file or to stdout,
|
|
separated by newlines.
|
|
|
|
The following placeholders are defined:
|
|
|
|
* `{}`: Filename of the file to be written to. If not contained in any argument, the
|
|
standard output of the command is read instead.
|
|
|
|
fileselect.folder.command:
|
|
type:
|
|
name: ShellCommand
|
|
placeholder: false
|
|
completions:
|
|
- ['["xterm", "-e", "ranger", "--choosedir={}"]', "Ranger in xterm"]
|
|
- ['["xterm", "-e", "vifm", "--choose-dir", "{}"]', "vifm in xterm"]
|
|
- ['["xterm", "-e", "nnn", "-p", "{}"]', "nnn in xterm"]
|
|
- ['["xterm", "-e", "yazi", "--cwd-file", "{}"]', "yazi in xterm"]
|
|
default: ['xterm', '-e', 'ranger', '--choosedir={}']
|
|
desc: >-
|
|
Command (and arguments) to use for selecting a single folder in forms.
|
|
The command should write the selected folder path to the specified file or stdout.
|
|
|
|
The following placeholders are defined:
|
|
|
|
* `{}`: Filename of the file to be written to. If not contained in any argument, the
|
|
standard output of the command is read instead.
|
|
|
|
## hints
|
|
|
|
hints.auto_follow:
|
|
default: unique-match
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- always: "Auto-follow whenever there is only a single hint on a page."
|
|
- unique-match: "Auto-follow whenever there is a unique non-empty match
|
|
in either the hint string (word mode) or filter (number mode)."
|
|
- full-match: "Follow the hint when the user typed the whole hint
|
|
(letter, word or number mode) or the element's text (only in number
|
|
mode)."
|
|
- never: "The user will always need to press Enter to follow a hint."
|
|
desc: When a hint can be automatically followed without pressing Enter.
|
|
|
|
hints.auto_follow_timeout:
|
|
default: 0
|
|
type: Int
|
|
desc: Duration (in milliseconds) to ignore normal-mode key bindings after a
|
|
successful auto-follow.
|
|
|
|
hints.border:
|
|
default: '1px solid #E3BE23'
|
|
type: String
|
|
desc: CSS border value for hints.
|
|
|
|
hints.padding:
|
|
default:
|
|
top: 0
|
|
bottom: 0
|
|
left: 3
|
|
right: 3
|
|
type: Padding
|
|
desc: Padding (in pixels) for hints.
|
|
|
|
hints.radius:
|
|
default: 3
|
|
type:
|
|
name: Int
|
|
minval: 0
|
|
desc: Rounding radius (in pixels) for the edges of hints.
|
|
|
|
hints.chars:
|
|
default: asdfghjkl
|
|
type:
|
|
name: UniqueCharString
|
|
minlen: 2
|
|
completions:
|
|
- ['asdfghjkl', "Home row"]
|
|
- ['aoeuidnths', "Home row (Dvorak)"]
|
|
- ['abcdefghijklmnopqrstuvwxyz', "All letters"]
|
|
desc: Characters used for hint strings.
|
|
|
|
hints.dictionary:
|
|
default: /usr/share/dict/words
|
|
type:
|
|
name: File
|
|
required: false
|
|
desc: Dictionary file to be used by the word hints.
|
|
|
|
hints.find_implementation:
|
|
default: python
|
|
backend: QtWebKit
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- javascript: Better but slower
|
|
- python: Slightly worse but faster
|
|
desc: Which implementation to use to find elements to hint.
|
|
|
|
hints.hide_unmatched_rapid_hints:
|
|
default: true
|
|
type: Bool
|
|
desc: Hide unmatched hints in rapid mode.
|
|
|
|
hints.min_chars:
|
|
default: 1
|
|
type:
|
|
name: Int
|
|
minval: 1
|
|
desc: Minimum number of characters used for hint strings.
|
|
|
|
hints.mode:
|
|
default: letter
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- number: Use numeric hints. (In this mode you can also type letters from
|
|
the hinted element to filter and reduce the number of elements that
|
|
are hinted.)
|
|
- letter: Use the characters in the `hints.chars` setting.
|
|
- word: Use hints words based on the html elements and the extra words.
|
|
desc: Mode to use for hints.
|
|
|
|
hints.next_regexes:
|
|
default:
|
|
- "\\bnext\\b"
|
|
- "\\bmore\\b"
|
|
- "\\bnewer\\b"
|
|
- "\\b[>\u2192\u226B]\\b"
|
|
- "\\b(>>|\xBB)\\b"
|
|
- "\\bcontinue\\b"
|
|
type:
|
|
name: List
|
|
valtype:
|
|
name: Regex
|
|
flags: IGNORECASE
|
|
desc: Comma-separated list of regular expressions to use for 'next' links.
|
|
|
|
hints.prev_regexes:
|
|
default:
|
|
- "\\bprev(ious)?\\b"
|
|
- "\\bback\\b"
|
|
- "\\bolder\\b"
|
|
- "\\b[<\u2190\u226A]\\b"
|
|
- "\\b(<<|\xAB)\\b"
|
|
type:
|
|
name: List
|
|
valtype:
|
|
name: Regex
|
|
flags: IGNORECASE
|
|
desc: Comma-separated list of regular expressions to use for 'prev' links.
|
|
|
|
hints.scatter:
|
|
default: true
|
|
type: Bool
|
|
desc: >-
|
|
Scatter hint key chains (like Vimium) or not (like dwb).
|
|
|
|
Ignored for number hints.
|
|
|
|
hints.selectors:
|
|
no_autoconfig: true
|
|
default:
|
|
all:
|
|
- 'a'
|
|
- 'area'
|
|
- 'textarea'
|
|
- 'select'
|
|
- 'input:not([type="hidden"])'
|
|
- 'button'
|
|
- 'frame'
|
|
- 'iframe'
|
|
- 'img'
|
|
- 'link'
|
|
- 'summary'
|
|
- '[contenteditable]:not([contenteditable="false"])'
|
|
- '[onclick]'
|
|
- '[onmousedown]'
|
|
- '[role="link"]'
|
|
- '[role="option"]'
|
|
- '[role="button"]'
|
|
- '[role="tab"]'
|
|
- '[role="checkbox"]'
|
|
- '[role="switch"]'
|
|
- '[role="menuitem"]'
|
|
- '[role="menuitemcheckbox"]'
|
|
- '[role="menuitemradio"]'
|
|
- '[role="treeitem"]'
|
|
- '[aria-haspopup]'
|
|
- '[ng-click]'
|
|
- '[ngClick]'
|
|
- '[data-ng-click]'
|
|
- '[x-ng-click]'
|
|
- '[tabindex]:not([tabindex="-1"])'
|
|
links:
|
|
- 'a[href]'
|
|
- 'area[href]'
|
|
- 'link[href]'
|
|
- '[role="link"][href]'
|
|
images:
|
|
- 'img'
|
|
media:
|
|
- 'audio'
|
|
- 'img'
|
|
- 'video'
|
|
url:
|
|
- '[src]'
|
|
- '[href]'
|
|
inputs:
|
|
- 'input[type="text"]'
|
|
- 'input[type="date"]'
|
|
- 'input[type="datetime-local"]'
|
|
- 'input[type="email"]'
|
|
- 'input[type="month"]'
|
|
- 'input[type="number"]'
|
|
- 'input[type="password"]'
|
|
- 'input[type="search"]'
|
|
- 'input[type="tel"]'
|
|
- 'input[type="time"]'
|
|
- 'input[type="url"]'
|
|
- 'input[type="week"]'
|
|
- 'input:not([type])'
|
|
- '[contenteditable]:not([contenteditable="false"])'
|
|
- 'textarea'
|
|
type:
|
|
name: Dict
|
|
keytype: String
|
|
valtype:
|
|
name: List
|
|
none_ok: true
|
|
valtype: String
|
|
supports_pattern: true
|
|
desc: CSS selectors used to determine which elements on a page should have
|
|
hints.
|
|
|
|
hints.uppercase:
|
|
default: false
|
|
type: Bool
|
|
desc: Make characters in hint strings uppercase.
|
|
|
|
hints.leave_on_load:
|
|
default: false
|
|
type: Bool
|
|
desc: Leave hint mode when starting a new page load.
|
|
|
|
## input
|
|
|
|
input.escape_quits_reporter:
|
|
type: Bool
|
|
default: true
|
|
desc: Allow Escape to quit the crash reporter.
|
|
|
|
input.forward_unbound_keys:
|
|
default: auto
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- all: "Forward all unbound keys."
|
|
- auto: "Forward unbound non-alphanumeric keys."
|
|
- none: "Don't forward any keys."
|
|
desc: Which unbound keys to forward to the webview in normal mode.
|
|
|
|
input.insert_mode.auto_load:
|
|
default: false
|
|
type: Bool
|
|
desc: Automatically enter insert mode if an editable element is focused after
|
|
loading the page.
|
|
|
|
input.insert_mode.auto_enter:
|
|
default: true
|
|
type: Bool
|
|
desc: Enter insert mode if an editable element is clicked.
|
|
|
|
input.insert_mode.auto_leave:
|
|
default: true
|
|
type: Bool
|
|
desc: Leave insert mode if a non-editable element is clicked.
|
|
|
|
input.insert_mode.plugins:
|
|
default: false
|
|
type: Bool
|
|
desc: Switch to insert mode when clicking flash and other plugins.
|
|
|
|
input.insert_mode.leave_on_load:
|
|
default: true
|
|
type: Bool
|
|
supports_pattern: true
|
|
desc: >-
|
|
Leave insert mode when starting a new page load.
|
|
|
|
Patterns may be unreliable on this setting, and they may match the url you
|
|
are navigating to, or the URL you are navigating from.
|
|
|
|
input.links_included_in_focus_chain:
|
|
default: true
|
|
type: Bool
|
|
supports_pattern: true
|
|
desc: Include hyperlinks in the keyboard focus chain when tabbing.
|
|
|
|
input.mouse.back_forward_buttons:
|
|
default: true
|
|
type: Bool
|
|
desc: Enable back and forward buttons on the mouse.
|
|
|
|
input.mouse.rocker_gestures:
|
|
default: false
|
|
type: Bool
|
|
desc: >-
|
|
Enable Opera-like mouse rocker gestures.
|
|
|
|
This disables the context menu.
|
|
|
|
input.partial_timeout:
|
|
default: 0
|
|
type:
|
|
name: Int
|
|
minval: 0
|
|
maxval: maxint
|
|
desc: >-
|
|
Timeout (in milliseconds) for partially typed key bindings.
|
|
|
|
If the current input forms only partial matches, the keystring will be
|
|
cleared after this time.
|
|
|
|
If set to 0, partially typed bindings are never cleared.
|
|
|
|
input.rocker_gestures:
|
|
renamed: input.mouse.rocker_gestures
|
|
|
|
input.spatial_navigation:
|
|
default: false
|
|
type: Bool
|
|
supports_pattern: true
|
|
desc: >-
|
|
Enable spatial navigation.
|
|
|
|
Spatial navigation consists in the ability to navigate between focusable
|
|
elements, such as hyperlinks and form controls, on a web page by using the
|
|
Left, Right, Up and Down arrow keys. For example, if a user presses the
|
|
Right key, heuristics determine whether there is an element they might be
|
|
trying to reach towards the right and which element they probably want.
|
|
|
|
input.media_keys:
|
|
default: true
|
|
type: Bool
|
|
backend: QtWebEngine
|
|
restart: true
|
|
desc: >-
|
|
Whether the underlying Chromium should handle media keys.
|
|
|
|
On Linux, disabling this also disables Chromium's MPRIS integration.
|
|
|
|
input.match_counts:
|
|
default: true
|
|
type: Bool
|
|
desc: >-
|
|
Interpret number prefixes as counts for bindings.
|
|
|
|
This enables for vi-like bindings that can be prefixed with a number to
|
|
indicate a count.
|
|
Disabling it allows for emacs-like bindings where number keys are passed
|
|
through (according to `input.forward_unbound_keys`) instead.
|
|
|
|
input.mode_override:
|
|
default: null
|
|
type:
|
|
name: String
|
|
none_ok: true
|
|
valid_values:
|
|
- normal
|
|
- insert
|
|
- passthrough
|
|
supports_pattern: true
|
|
desc: Mode to change to when focusing on a tab/URL changes.
|
|
|
|
## keyhint
|
|
|
|
keyhint.blacklist:
|
|
type:
|
|
name: List
|
|
none_ok: true
|
|
valtype:
|
|
name: String
|
|
default: []
|
|
desc: >-
|
|
Keychains that shouldn't be shown in the keyhint dialog.
|
|
|
|
Globs are supported, so `;*` will blacklist all keychains starting with
|
|
`;`. Use `*` to disable keyhints.
|
|
|
|
keyhint.radius:
|
|
type:
|
|
name: Int
|
|
minval: 0
|
|
default: 6
|
|
desc: Rounding radius (in pixels) for the edges of the keyhint dialog.
|
|
|
|
# emacs: '
|
|
|
|
keyhint.delay:
|
|
type:
|
|
name: Int
|
|
minval: 0
|
|
default: 500
|
|
desc: Time (in milliseconds) from pressing a key to seeing the keyhint
|
|
dialog.
|
|
|
|
## messages
|
|
|
|
messages.timeout:
|
|
type:
|
|
name: Int
|
|
minval: 0
|
|
default: 3000
|
|
desc: >-
|
|
Duration (in milliseconds) to show messages in the statusbar for.
|
|
|
|
Set to 0 to never clear messages.
|
|
|
|
messages.unfocused:
|
|
deleted: true
|
|
|
|
## prompt
|
|
|
|
prompt.filebrowser:
|
|
type: Bool
|
|
default: true
|
|
desc: Show a filebrowser in download prompts.
|
|
|
|
prompt.radius:
|
|
type:
|
|
name: Int
|
|
minval: 0
|
|
default: 8
|
|
desc: Rounding radius (in pixels) for the edges of prompts.
|
|
|
|
## scrolling
|
|
|
|
scrolling.bar:
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- always: Always show the scrollbar.
|
|
- never: Never show the scrollbar.
|
|
- when-searching: Show the scrollbar when searching for text in the
|
|
webpage. With the QtWebKit backend, this is equal to `never`.
|
|
- overlay: Show an overlay scrollbar. On macOS, this is
|
|
unavailable and equal to `when-searching`; with the QtWebKit
|
|
backend, this is equal to `never`. Enabling/disabling overlay
|
|
scrollbars requires a restart.
|
|
default: overlay
|
|
desc: When/how to show the scrollbar.
|
|
|
|
scrolling.smooth:
|
|
type: Bool
|
|
default: false
|
|
supports_pattern: true
|
|
desc: >-
|
|
Enable smooth scrolling for web pages.
|
|
|
|
Note smooth scrolling does not work with the `:scroll-px` command.
|
|
|
|
## spellcheck
|
|
|
|
spellcheck.languages:
|
|
type:
|
|
name: List
|
|
valtype:
|
|
name: String
|
|
valid_values:
|
|
- af-ZA: Afrikaans (South Africa)
|
|
- bg-BG: Bulgarian (Bulgaria)
|
|
- ca-ES: Catalan (Spain)
|
|
- cs-CZ: Czech (Czech Republic)
|
|
- da-DK: Danish (Denmark)
|
|
- de-DE: German (Germany)
|
|
- el-GR: Greek (Greece)
|
|
- en-AU: English (Australia)
|
|
- en-CA: English (Canada)
|
|
- en-GB: English (United Kingdom)
|
|
- en-US: English (United States)
|
|
- es-ES: Spanish (Spain)
|
|
- et-EE: Estonian (Estonia)
|
|
- fa-IR: Farsi (Iran)
|
|
- fo-FO: Faroese (Faroe Islands)
|
|
- fr-FR: French (France)
|
|
- he-IL: Hebrew (Israel)
|
|
- hi-IN: Hindi (India)
|
|
- hr-HR: Croatian (Croatia)
|
|
- hu-HU: Hungarian (Hungary)
|
|
- id-ID: Indonesian (Indonesia)
|
|
- it-IT: Italian (Italy)
|
|
- ko: Korean
|
|
- lt-LT: Lithuanian (Lithuania)
|
|
- lv-LV: Latvian (Latvia)
|
|
- nb-NO: Norwegian (Norway)
|
|
- nl-NL: Dutch (Netherlands)
|
|
- pl-PL: Polish (Poland)
|
|
- pt-BR: Portuguese (Brazil)
|
|
- pt-PT: Portuguese (Portugal)
|
|
- ro-RO: Romanian (Romania)
|
|
- ru-RU: Russian (Russia)
|
|
- sh: Serbo-Croatian
|
|
- sk-SK: Slovak (Slovakia)
|
|
- sl-SI: Slovenian (Slovenia)
|
|
- sq: Albanian
|
|
- sr: Serbian
|
|
- sv-SE: Swedish (Sweden)
|
|
- ta-IN: Tamil (India)
|
|
- tg-TG: Tajik (Tajikistan)
|
|
- tr-TR: Turkish (Turkey)
|
|
- uk-UA: Ukrainian (Ukraine)
|
|
- vi-VN: Vietnamese (Viet Nam)
|
|
none_ok: true
|
|
default: []
|
|
desc: >-
|
|
Languages to use for spell checking.
|
|
|
|
You can check for available languages and install dictionaries using
|
|
scripts/dictcli.py. Run the script with -h/--help for instructions.
|
|
backend: QtWebEngine
|
|
|
|
## statusbar
|
|
|
|
statusbar.show:
|
|
default: always
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- always: Always show the statusbar.
|
|
- never: Always hide the statusbar.
|
|
- in-mode: Show the statusbar when in modes other than normal mode.
|
|
desc: When to show the statusbar.
|
|
|
|
statusbar.padding:
|
|
type: Padding
|
|
default:
|
|
top: 1
|
|
bottom: 1
|
|
left: 0
|
|
right: 0
|
|
desc: Padding (in pixels) for the statusbar.
|
|
|
|
statusbar.position:
|
|
type: VerticalPosition
|
|
default: bottom
|
|
desc: Position of the status bar.
|
|
|
|
statusbar.widgets:
|
|
type:
|
|
name: List
|
|
valtype:
|
|
name: StatusbarWidget
|
|
valid_values:
|
|
- url: "Current page URL."
|
|
- scroll: "Percentage of the current page position like `10%`."
|
|
- scroll_raw: "Raw percentage of the current page position like `10`."
|
|
- history: "Display an arrow when possible to go back/forward in
|
|
history."
|
|
- search_match: "A match count when searching, e.g. `Match [2/10]`."
|
|
- tabs: "Current active tab, e.g. `2`."
|
|
- keypress: "Display pressed keys when composing a vi command."
|
|
- progress: "Progress bar for the current page loading."
|
|
- 'text:foo': "Display the static text after the colon, `foo` in the example."
|
|
- clock: "Display current time. The format can be changed by adding a
|
|
format string via `clock:...`. For supported format strings, see
|
|
https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes[the
|
|
Python datetime documentation]."
|
|
none_ok: true
|
|
default: ['keypress', 'search_match', 'url', 'scroll', 'history', 'tabs', 'progress']
|
|
desc: "List of widgets displayed in the statusbar."
|
|
|
|
## tabs
|
|
|
|
tabs.background:
|
|
default: true
|
|
type: Bool
|
|
desc: Open new tabs (middleclick/ctrl+click) in the background.
|
|
|
|
tabs.close_mouse_button:
|
|
default: middle
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- right: "Close tabs on right-click."
|
|
- middle: "Close tabs on middle-click."
|
|
- none: "Don't close tabs using the mouse."
|
|
desc: Mouse button with which to close tabs.
|
|
|
|
tabs.close_mouse_button_on_bar:
|
|
default: new-tab
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- new-tab: "Open a new tab."
|
|
- close-current: "Close the current tab."
|
|
- close-last: "Close the last tab."
|
|
- ignore: "Don't do anything."
|
|
desc: How to behave when the close mouse button is pressed on the tab bar.
|
|
|
|
tabs.favicons.scale:
|
|
default: 1.0
|
|
type:
|
|
name: Float
|
|
minval: 0.0
|
|
desc: >-
|
|
Scaling factor for favicons in the tab bar.
|
|
|
|
The tab size is unchanged, so big favicons also require extra
|
|
`tabs.padding`.
|
|
|
|
tabs.favicons.show:
|
|
default: always
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- always: Always show favicons.
|
|
- never: Always hide favicons.
|
|
- pinned: Show favicons only on pinned tabs.
|
|
desc: >-
|
|
When to show favicons in the tab bar.
|
|
|
|
When switching this from never to always/pinned, note that favicons might
|
|
not be loaded yet, thus tabs might require a reload to display them.
|
|
|
|
tabs.last_close:
|
|
default: ignore
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- ignore: "Don't do anything."
|
|
- blank: "Load a blank page."
|
|
- startpage: "Load the start page."
|
|
- default-page: "Load the default page."
|
|
- close: "Close the window."
|
|
desc: >-
|
|
How to behave when the last tab is closed.
|
|
|
|
If the `tabs.tabs_are_windows` setting is set, this is ignored and the behavior is
|
|
always identical to the `close` value.
|
|
|
|
tabs.mousewheel_switching:
|
|
default: true
|
|
type: Bool
|
|
desc: Switch between tabs using the mouse wheel.
|
|
|
|
tabs.new_position.related:
|
|
default: next
|
|
type: NewTabPosition
|
|
desc: >-
|
|
Position of new tabs opened from another tab.
|
|
|
|
See `tabs.new_position.stacking` for controlling stacking behavior.
|
|
|
|
tabs.new_position.unrelated:
|
|
default: last
|
|
type: NewTabPosition
|
|
desc: >-
|
|
Position of new tabs which are not opened from another tab.
|
|
|
|
See `tabs.new_position.stacking` for controlling stacking behavior.
|
|
|
|
tabs.new_position.stacking:
|
|
default: true
|
|
type: Bool
|
|
desc: >-
|
|
Stack related tabs on top of each other when opened consecutively.
|
|
|
|
Only applies for `next` and `prev` values of `tabs.new_position.related`
|
|
and `tabs.new_position.unrelated`.
|
|
|
|
tabs.padding:
|
|
default:
|
|
top: 0
|
|
bottom: 0
|
|
left: 5
|
|
right: 5
|
|
type: Padding
|
|
desc: Padding (in pixels) around text for tabs.
|
|
|
|
tabs.mode_on_change:
|
|
default: normal
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- persist: "Retain the current mode."
|
|
- restore: "Restore previously saved mode."
|
|
- normal: "Always revert to normal mode."
|
|
desc: When switching tabs, what input mode is applied.
|
|
|
|
tabs.position:
|
|
default: top
|
|
type: Position
|
|
desc: Position of the tab bar.
|
|
|
|
tabs.select_on_remove:
|
|
default: 'next'
|
|
type: SelectOnRemove
|
|
desc: Which tab to select when the focused tab is removed.
|
|
|
|
tabs.show:
|
|
default: always
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- always: Always show the tab bar.
|
|
- never: Always hide the tab bar.
|
|
- multiple: Hide the tab bar if only one tab is open.
|
|
- switching: Show the tab bar when switching tabs.
|
|
desc: When to show the tab bar.
|
|
|
|
tabs.show_switching_delay:
|
|
default: 800
|
|
type:
|
|
name: Int
|
|
minval: 0
|
|
maxval: maxint
|
|
desc: "Duration (in milliseconds) to show the tab bar before hiding it when
|
|
tabs.show is set to 'switching'."
|
|
|
|
tabs.tabs_are_windows:
|
|
default: false
|
|
type: Bool
|
|
desc: Open a new window for every tab.
|
|
|
|
tabs.title.alignment:
|
|
default: left
|
|
type: TextAlignment
|
|
desc: Alignment of the text inside of tabs.
|
|
|
|
tabs.title.elide:
|
|
default: right
|
|
type: ElidePosition
|
|
desc: Position of ellipsis in truncated title of tabs.
|
|
|
|
tabs.title.format:
|
|
default: '{audio}{index}: {current_title}'
|
|
type:
|
|
name: FormatString
|
|
fields:
|
|
- perc
|
|
- perc_raw
|
|
- current_title
|
|
- title_sep
|
|
- index
|
|
- aligned_index
|
|
- relative_index
|
|
- id
|
|
- scroll_pos
|
|
- host
|
|
- private
|
|
- current_url
|
|
- protocol
|
|
- audio
|
|
none_ok: true
|
|
desc: |
|
|
Format to use for the tab title.
|
|
The following placeholders are defined:
|
|
|
|
* `{perc}`: Percentage as a string like `[10%]`.
|
|
* `{perc_raw}`: Raw percentage, e.g. `10`.
|
|
* `{current_title}`: Title of the current web page.
|
|
* `{title_sep}`: The string `" - "` if a title is set, empty otherwise.
|
|
* `{index}`: Index of this tab.
|
|
* `{aligned_index}`: Index of this tab padded with spaces to have the same
|
|
width.
|
|
* `{relative_index}`: Index of this tab relative to the current tab.
|
|
* `{id}`: Internal tab ID of this tab.
|
|
* `{scroll_pos}`: Page scroll position.
|
|
* `{host}`: Host of the current web page.
|
|
* `{backend}`: Either `webkit` or `webengine`
|
|
* `{private}`: Indicates when private mode is enabled.
|
|
* `{current_url}`: URL of the current web page.
|
|
* `{protocol}`: Protocol (http/https/...) of the current web page.
|
|
* `{audio}`: Indicator for audio/mute status.
|
|
|
|
tabs.title.format_pinned:
|
|
default: '{index}'
|
|
type:
|
|
name: FormatString
|
|
fields:
|
|
- perc
|
|
- perc_raw
|
|
- current_title
|
|
- title_sep
|
|
- index
|
|
- aligned_index
|
|
- relative_index
|
|
- id
|
|
- scroll_pos
|
|
- host
|
|
- private
|
|
- current_url
|
|
- protocol
|
|
- audio
|
|
none_ok: true
|
|
desc: Format to use for the tab title for pinned tabs. The same placeholders
|
|
like for `tabs.title.format` are defined.
|
|
|
|
tabs.width.bar:
|
|
renamed: tabs.width
|
|
|
|
tabs.width:
|
|
default: 15%
|
|
type:
|
|
name: PercOrInt
|
|
minperc: 0
|
|
maxperc: 100
|
|
minint: 1
|
|
desc: "Width (in pixels or as percentage of the window) of the tab bar if
|
|
it's vertical."
|
|
|
|
tabs.min_width:
|
|
default: -1
|
|
type:
|
|
name: Int
|
|
minval: -1
|
|
maxval: maxint
|
|
desc: >-
|
|
Minimum width (in pixels) of tabs (-1 for the default minimum size
|
|
behavior).
|
|
|
|
This setting only applies when tabs are horizontal.
|
|
|
|
This setting does not apply to pinned tabs, unless `tabs.pinned.shrink` is
|
|
False.
|
|
|
|
tabs.max_width:
|
|
default: -1
|
|
type:
|
|
name: Int
|
|
minval: -1
|
|
maxval: maxint
|
|
desc: >-
|
|
Maximum width (in pixels) of tabs (-1 for no maximum).
|
|
|
|
This setting only applies when tabs are horizontal.
|
|
|
|
This setting does not apply to pinned tabs, unless `tabs.pinned.shrink` is
|
|
False.
|
|
|
|
This setting may not apply properly if max_width is smaller than the
|
|
minimum size of tab contents, or smaller than tabs.min_width.
|
|
|
|
tabs.width.indicator:
|
|
renamed: tabs.indicator.width
|
|
|
|
tabs.indicator.width:
|
|
default: 3
|
|
type:
|
|
name: Int
|
|
minval: 0
|
|
desc: Width (in pixels) of the progress indicator (0 to disable).
|
|
|
|
tabs.indicator_padding:
|
|
renamed: tabs.indicator.padding
|
|
|
|
tabs.indicator.padding:
|
|
default:
|
|
top: 2
|
|
bottom: 2
|
|
left: 0
|
|
right: 4
|
|
type: Padding
|
|
desc: Padding (in pixels) for tab indicators.
|
|
|
|
tabs.width.pinned:
|
|
deleted: true
|
|
|
|
tabs.pinned.shrink:
|
|
default: true
|
|
type: Bool
|
|
desc: Shrink pinned tabs down to their contents.
|
|
|
|
tabs.pinned.frozen:
|
|
type: Bool
|
|
default: true
|
|
desc: Force pinned tabs to stay at fixed URL.
|
|
|
|
tabs.undo_stack_size:
|
|
default: 100
|
|
type:
|
|
name: Int
|
|
minval: -1
|
|
maxval: maxint
|
|
desc: Number of closed tabs (per window) and closed windows to remember for
|
|
:undo (-1 for no maximum).
|
|
|
|
tabs.wrap:
|
|
default: true
|
|
type: Bool
|
|
desc: Wrap when changing tabs.
|
|
|
|
tabs.focus_stack_size:
|
|
default: 10
|
|
type:
|
|
name: Int
|
|
minval: -1
|
|
maxval: maxint
|
|
zero_ok: false
|
|
desc: Maximum stack size to remember for tab switches (-1 for no maximum).
|
|
|
|
tabs.tooltips:
|
|
default: true
|
|
type: Bool
|
|
desc: >-
|
|
Show tooltips on tabs.
|
|
|
|
Note this setting only affects windows opened after it has been set.
|
|
|
|
## url
|
|
|
|
url.auto_search:
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- naive: Use simple/naive check.
|
|
- dns: Use DNS requests (might be slow!).
|
|
- never: Never search automatically.
|
|
- schemeless: Always search automatically unless URL explicitly contains
|
|
a scheme.
|
|
default: naive
|
|
desc: What search to start when something else than a URL is entered.
|
|
|
|
url.default_page:
|
|
type: FuzzyUrl
|
|
default: https://start.duckduckgo.com/
|
|
desc: >-
|
|
Page to open if :open -t/-b/-w is used without URL.
|
|
|
|
Use `about:blank` for a blank page.
|
|
|
|
url.incdec_segments:
|
|
type:
|
|
name: FlagList
|
|
valid_values: [host, port, path, query, anchor]
|
|
default: [path, query]
|
|
desc: URL segments where `:navigate increment/decrement` will search for
|
|
a number.
|
|
|
|
url.open_base_url:
|
|
type: Bool
|
|
default: false
|
|
desc: Open base URL of the searchengine if a searchengine shortcut is invoked
|
|
without parameters.
|
|
|
|
url.searchengines:
|
|
default:
|
|
DEFAULT: https://duckduckgo.com/?q={}
|
|
type:
|
|
name: Dict
|
|
required_keys: ['DEFAULT']
|
|
keytype:
|
|
name: String
|
|
forbidden: ' '
|
|
valtype: SearchEngineUrl
|
|
desc: |
|
|
Search engines which can be used via the address bar.
|
|
|
|
Maps a search engine name (such as `DEFAULT`, or `ddg`) to a URL with a
|
|
`{}` placeholder. The placeholder will be replaced by the search term, use
|
|
`{{` and `}}` for literal `{`/`}` braces.
|
|
|
|
The following further placeholds are defined to configure how special
|
|
characters in the search terms are replaced by safe characters (called
|
|
'quoting'):
|
|
|
|
* `{}` and `{semiquoted}` quote everything except slashes; this is the most
|
|
sensible choice for almost all search engines (for the search term
|
|
`slash/and&` this placeholder expands to `slash/and%26amp`).
|
|
* `{quoted}` quotes all characters (for `slash/and&` this placeholder
|
|
expands to `slash%2Fand%26amp`).
|
|
* `{unquoted}` quotes nothing (for `slash/and&` this placeholder
|
|
expands to `slash/and&`).
|
|
* `{0}` means the same as `{}`, but can be used multiple times.
|
|
|
|
The search engine named `DEFAULT` is used when `url.auto_search` is turned
|
|
on and something else than a URL was entered to be opened. Other search
|
|
engines can be used by prepending the search engine name to the search
|
|
term, e.g. `:open google qutebrowser`.
|
|
|
|
url.start_pages:
|
|
type:
|
|
name: ListOrValue
|
|
valtype: FuzzyUrl
|
|
default: ["https://start.duckduckgo.com"]
|
|
desc: Page(s) to open at the start.
|
|
|
|
url.yank_ignored_parameters:
|
|
type:
|
|
name: List
|
|
valtype: String
|
|
none_ok: true
|
|
default:
|
|
- ref
|
|
- utm_source
|
|
- utm_medium
|
|
- utm_campaign
|
|
- utm_term
|
|
- utm_content
|
|
- utm_name
|
|
desc: URL parameters to strip when yanking a URL.
|
|
|
|
## window
|
|
|
|
window.hide_wayland_decoration:
|
|
renamed: window.hide_decoration
|
|
|
|
window.hide_decoration:
|
|
type: Bool
|
|
default: false
|
|
desc: |
|
|
Hide the window decoration.
|
|
|
|
This setting requires a restart on Wayland.
|
|
|
|
window.title_format:
|
|
type:
|
|
name: FormatString
|
|
fields:
|
|
- perc
|
|
- perc_raw
|
|
- current_title
|
|
- title_sep
|
|
- id
|
|
- scroll_pos
|
|
- host
|
|
- backend
|
|
- private
|
|
- current_url
|
|
- protocol
|
|
- audio
|
|
default: '{perc}{current_title}{title_sep}qutebrowser'
|
|
desc: |
|
|
Format to use for the window title. The same placeholders like for
|
|
`tabs.title.format` are defined.
|
|
|
|
window.transparent:
|
|
type: Bool
|
|
default: false
|
|
desc: |
|
|
Set the main window background to transparent.
|
|
|
|
This allows having a transparent tab- or statusbar (might require a compositor such
|
|
as picom). However, it breaks some functionality such as dmenu embedding via its
|
|
`-w` option. On some systems, it was additionally reported that main window
|
|
transparency negatively affects performance.
|
|
|
|
Note this setting only affects windows opened after setting it.
|
|
|
|
## zoom
|
|
|
|
zoom.default:
|
|
type: Perc
|
|
default: 100%
|
|
desc: Default zoom level.
|
|
|
|
zoom.levels:
|
|
type:
|
|
name: List
|
|
valtype:
|
|
name: Perc
|
|
minval: 0
|
|
default:
|
|
- 25%
|
|
- 33%
|
|
- 50%
|
|
- 67%
|
|
- 75%
|
|
- 90%
|
|
- 100%
|
|
- 110%
|
|
- 125%
|
|
- 150%
|
|
- 175%
|
|
- 200%
|
|
- 250%
|
|
- 300%
|
|
- 400%
|
|
- 500%
|
|
desc: Available zoom levels.
|
|
|
|
zoom.mouse_divider:
|
|
default: 512
|
|
type:
|
|
name: Int
|
|
minval: 0
|
|
desc: Number of zoom increments to divide the mouse wheel movements to.
|
|
|
|
zoom.text_only:
|
|
type: Bool
|
|
default: false
|
|
backend: QtWebKit
|
|
supports_pattern: true
|
|
desc: Apply the zoom factor on a frame only to the text or to all content.
|
|
|
|
## colors
|
|
|
|
colors.completion.fg:
|
|
default: ["white", "white", "white"]
|
|
type:
|
|
name: ListOrValue
|
|
valtype: QtColor
|
|
desc: >-
|
|
Text color of the completion widget.
|
|
|
|
May be a single color to use for all columns or a list of three colors,
|
|
one for each column.
|
|
|
|
colors.completion.odd.bg:
|
|
default: '#444444'
|
|
type: QssColor
|
|
desc: Background color of the completion widget for odd rows.
|
|
|
|
colors.completion.even.bg:
|
|
default: '#333333'
|
|
type: QssColor
|
|
desc: Background color of the completion widget for even rows.
|
|
|
|
colors.completion.category.fg:
|
|
default: white
|
|
type: QtColor
|
|
desc: Foreground color of completion widget category headers.
|
|
|
|
colors.completion.category.bg:
|
|
default: 'qlineargradient(x1:0, y1:0, x2:0, y2:1, stop:0 #888888,
|
|
stop:1 #505050)'
|
|
type: QssColor
|
|
desc: Background color of the completion widget category headers.
|
|
|
|
colors.completion.category.border.top:
|
|
default: black
|
|
type: QssColor
|
|
desc: Top border color of the completion widget category headers.
|
|
|
|
colors.completion.category.border.bottom:
|
|
default: black
|
|
type: QssColor
|
|
desc: Bottom border color of the completion widget category headers.
|
|
|
|
colors.completion.item.selected.fg:
|
|
default: black
|
|
type: QtColor
|
|
desc: Foreground color of the selected completion item.
|
|
|
|
colors.completion.item.selected.bg:
|
|
default: '#e8c000'
|
|
type: QssColor
|
|
desc: Background color of the selected completion item.
|
|
|
|
colors.completion.item.selected.border.top:
|
|
default: '#bbbb00'
|
|
type: QssColor
|
|
desc: Top border color of the selected completion item.
|
|
|
|
colors.completion.item.selected.border.bottom:
|
|
default: '#bbbb00'
|
|
type: QssColor
|
|
desc: Bottom border color of the selected completion item.
|
|
|
|
colors.completion.item.selected.match.fg:
|
|
default: '#ff4444'
|
|
type: QtColor
|
|
desc: Foreground color of the matched text in the selected completion item.
|
|
|
|
colors.completion.match.fg:
|
|
default: '#ff4444'
|
|
type: QtColor
|
|
desc: Foreground color of the matched text in the completion.
|
|
|
|
colors.completion.scrollbar.fg:
|
|
default: white
|
|
type: QssColor
|
|
desc: Color of the scrollbar handle in the completion view.
|
|
|
|
colors.completion.scrollbar.bg:
|
|
default: '#333333'
|
|
type: QssColor
|
|
desc: Color of the scrollbar in the completion view.
|
|
|
|
colors.contextmenu.bg:
|
|
renamed: colors.contextmenu.menu.bg
|
|
|
|
colors.contextmenu.fg:
|
|
renamed: colors.contextmenu.menu.fg
|
|
|
|
colors.tooltip.bg:
|
|
type:
|
|
name: QssColor
|
|
none_ok: true
|
|
default: null
|
|
desc: >-
|
|
Background color of tooltips.
|
|
|
|
If set to null, the Qt default is used.
|
|
|
|
colors.tooltip.fg:
|
|
type:
|
|
name: QssColor
|
|
none_ok: true
|
|
default: null
|
|
desc: >-
|
|
Foreground color of tooltips.
|
|
|
|
If set to null, the Qt default is used.
|
|
|
|
colors.contextmenu.menu.bg:
|
|
type:
|
|
name: QssColor
|
|
none_ok: true
|
|
default: null
|
|
desc: >-
|
|
Background color of the context menu.
|
|
|
|
If set to null, the Qt default is used.
|
|
|
|
colors.contextmenu.menu.fg:
|
|
type:
|
|
name: QssColor
|
|
none_ok: true
|
|
default: null
|
|
desc: >-
|
|
Foreground color of the context menu.
|
|
|
|
If set to null, the Qt default is used.
|
|
|
|
colors.contextmenu.selected.bg:
|
|
type:
|
|
name: QssColor
|
|
none_ok: true
|
|
default: null
|
|
desc: >-
|
|
Background color of the context menu's selected item.
|
|
|
|
If set to null, the Qt default is used.
|
|
|
|
colors.contextmenu.selected.fg:
|
|
type:
|
|
name: QssColor
|
|
none_ok: true
|
|
default: null
|
|
desc: >-
|
|
Foreground color of the context menu's selected item.
|
|
|
|
If set to null, the Qt default is used.
|
|
|
|
colors.contextmenu.disabled.bg:
|
|
type:
|
|
name: QssColor
|
|
none_ok: true
|
|
default: null
|
|
desc: >-
|
|
Background color of disabled items in the context menu.
|
|
|
|
If set to null, the Qt default is used.
|
|
|
|
colors.contextmenu.disabled.fg:
|
|
type:
|
|
name: QssColor
|
|
none_ok: true
|
|
default: null
|
|
desc: >-
|
|
Foreground color of disabled items in the context menu.
|
|
|
|
If set to null, the Qt default is used.
|
|
|
|
colors.downloads.bar.bg:
|
|
default: black
|
|
type: QssColor
|
|
desc: Background color for the download bar.
|
|
|
|
colors.downloads.start.fg:
|
|
default: white
|
|
type: QtColor
|
|
desc: Color gradient start for download text.
|
|
|
|
colors.downloads.start.bg:
|
|
default: '#0000aa'
|
|
type: QtColor
|
|
desc: Color gradient start for download backgrounds.
|
|
|
|
colors.downloads.stop.fg:
|
|
default: white
|
|
type: QtColor
|
|
desc: Color gradient end for download text.
|
|
|
|
colors.downloads.stop.bg:
|
|
default: '#00aa00'
|
|
type: QtColor
|
|
desc: Color gradient stop for download backgrounds.
|
|
|
|
colors.downloads.system.fg:
|
|
default: rgb
|
|
type: ColorSystem
|
|
desc: Color gradient interpolation system for download text.
|
|
|
|
colors.downloads.system.bg:
|
|
default: rgb
|
|
type: ColorSystem
|
|
desc: Color gradient interpolation system for download backgrounds.
|
|
|
|
colors.downloads.error.fg:
|
|
default: white
|
|
type: QtColor
|
|
desc: Foreground color for downloads with errors.
|
|
|
|
colors.downloads.error.bg:
|
|
default: red
|
|
type: QtColor
|
|
desc: Background color for downloads with errors.
|
|
|
|
colors.hints.fg:
|
|
default: black
|
|
type: QssColor
|
|
desc: Font color for hints.
|
|
|
|
colors.hints.bg:
|
|
default: qlineargradient(x1:0, y1:0, x2:0, y2:1,
|
|
stop:0 rgba(255, 247, 133, 0.8), stop:1 rgba(255, 197, 66, 0.8))
|
|
type: QssColor
|
|
desc: >-
|
|
Background color for hints.
|
|
|
|
Note that you can use a `rgba(...)` value for transparency.
|
|
|
|
colors.hints.match.fg:
|
|
default: green
|
|
type: QtColor
|
|
desc: Font color for the matched part of hints.
|
|
|
|
colors.keyhint.fg:
|
|
default: '#FFFFFF'
|
|
type: QssColor
|
|
desc: Text color for the keyhint widget.
|
|
|
|
colors.keyhint.suffix.fg:
|
|
default: '#FFFF00'
|
|
type: QssColor
|
|
desc: Highlight color for keys to complete the current keychain.
|
|
|
|
colors.keyhint.bg:
|
|
default: rgba(0, 0, 0, 80%)
|
|
type: QssColor
|
|
desc: Background color of the keyhint widget.
|
|
|
|
colors.messages.error.fg:
|
|
default: white
|
|
type: QssColor
|
|
desc: Foreground color of an error message.
|
|
|
|
colors.messages.error.bg:
|
|
default: red
|
|
type: QssColor
|
|
desc: Background color of an error message.
|
|
|
|
colors.messages.error.border:
|
|
default: '#bb0000'
|
|
type: QssColor
|
|
desc: Border color of an error message.
|
|
|
|
colors.messages.warning.fg:
|
|
default: black
|
|
type: QssColor
|
|
desc: Foreground color of a warning message.
|
|
|
|
colors.messages.warning.bg:
|
|
default: darkorange
|
|
type: QssColor
|
|
desc: Background color of a warning message.
|
|
|
|
colors.messages.warning.border:
|
|
default: '#d47300'
|
|
type: QssColor
|
|
desc: Border color of a warning message.
|
|
|
|
colors.messages.info.fg:
|
|
default: white
|
|
type: QssColor
|
|
desc: Foreground color of an info message.
|
|
|
|
colors.messages.info.bg:
|
|
default: black
|
|
type: QssColor
|
|
desc: Background color of an info message.
|
|
|
|
colors.messages.info.border:
|
|
default: '#333333'
|
|
type: QssColor
|
|
desc: Border color of an info message.
|
|
|
|
colors.prompts.fg:
|
|
default: white
|
|
type: QssColor
|
|
desc: Foreground color for prompts.
|
|
|
|
colors.prompts.border:
|
|
default: 1px solid gray
|
|
type: String
|
|
desc: Border used around UI elements in prompts.
|
|
|
|
colors.prompts.bg:
|
|
default: '#444444'
|
|
type: QssColor
|
|
desc: Background color for prompts.
|
|
|
|
colors.prompts.selected.fg:
|
|
default: white
|
|
type: QssColor
|
|
desc: Foreground color for the selected item in filename prompts.
|
|
|
|
colors.prompts.selected.bg:
|
|
default: grey
|
|
type: QssColor
|
|
desc: Background color for the selected item in filename prompts.
|
|
|
|
colors.statusbar.normal.fg:
|
|
default: white
|
|
type: QssColor
|
|
desc: Foreground color of the statusbar.
|
|
|
|
colors.statusbar.normal.bg:
|
|
default: black
|
|
type: QssColor
|
|
desc: Background color of the statusbar.
|
|
|
|
colors.statusbar.insert.fg:
|
|
default: white
|
|
type: QssColor
|
|
desc: Foreground color of the statusbar in insert mode.
|
|
|
|
colors.statusbar.insert.bg:
|
|
default: darkgreen
|
|
type: QssColor
|
|
desc: Background color of the statusbar in insert mode.
|
|
|
|
colors.statusbar.passthrough.fg:
|
|
default: white
|
|
type: QssColor
|
|
desc: Foreground color of the statusbar in passthrough mode.
|
|
|
|
colors.statusbar.passthrough.bg:
|
|
default: darkblue
|
|
type: QssColor
|
|
desc: Background color of the statusbar in passthrough mode.
|
|
|
|
colors.statusbar.private.fg:
|
|
default: white
|
|
type: QssColor
|
|
desc: Foreground color of the statusbar in private browsing mode.
|
|
|
|
colors.statusbar.private.bg:
|
|
default: '#666666'
|
|
type: QssColor
|
|
desc: Background color of the statusbar in private browsing mode.
|
|
|
|
colors.statusbar.command.fg:
|
|
default: white
|
|
type: QssColor
|
|
desc: Foreground color of the statusbar in command mode.
|
|
|
|
colors.statusbar.command.bg:
|
|
default: black
|
|
type: QssColor
|
|
desc: Background color of the statusbar in command mode.
|
|
|
|
colors.statusbar.command.private.fg:
|
|
default: white
|
|
type: QssColor
|
|
desc: Foreground color of the statusbar in private browsing + command mode.
|
|
|
|
colors.statusbar.command.private.bg:
|
|
default: darkslategray
|
|
type: QssColor
|
|
desc: Background color of the statusbar in private browsing + command mode.
|
|
|
|
colors.statusbar.caret.fg:
|
|
default: white
|
|
type: QssColor
|
|
desc: Foreground color of the statusbar in caret mode.
|
|
|
|
colors.statusbar.caret.bg:
|
|
default: purple
|
|
type: QssColor
|
|
desc: Background color of the statusbar in caret mode.
|
|
|
|
colors.statusbar.caret.selection.fg:
|
|
default: white
|
|
type: QssColor
|
|
desc: Foreground color of the statusbar in caret mode with a selection.
|
|
|
|
colors.statusbar.caret.selection.bg:
|
|
default: '#a12dff'
|
|
type: QssColor
|
|
desc: Background color of the statusbar in caret mode with a selection.
|
|
|
|
colors.statusbar.progress.bg:
|
|
default: white
|
|
type: QssColor
|
|
desc: Background color of the progress bar.
|
|
|
|
colors.statusbar.url.fg:
|
|
default: white
|
|
type: QssColor
|
|
desc: Default foreground color of the URL in the statusbar.
|
|
|
|
colors.statusbar.url.error.fg:
|
|
default: orange
|
|
type: QssColor
|
|
desc: Foreground color of the URL in the statusbar on error.
|
|
|
|
colors.statusbar.url.hover.fg:
|
|
default: aqua
|
|
type: QssColor
|
|
desc: Foreground color of the URL in the statusbar for hovered links.
|
|
|
|
colors.statusbar.url.success.http.fg:
|
|
default: white
|
|
type: QssColor
|
|
desc: Foreground color of the URL in the statusbar on successful load (http).
|
|
|
|
colors.statusbar.url.success.https.fg:
|
|
default: lime
|
|
type: QssColor
|
|
desc: Foreground color of the URL in the statusbar on successful load
|
|
(https).
|
|
|
|
colors.statusbar.url.warn.fg:
|
|
default: yellow
|
|
type: QssColor
|
|
desc: "Foreground color of the URL in the statusbar when there's a warning."
|
|
|
|
colors.tabs.bar.bg:
|
|
default: '#555555'
|
|
type: QssColor
|
|
desc: Background color of the tab bar.
|
|
|
|
colors.tabs.indicator.start:
|
|
default: '#0000aa'
|
|
type: QtColor
|
|
desc: Color gradient start for the tab indicator.
|
|
|
|
colors.tabs.indicator.stop:
|
|
default: '#00aa00'
|
|
type: QtColor
|
|
desc: Color gradient end for the tab indicator.
|
|
|
|
colors.tabs.indicator.error:
|
|
default: '#ff0000'
|
|
type: QtColor
|
|
desc: Color for the tab indicator on errors.
|
|
|
|
colors.tabs.indicator.system:
|
|
default: rgb
|
|
type: ColorSystem
|
|
desc: Color gradient interpolation system for the tab indicator.
|
|
|
|
colors.tabs.odd.fg:
|
|
default: white
|
|
type: QtColor
|
|
desc: Foreground color of unselected odd tabs.
|
|
|
|
colors.tabs.odd.bg:
|
|
default: grey
|
|
type: QtColor
|
|
desc: Background color of unselected odd tabs.
|
|
|
|
colors.tabs.even.fg:
|
|
default: white
|
|
type: QtColor
|
|
desc: Foreground color of unselected even tabs.
|
|
|
|
colors.tabs.even.bg:
|
|
default: darkgrey
|
|
type: QtColor
|
|
desc: Background color of unselected even tabs.
|
|
|
|
colors.tabs.selected.odd.fg:
|
|
default: white
|
|
type: QtColor
|
|
desc: Foreground color of selected odd tabs.
|
|
|
|
colors.tabs.selected.odd.bg:
|
|
default: black
|
|
type: QtColor
|
|
desc: Background color of selected odd tabs.
|
|
|
|
colors.tabs.selected.even.fg:
|
|
default: white
|
|
type: QtColor
|
|
desc: Foreground color of selected even tabs.
|
|
|
|
colors.tabs.selected.even.bg:
|
|
default: black
|
|
type: QtColor
|
|
desc: Background color of selected even tabs.
|
|
|
|
colors.tabs.pinned.odd.fg:
|
|
default: white
|
|
type: QtColor
|
|
desc: Foreground color of pinned unselected odd tabs.
|
|
|
|
colors.tabs.pinned.odd.bg:
|
|
default: seagreen
|
|
type: QtColor
|
|
desc: Background color of pinned unselected odd tabs.
|
|
|
|
colors.tabs.pinned.even.fg:
|
|
default: white
|
|
type: QtColor
|
|
desc: Foreground color of pinned unselected even tabs.
|
|
|
|
colors.tabs.pinned.even.bg:
|
|
default: darkseagreen
|
|
type: QtColor
|
|
desc: Background color of pinned unselected even tabs.
|
|
|
|
colors.tabs.pinned.selected.odd.fg:
|
|
default: white
|
|
type: QtColor
|
|
desc: Foreground color of pinned selected odd tabs.
|
|
|
|
colors.tabs.pinned.selected.odd.bg:
|
|
default: black
|
|
type: QtColor
|
|
desc: Background color of pinned selected odd tabs.
|
|
|
|
colors.tabs.pinned.selected.even.fg:
|
|
default: white
|
|
type: QtColor
|
|
desc: Foreground color of pinned selected even tabs.
|
|
|
|
colors.tabs.pinned.selected.even.bg:
|
|
default: black
|
|
type: QtColor
|
|
desc: Background color of pinned selected even tabs.
|
|
|
|
colors.webpage.bg:
|
|
default: white
|
|
type:
|
|
name: QtColor
|
|
none_ok: true
|
|
desc: "Background color for webpages if unset (or empty to use the theme's
|
|
color)."
|
|
|
|
colors.webpage.preferred_color_scheme:
|
|
default: auto
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- auto: Use the system-wide color scheme setting.
|
|
- light: Force a light theme.
|
|
- dark: Force a dark theme.
|
|
desc: >-
|
|
Value to use for `prefers-color-scheme:` for websites.
|
|
|
|
The "light" value is only available with QtWebEngine 5.15.2+. On older versions, it
|
|
is the same as "auto".
|
|
|
|
The "auto" value is broken on QtWebEngine 5.15.2 due to a Qt bug. There, it will
|
|
fall back to "light" unconditionally.
|
|
backend: QtWebEngine
|
|
restart: true
|
|
|
|
## dark mode
|
|
|
|
colors.webpage.darkmode.enabled:
|
|
default: false
|
|
type: Bool
|
|
desc: >-
|
|
Render all web contents using a dark theme.
|
|
|
|
On QtWebEngine < 6.7, this setting requires a restart and does not support
|
|
URL patterns, only the global setting is applied.
|
|
|
|
Example configurations from Chromium's `chrome://flags`:
|
|
|
|
- "With simple HSL/CIELAB/RGB-based inversion": Set
|
|
`colors.webpage.darkmode.algorithm` accordingly, and
|
|
set `colors.webpage.darkmode.policy.images` to `never`.
|
|
|
|
- "With selective image inversion": qutebrowser default settings.
|
|
supports_pattern: true
|
|
backend: QtWebEngine
|
|
|
|
colors.webpage.darkmode.algorithm:
|
|
default: lightness-cielab
|
|
desc: >-
|
|
Which algorithm to use for modifying how colors are rendered with dark mode.
|
|
|
|
The `lightness-cielab` value was added with QtWebEngine 5.14 and is treated
|
|
like `lightness-hsl` with older QtWebEngine versions.
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- lightness-cielab: Modify colors by converting them to CIELAB color
|
|
space and inverting the L value. Not available with Qt < 5.14.
|
|
- lightness-hsl: Modify colors by converting them to the HSL color space
|
|
and inverting the lightness (i.e. the "L" in HSL).
|
|
- brightness-rgb: Modify colors by subtracting each of r, g, and b from
|
|
their maximum value.
|
|
# kSimpleInvertForTesting is not exposed, as it's equivalent to
|
|
# kInvertBrightness without gamma correction, and only available for
|
|
# Chromium's automated tests
|
|
restart: true
|
|
backend: QtWebEngine
|
|
|
|
colors.webpage.darkmode.contrast:
|
|
default: 0.0
|
|
type:
|
|
name: Float
|
|
minval: -1.0
|
|
maxval: 1.0
|
|
desc: >-
|
|
Contrast for dark mode.
|
|
|
|
This only has an effect when `colors.webpage.darkmode.algorithm` is set to
|
|
`lightness-hsl` or `brightness-rgb`.
|
|
restart: true
|
|
backend: QtWebEngine
|
|
|
|
colors.webpage.darkmode.policy.images:
|
|
default: smart
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- always: Apply dark mode filter to all images.
|
|
- never: Never apply dark mode filter to any images.
|
|
- smart: "Apply dark mode based on image content. Not available with Qt
|
|
5.15.0."
|
|
- smart-simple: "On QtWebEngine 6.6, use a simpler algorithm for smart mode (based
|
|
on numbers of colors and transparency), rather than an ML-based model.
|
|
Same as 'smart' on older QtWebEnigne versions."
|
|
desc: >-
|
|
Which images to apply dark mode to.
|
|
restart: true
|
|
backend: QtWebEngine
|
|
|
|
colors.webpage.darkmode.policy.page:
|
|
default: smart
|
|
type:
|
|
name: String
|
|
valid_values:
|
|
- always: Apply dark mode filter to all frames, regardless of content.
|
|
- smart: Apply dark mode filter to frames based on background color.
|
|
desc: >-
|
|
Which pages to apply dark mode to.
|
|
|
|
The underlying Chromium setting has been removed in QtWebEngine 5.15.3, thus this
|
|
setting is ignored there. Instead, every element is now classified individually.
|
|
restart: true
|
|
backend: QtWebEngine
|
|
|
|
colors.webpage.darkmode.threshold.text:
|
|
renamed: colors.webpage.darkmode.threshold.foreground
|
|
|
|
colors.webpage.darkmode.threshold.foreground:
|
|
default: 256
|
|
type:
|
|
name: Int
|
|
minval: 0
|
|
maxval: 256
|
|
desc: >-
|
|
Threshold for inverting text with dark mode.
|
|
|
|
Text colors with brightness below this threshold will be inverted, and
|
|
above it will be left as in the original, non-dark-mode page. Set to 256
|
|
to always invert text color or to 0 to never invert text color.
|
|
restart: true
|
|
backend: QtWebEngine
|
|
|
|
colors.webpage.darkmode.threshold.background:
|
|
default: 0
|
|
type:
|
|
name: Int
|
|
minval: 0
|
|
maxval: 256
|
|
desc: >-
|
|
Threshold for inverting background elements with dark mode.
|
|
|
|
Background elements with brightness above this threshold will be inverted,
|
|
and below it will be left as in the original, non-dark-mode page. Set to
|
|
256 to never invert the color or to 0 to always invert it.
|
|
|
|
Note: This behavior is the opposite of
|
|
`colors.webpage.darkmode.threshold.foreground`!
|
|
restart: true
|
|
backend: QtWebEngine
|
|
|
|
# emacs: '
|
|
|
|
## fonts
|
|
|
|
fonts.default_family:
|
|
default: []
|
|
type:
|
|
name: ListOrValue
|
|
valtype: Font
|
|
none_ok: true
|
|
desc: >-
|
|
Default font families to use.
|
|
|
|
Whenever "default_family" is used in a font setting, it's replaced with the
|
|
fonts listed here.
|
|
|
|
If set to an empty value, a system-specific monospace default is used.
|
|
|
|
fonts.default_size:
|
|
default: 10pt
|
|
type:
|
|
name: String
|
|
regex: '(?P<size>[0-9]+((\.[0-9]+)?[pP][tT]|[pP][xX]))'
|
|
desc: >-
|
|
Default font size to use.
|
|
|
|
Whenever "default_size" is used in a font setting, it's replaced with the
|
|
size listed here.
|
|
|
|
Valid values are either a float value with a "pt" suffix, or an integer
|
|
value with a "px" suffix.
|
|
|
|
fonts.completion.entry:
|
|
default: default_size default_family
|
|
type: Font
|
|
desc: Font used in the completion widget.
|
|
|
|
fonts.completion.category:
|
|
default: bold default_size default_family
|
|
type: Font
|
|
desc: Font used in the completion categories.
|
|
|
|
fonts.tooltip:
|
|
type:
|
|
name: Font
|
|
none_ok: true
|
|
default: null
|
|
desc: >-
|
|
Font used for tooltips.
|
|
|
|
If set to null, the Qt default is used.
|
|
|
|
fonts.contextmenu:
|
|
type:
|
|
name: Font
|
|
none_ok: true
|
|
default: null
|
|
desc: >-
|
|
Font used for the context menu.
|
|
|
|
If set to null, the Qt default is used.
|
|
|
|
fonts.debug_console:
|
|
default: default_size default_family
|
|
type: Font
|
|
desc: Font used for the debugging console.
|
|
|
|
fonts.downloads:
|
|
default: default_size default_family
|
|
type: Font
|
|
desc: Font used for the downloadbar.
|
|
|
|
fonts.hints:
|
|
default: bold default_size default_family
|
|
type: Font
|
|
desc: Font used for the hints.
|
|
|
|
fonts.keyhint:
|
|
default: default_size default_family
|
|
type: Font
|
|
desc: Font used in the keyhint widget.
|
|
|
|
fonts.messages.error:
|
|
default: default_size default_family
|
|
type: Font
|
|
desc: Font used for error messages.
|
|
|
|
fonts.messages.info:
|
|
default: default_size default_family
|
|
type: Font
|
|
desc: Font used for info messages.
|
|
|
|
fonts.messages.warning:
|
|
default: default_size default_family
|
|
type: Font
|
|
desc: Font used for warning messages.
|
|
|
|
fonts.prompts:
|
|
default: default_size sans-serif
|
|
type: Font
|
|
desc: Font used for prompts.
|
|
|
|
fonts.statusbar:
|
|
default: default_size default_family
|
|
type: Font
|
|
desc: Font used in the statusbar.
|
|
|
|
fonts.tabs.selected:
|
|
default: default_size default_family
|
|
type: Font
|
|
desc: Font used for selected tabs.
|
|
|
|
fonts.tabs.unselected:
|
|
default: default_size default_family
|
|
type: Font
|
|
desc: Font used for unselected tabs.
|
|
|
|
fonts.web.family.standard:
|
|
default: ''
|
|
supports_pattern: true
|
|
type:
|
|
name: FontFamily
|
|
none_ok: true
|
|
desc: Font family for standard fonts.
|
|
|
|
fonts.web.family.fixed:
|
|
default: ''
|
|
supports_pattern: true
|
|
type:
|
|
name: FontFamily
|
|
none_ok: true
|
|
desc: Font family for fixed fonts.
|
|
|
|
fonts.web.family.serif:
|
|
default: ''
|
|
supports_pattern: true
|
|
type:
|
|
name: FontFamily
|
|
none_ok: true
|
|
desc: Font family for serif fonts.
|
|
|
|
fonts.web.family.sans_serif:
|
|
default: ''
|
|
supports_pattern: true
|
|
type:
|
|
name: FontFamily
|
|
none_ok: true
|
|
desc: Font family for sans-serif fonts.
|
|
|
|
fonts.web.family.cursive:
|
|
default: ''
|
|
supports_pattern: true
|
|
type:
|
|
name: FontFamily
|
|
none_ok: true
|
|
desc: Font family for cursive fonts.
|
|
|
|
fonts.web.family.fantasy:
|
|
default: ''
|
|
supports_pattern: true
|
|
type:
|
|
name: FontFamily
|
|
none_ok: true
|
|
desc: Font family for fantasy fonts.
|
|
|
|
# Defaults for web_size_* from WebEngineSettings::initDefaults in
|
|
# qtwebengine/src/core/web_engine_settings.cpp and
|
|
# QWebSettings::QWebSettings() in
|
|
# qtwebkit/Source/WebKit/qt/Api/qwebsettings.cpp
|
|
|
|
fonts.web.size.default:
|
|
default: 16
|
|
supports_pattern: true
|
|
type:
|
|
name: Int
|
|
minval: 1
|
|
maxval: maxint
|
|
desc: Default font size (in pixels) for regular text.
|
|
|
|
fonts.web.size.default_fixed:
|
|
default: 13
|
|
supports_pattern: true
|
|
type:
|
|
name: Int
|
|
minval: 1
|
|
maxval: maxint
|
|
desc: Default font size (in pixels) for fixed-pitch text.
|
|
|
|
fonts.web.size.minimum:
|
|
default: 0
|
|
supports_pattern: true
|
|
type:
|
|
name: Int
|
|
minval: 0
|
|
maxval: maxint
|
|
desc: Hard minimum font size (in pixels).
|
|
|
|
fonts.web.size.minimum_logical:
|
|
# This is 0 as default on QtWebKit, and 6 on QtWebEngine - so let's
|
|
# just go for 6 here.
|
|
default: 6
|
|
supports_pattern: true
|
|
type:
|
|
name: Int
|
|
minval: 0
|
|
maxval: maxint
|
|
desc: Minimum logical font size (in pixels) that is applied when zooming out.
|
|
|
|
## keybindings
|
|
|
|
bindings.key_mappings:
|
|
default:
|
|
<Ctrl-[>: <Escape>
|
|
<Ctrl-6>: <Ctrl-^>
|
|
<Ctrl-M>: <Return>
|
|
<Ctrl-J>: <Return>
|
|
<Ctrl-I>: <Tab>
|
|
<Shift-Return>: <Return>
|
|
<Enter>: <Return>
|
|
<Shift-Enter>: <Return>
|
|
<Ctrl-Enter>: <Ctrl-Return>
|
|
type:
|
|
name: Dict
|
|
none_ok: true
|
|
keytype: Key
|
|
valtype: Key
|
|
desc: >-
|
|
Map keys to other keys, so that they are equivalent in all modes.
|
|
|
|
When the key used as dictionary-key is pressed, the binding for the key
|
|
used as dictionary-value is invoked instead.
|
|
|
|
This is useful for global remappings of keys, for example to map <Ctrl-[> to
|
|
<Escape>.
|
|
|
|
NOTE: This should only be used if two keys should always be equivalent, i.e. for
|
|
things like <Enter> (keypad) and <Return> (non-keypad). For normal command bindings,
|
|
qutebrowser works differently to vim: You always bind keys to commands, usually via
|
|
`:bind` or `config.bind()`. Instead of using this setting, consider finding the
|
|
command a key is bound to (e.g. via `:bind gg`) and then binding the same command to
|
|
the desired key.
|
|
|
|
Note that when a key is bound (via `bindings.default` or
|
|
`bindings.commands`), the mapping is ignored.
|
|
|
|
bindings.default:
|
|
no_autoconfig: true
|
|
default:
|
|
normal:
|
|
<Escape>: clear-keychain ;; search ;; fullscreen --leave
|
|
o: cmd-set-text -s :open
|
|
go: cmd-set-text :open {url:pretty}
|
|
O: cmd-set-text -s :open -t
|
|
gO: cmd-set-text :open -t -r {url:pretty}
|
|
xo: cmd-set-text -s :open -b
|
|
xO: cmd-set-text :open -b -r {url:pretty}
|
|
wo: cmd-set-text -s :open -w
|
|
wO: cmd-set-text :open -w {url:pretty}
|
|
/: cmd-set-text /
|
|
?: cmd-set-text ?
|
|
":": "cmd-set-text :"
|
|
ga: open -t
|
|
<Ctrl-T>: open -t
|
|
<Ctrl-N>: open -w
|
|
<Ctrl-Shift-N>: open -p
|
|
d: tab-close
|
|
<Ctrl-W>: tab-close
|
|
<Ctrl-Shift-W>: close
|
|
D: tab-close -o
|
|
co: tab-only
|
|
T: cmd-set-text -sr :tab-focus
|
|
gm: tab-move
|
|
gK: tab-move -
|
|
gJ: tab-move +
|
|
J: tab-next
|
|
<Ctrl-PgDown>: tab-next
|
|
K: tab-prev
|
|
<Ctrl-PgUp>: tab-prev
|
|
gC: tab-clone
|
|
r: reload
|
|
<F5>: reload
|
|
R: reload -f
|
|
<Ctrl-F5>: reload -f
|
|
H: back
|
|
<back>: back
|
|
th: back -t
|
|
wh: back -w
|
|
L: forward
|
|
<forward>: forward
|
|
tl: forward -t
|
|
wl: forward -w
|
|
<F11>: fullscreen
|
|
f: hint
|
|
F: hint all tab
|
|
wf: hint all window
|
|
;b: hint all tab-bg
|
|
;f: hint all tab-fg
|
|
;h: hint all hover
|
|
;i: hint images
|
|
;I: hint images tab
|
|
;o: hint links fill :open {hint-url}
|
|
;O: hint links fill :open -t -r {hint-url}
|
|
;y: hint links yank
|
|
;Y: hint links yank-primary
|
|
;r: hint --rapid links tab-bg
|
|
;R: hint --rapid links window
|
|
;d: hint links download
|
|
;t: hint inputs
|
|
gi: hint inputs --first
|
|
h: scroll left
|
|
j: scroll down
|
|
k: scroll up
|
|
l: scroll right
|
|
u: undo
|
|
U: undo -w
|
|
<Ctrl-Shift-T>: undo
|
|
gg: scroll-to-perc 0
|
|
G: scroll-to-perc
|
|
n: search-next
|
|
N: search-prev
|
|
i: mode-enter insert
|
|
v: mode-enter caret
|
|
V: mode-enter caret ;; selection-toggle --line
|
|
"`": mode-enter set_mark
|
|
"'": mode-enter jump_mark
|
|
yy: yank
|
|
yY: yank -s
|
|
yt: yank title
|
|
yT: yank title -s
|
|
yd: yank domain
|
|
yD: yank domain -s
|
|
yp: yank pretty-url
|
|
yP: yank pretty-url -s
|
|
ym: yank inline [{title}]({url:yank})
|
|
yM: yank inline [{title}]({url:yank}) -s
|
|
pp: open -- {clipboard}
|
|
pP: open -- {primary}
|
|
Pp: open -t -- {clipboard}
|
|
PP: open -t -- {primary}
|
|
wp: open -w -- {clipboard}
|
|
wP: open -w -- {primary}
|
|
m: quickmark-save
|
|
b: cmd-set-text -s :quickmark-load
|
|
B: cmd-set-text -s :quickmark-load -t
|
|
wb: cmd-set-text -s :quickmark-load -w
|
|
M: bookmark-add
|
|
gb: cmd-set-text -s :bookmark-load
|
|
gB: cmd-set-text -s :bookmark-load -t
|
|
wB: cmd-set-text -s :bookmark-load -w
|
|
sf: save
|
|
ss: cmd-set-text -s :set
|
|
sl: cmd-set-text -s :set -t
|
|
sk: cmd-set-text -s :bind
|
|
-: zoom-out
|
|
+: zoom-in
|
|
=: zoom
|
|
"[[": navigate prev
|
|
"]]": navigate next
|
|
"{{": navigate prev -t
|
|
"}}": navigate next -t
|
|
gu: navigate up
|
|
gU: navigate up -t
|
|
<Ctrl-A>: navigate increment
|
|
<Ctrl-X>: navigate decrement
|
|
wi: devtools
|
|
wIh: devtools left
|
|
wIj: devtools bottom
|
|
wIk: devtools top
|
|
wIl: devtools right
|
|
wIw: devtools window
|
|
wIf: devtools-focus
|
|
gd: download
|
|
ad: download-cancel
|
|
cd: download-clear
|
|
gf: view-source
|
|
gt: cmd-set-text -s :tab-select
|
|
<Ctrl-Tab>: tab-focus last
|
|
<Ctrl-Shift-Tab>: nop
|
|
<Ctrl-^>: tab-focus last
|
|
<Ctrl-V>: mode-enter passthrough
|
|
<Ctrl-Q>: quit
|
|
ZQ: quit
|
|
ZZ: quit --save
|
|
<Ctrl-F>: scroll-page 0 1
|
|
<Ctrl-B>: scroll-page 0 -1
|
|
<Ctrl-D>: scroll-page 0 0.5
|
|
<Ctrl-U>: scroll-page 0 -0.5
|
|
<Alt-1>: tab-focus 1
|
|
g0: tab-focus 1
|
|
g^: tab-focus 1
|
|
<Alt-2>: tab-focus 2
|
|
<Alt-3>: tab-focus 3
|
|
<Alt-4>: tab-focus 4
|
|
<Alt-5>: tab-focus 5
|
|
<Alt-6>: tab-focus 6
|
|
<Alt-7>: tab-focus 7
|
|
<Alt-8>: tab-focus 8
|
|
<Alt-9>: tab-focus -1
|
|
g$: tab-focus -1
|
|
<Ctrl-h>: home
|
|
<Ctrl-s>: stop
|
|
<Ctrl-Alt-p>: print
|
|
Ss: set
|
|
Sb: bookmark-list --jump
|
|
Sq: bookmark-list
|
|
Sh: history
|
|
<Return>: selection-follow
|
|
<Ctrl-Return>: selection-follow -t
|
|
.: cmd-repeat-last
|
|
<Ctrl-p>: tab-pin
|
|
<Alt-m>: tab-mute
|
|
gD: tab-give
|
|
q: macro-record
|
|
"@": macro-run
|
|
tsh: config-cycle -p -t -u *://{url:host}/* content.javascript.enabled
|
|
;; reload
|
|
tSh: config-cycle -p -u *://{url:host}/* content.javascript.enabled
|
|
;; reload
|
|
tsH: config-cycle -p -t -u *://*.{url:host}/* content.javascript.enabled
|
|
;; reload
|
|
tSH: config-cycle -p -u *://*.{url:host}/* content.javascript.enabled
|
|
;; reload
|
|
tsu: config-cycle -p -t -u {url} content.javascript.enabled ;; reload
|
|
tSu: config-cycle -p -u {url} content.javascript.enabled ;; reload
|
|
tph: config-cycle -p -t -u *://{url:host}/* content.plugins ;; reload
|
|
tPh: config-cycle -p -u *://{url:host}/* content.plugins ;; reload
|
|
tpH: config-cycle -p -t -u *://*.{url:host}/* content.plugins ;; reload
|
|
tPH: config-cycle -p -u *://*.{url:host}/* content.plugins ;; reload
|
|
tpu: config-cycle -p -t -u {url} content.plugins ;; reload
|
|
tPu: config-cycle -p -u {url} content.plugins ;; reload
|
|
tih: config-cycle -p -t -u *://{url:host}/* content.images ;; reload
|
|
tIh: config-cycle -p -u *://{url:host}/* content.images ;; reload
|
|
tiH: config-cycle -p -t -u *://*.{url:host}/* content.images ;; reload
|
|
tIH: config-cycle -p -u *://*.{url:host}/* content.images ;; reload
|
|
tiu: config-cycle -p -t -u {url} content.images ;; reload
|
|
tIu: config-cycle -p -u {url} content.images ;; reload
|
|
tch: config-cycle -p -t -u *://{url:host}/* content.cookies.accept
|
|
all no-3rdparty never ;; reload
|
|
tCh: config-cycle -p -u *://{url:host}/* content.cookies.accept
|
|
all no-3rdparty never ;; reload
|
|
tcH: config-cycle -p -t -u *://*.{url:host}/* content.cookies.accept
|
|
all no-3rdparty never ;; reload
|
|
tCH: config-cycle -p -u *://*.{url:host}/* content.cookies.accept
|
|
all no-3rdparty never ;; reload
|
|
tcu: config-cycle -p -t -u {url} content.cookies.accept
|
|
all no-3rdparty never ;; reload
|
|
tCu: config-cycle -p -u {url} content.cookies.accept
|
|
all no-3rdparty never ;; reload
|
|
insert:
|
|
<Ctrl-E>: edit-text
|
|
<Shift-Ins>: insert-text -- {primary}
|
|
<Escape>: mode-leave
|
|
<Shift-Escape>: fake-key <Escape>
|
|
hint:
|
|
<Return>: hint-follow
|
|
<Ctrl-R>: hint --rapid links tab-bg
|
|
<Ctrl-F>: hint links
|
|
<Ctrl-B>: hint all tab-bg
|
|
<Escape>: mode-leave
|
|
passthrough:
|
|
<Shift-Escape>: mode-leave
|
|
command:
|
|
<Ctrl-P>: command-history-prev
|
|
<Ctrl-N>: command-history-next
|
|
<Up>: completion-item-focus --history prev
|
|
<Down>: completion-item-focus --history next
|
|
<Shift-Tab>: completion-item-focus prev
|
|
<Tab>: completion-item-focus next
|
|
<Ctrl-Tab>: completion-item-focus next-category
|
|
<Ctrl-Shift-Tab>: completion-item-focus prev-category
|
|
<PgDown>: completion-item-focus next-page
|
|
<PgUp>: completion-item-focus prev-page
|
|
<Ctrl-D>: completion-item-del
|
|
<Shift-Delete>: completion-item-del
|
|
<Ctrl-C>: completion-item-yank
|
|
<Ctrl-Shift-C>: completion-item-yank --sel
|
|
<Return>: command-accept
|
|
<Ctrl-Return>: command-accept --rapid
|
|
<Ctrl-B>: rl-backward-char
|
|
<Ctrl-F>: rl-forward-char
|
|
<Alt-B>: rl-backward-word
|
|
<Alt-F>: rl-forward-word
|
|
<Ctrl-A>: rl-beginning-of-line
|
|
<Ctrl-E>: rl-end-of-line
|
|
<Ctrl-U>: rl-unix-line-discard
|
|
<Ctrl-K>: rl-kill-line
|
|
<Alt-D>: rl-kill-word
|
|
<Ctrl-W>: rl-rubout " "
|
|
<Ctrl-Shift-W>: rl-filename-rubout
|
|
<Alt-Backspace>: rl-backward-kill-word
|
|
<Ctrl-Y>: rl-yank
|
|
<Ctrl-?>: rl-delete-char
|
|
<Ctrl-H>: rl-backward-delete-char
|
|
<Escape>: mode-leave
|
|
prompt:
|
|
<Return>: prompt-accept
|
|
<Ctrl-X>: prompt-open-download
|
|
<Ctrl-P>: prompt-open-download --pdfjs
|
|
<Shift-Tab>: prompt-item-focus prev
|
|
<Up>: prompt-item-focus prev
|
|
<Tab>: prompt-item-focus next
|
|
<Down>: prompt-item-focus next
|
|
<Alt-Y>: prompt-yank
|
|
<Alt-Shift-Y>: prompt-yank --sel
|
|
<Alt-E>: prompt-fileselect-external
|
|
<Ctrl-B>: rl-backward-char
|
|
<Ctrl-F>: rl-forward-char
|
|
<Alt-B>: rl-backward-word
|
|
<Alt-F>: rl-forward-word
|
|
<Ctrl-A>: rl-beginning-of-line
|
|
<Ctrl-E>: rl-end-of-line
|
|
<Ctrl-U>: rl-unix-line-discard
|
|
<Ctrl-K>: rl-kill-line
|
|
<Alt-D>: rl-kill-word
|
|
<Ctrl-W>: rl-rubout " "
|
|
<Ctrl-Shift-W>: rl-filename-rubout
|
|
<Alt-Backspace>: rl-backward-kill-word
|
|
<Ctrl-?>: rl-delete-char
|
|
<Ctrl-H>: rl-backward-delete-char
|
|
<Ctrl-Y>: rl-yank
|
|
<Escape>: mode-leave
|
|
yesno:
|
|
<Return>: prompt-accept
|
|
y: prompt-accept yes
|
|
n: prompt-accept no
|
|
Y: prompt-accept --save yes
|
|
N: prompt-accept --save no
|
|
<Alt-Y>: prompt-yank
|
|
<Alt-Shift-Y>: prompt-yank --sel
|
|
<Escape>: mode-leave
|
|
caret:
|
|
v: selection-toggle
|
|
V: selection-toggle --line
|
|
<Space>: selection-toggle
|
|
<Ctrl-Space>: selection-drop
|
|
c: mode-enter normal
|
|
j: move-to-next-line
|
|
k: move-to-prev-line
|
|
l: move-to-next-char
|
|
h: move-to-prev-char
|
|
e: move-to-end-of-word
|
|
w: move-to-next-word
|
|
b: move-to-prev-word
|
|
o: selection-reverse
|
|
"]": move-to-start-of-next-block
|
|
"[": move-to-start-of-prev-block
|
|
"}": move-to-end-of-next-block
|
|
"{": move-to-end-of-prev-block
|
|
"0": move-to-start-of-line
|
|
$: move-to-end-of-line
|
|
gg: move-to-start-of-document
|
|
G: move-to-end-of-document
|
|
Y: yank selection -s
|
|
y: yank selection
|
|
<Return>: yank selection
|
|
H: scroll left
|
|
J: scroll down
|
|
K: scroll up
|
|
L: scroll right
|
|
<Escape>: mode-leave
|
|
register:
|
|
<Escape>: mode-leave
|
|
type:
|
|
name: Dict
|
|
none_ok: true
|
|
keytype: String # section name
|
|
fixed_keys: ['normal', 'insert', 'hint', 'passthrough', 'command',
|
|
'prompt', 'yesno', 'caret', 'register']
|
|
valtype:
|
|
name: Dict
|
|
none_ok: true
|
|
keytype: Key
|
|
valtype: Command
|
|
desc: >-
|
|
Default keybindings. If you want to add bindings, modify
|
|
`bindings.commands` instead.
|
|
|
|
The main purpose of this setting is that you can set it to an empty
|
|
dictionary if you want to load no default keybindings at all.
|
|
|
|
If you want to preserve default bindings (and get new bindings when there
|
|
is an update), use `config.bind()` in `config.py` or the `:bind` command,
|
|
and leave this setting alone.
|
|
|
|
bindings.commands:
|
|
default: {}
|
|
type:
|
|
name: Dict
|
|
none_ok: true
|
|
keytype: String # section name
|
|
fixed_keys: ['normal', 'insert', 'hint', 'passthrough', 'command',
|
|
'prompt', 'yesno', 'caret', 'register']
|
|
valtype:
|
|
name: Dict
|
|
none_ok: true
|
|
keytype: Key
|
|
valtype:
|
|
name: Command
|
|
none_ok: true # needed for :unbind
|
|
desc: >-
|
|
Keybindings mapping keys to commands in different modes.
|
|
|
|
While it's possible to add bindings with this setting, it's recommended to
|
|
use `config.bind()` in `config.py` or the `:bind` command, and leave this
|
|
setting alone.
|
|
|
|
This setting is a dictionary containing mode names and dictionaries mapping
|
|
keys to commands:
|
|
|
|
`{mode: {key: command}}`
|
|
|
|
If you want to map a key to another key, check the `bindings.key_mappings`
|
|
setting instead.
|
|
|
|
For modifiers, you can use either `-` or `+` as delimiters, and these
|
|
names:
|
|
|
|
* Control: `Control`, `Ctrl`
|
|
|
|
* Meta: `Meta`, `Windows`, `Mod4`
|
|
|
|
* Alt: `Alt`, `Mod1`
|
|
|
|
* Shift: `Shift`
|
|
|
|
For simple keys (no `<>`-signs), a capital letter means the key is pressed
|
|
with Shift. For special keys (with `<>`-signs), you need to explicitly add
|
|
`Shift-` to match a key pressed with shift.
|
|
|
|
If you want a binding to do nothing, bind it to the `nop` command.
|
|
If you want a default binding to be passed through to the website, bind it
|
|
to null.
|
|
|
|
Note that some commands which are only useful for bindings (but not used
|
|
interactively) are hidden from the command completion. See `:help` for a
|
|
full list of available commands.
|
|
|
|
The following modes are available:
|
|
|
|
|
|
* normal: Default mode, where most commands are invoked.
|
|
|
|
|
|
* insert: Entered when an input field is focused on a website, or by
|
|
pressing `i` in normal mode. Passes through almost all keypresses to the
|
|
website, but has some bindings like `<Ctrl-e>` to open an external
|
|
editor. Note that single keys can't be bound in this mode.
|
|
|
|
* hint: Entered when `f` is pressed to select links with the keyboard. Note
|
|
that single keys can't be bound in this mode.
|
|
|
|
* passthrough: Similar to insert mode, but passes through all keypresses
|
|
except `<Shift+Escape>` to leave the mode. Note that single keys can't be
|
|
bound in this mode.
|
|
|
|
* command: Entered when pressing the `:` key in order to enter a command.
|
|
Note that single keys can't be bound in this mode.
|
|
|
|
* prompt: Entered when there's a prompt to display, like for download
|
|
locations or when invoked from JavaScript.
|
|
|
|
* yesno: Entered when there's a yes/no prompt displayed.
|
|
|
|
* caret: Entered when pressing the `v` mode, used to select text using the
|
|
keyboard.
|
|
|
|
* register: Entered when qutebrowser is waiting for a register name/key for
|
|
commands like `:set-mark`.
|
|
|
|
## logging
|
|
|
|
logging.level.ram:
|
|
default: debug
|
|
type: LogLevel
|
|
desc:
|
|
Level for in-memory logs.
|
|
|
|
logging.level.console:
|
|
default: info
|
|
type: LogLevel
|
|
desc: >-
|
|
Level for console (stdout/stderr) logs.
|
|
Ignored if the `--loglevel` or `--debug` CLI flags are used.
|