diff options
Diffstat (limited to 'doc/help/settings.asciidoc')
| -rw-r--r-- | doc/help/settings.asciidoc | 185 |
1 files changed, 107 insertions, 78 deletions
diff --git a/doc/help/settings.asciidoc b/doc/help/settings.asciidoc index 392f60c49..8b2964f4f 100644 --- a/doc/help/settings.asciidoc +++ b/doc/help/settings.asciidoc @@ -261,6 +261,7 @@ |<<input.insert_mode.leave_on_load,input.insert_mode.leave_on_load>>|Leave insert mode when starting a new page load. |<<input.insert_mode.plugins,input.insert_mode.plugins>>|Switch to insert mode when clicking flash and other plugins. |<<input.links_included_in_focus_chain,input.links_included_in_focus_chain>>|Include hyperlinks in the keyboard focus chain when tabbing. +|<<input.media_keys,input.media_keys>>|Whether the underlying Chromium should handle media keys. |<<input.mouse.back_forward_buttons,input.mouse.back_forward_buttons>>|Enable back and forward buttons on the mouse. |<<input.mouse.rocker_gestures,input.mouse.rocker_gestures>>|Enable Opera-like mouse rocker gestures. |<<input.partial_timeout,input.partial_timeout>>|Timeout (in milliseconds) for partially typed key bindings. @@ -283,6 +284,7 @@ |<<qt.highdpi,qt.highdpi>>|Turn on Qt HighDPI scaling. |<<qt.low_end_device_mode,qt.low_end_device_mode>>|When to use Chromium's low-end device mode. |<<qt.process_model,qt.process_model>>|Which Chromium process model to use. +|<<qt.workarounds.locale,qt.workarounds.locale>>|Work around locale parsing issues in QtWebEngine 5.15.3. |<<qt.workarounds.remove_service_workers,qt.workarounds.remove_service_workers>>|Delete the QtWebEngine Service Worker directory on every start. |<<scrolling.bar,scrolling.bar>>|When/how to show the scrollbar. |<<scrolling.smooth,scrolling.smooth>>|Enable smooth scrolling for web pages. @@ -1599,6 +1601,8 @@ The `lightness-cielab` value was added with QtWebEngine 5.14 and is treated like This setting requires a restart. +This setting is only available with the QtWebEngine backend. + Type: <<types,String>> Valid values: @@ -1609,8 +1613,6 @@ Valid values: Default: +pass:[lightness-cielab]+ -This setting is only available with the QtWebEngine backend. - [[colors.webpage.darkmode.contrast]] === colors.webpage.darkmode.contrast Contrast for dark mode. @@ -1618,12 +1620,12 @@ This only has an effect when `colors.webpage.darkmode.algorithm` is set to `ligh This setting requires a restart. +This setting is only available with the QtWebEngine backend. + Type: <<types,Float>> Default: +pass:[0.0]+ -This setting is only available with the QtWebEngine backend. - [[colors.webpage.darkmode.enabled]] === colors.webpage.darkmode.enabled Render all web contents using a dark theme. @@ -1644,12 +1646,12 @@ Example configurations from Chromium's `chrome://flags`: This setting requires a restart. +This setting is only available with the QtWebEngine backend. + Type: <<types,Bool>> Default: +pass:[false]+ -This setting is only available with the QtWebEngine backend. - [[colors.webpage.darkmode.grayscale.all]] === colors.webpage.darkmode.grayscale.all Render all colors as grayscale. @@ -1657,12 +1659,12 @@ This only has an effect when `colors.webpage.darkmode.algorithm` is set to `ligh This setting requires a restart. +This setting is only available with the QtWebEngine backend. + Type: <<types,Bool>> Default: +pass:[false]+ -This setting is only available with the QtWebEngine backend. - [[colors.webpage.darkmode.grayscale.images]] === colors.webpage.darkmode.grayscale.images Desaturation factor for images in dark mode. @@ -1670,14 +1672,14 @@ If set to 0, images are left as-is. If set to 1, images are completely grayscale This setting requires a restart. -Type: <<types,Float>> - -Default: +pass:[0.0]+ - On QtWebEngine, this setting requires Qt 5.14 or newer. On QtWebKit, this setting is unavailable. +Type: <<types,Float>> + +Default: +pass:[0.0]+ + [[colors.webpage.darkmode.policy.images]] === colors.webpage.darkmode.policy.images Which images to apply dark mode to. @@ -1685,6 +1687,8 @@ With QtWebEngine 5.15.0, this setting can cause frequent renderer process crashe This setting requires a restart. +This setting is only available with the QtWebEngine backend. + Type: <<types,String>> Valid values: @@ -1695,8 +1699,6 @@ Valid values: Default: +pass:[smart]+ -This setting is only available with the QtWebEngine backend. - [[colors.webpage.darkmode.policy.page]] === colors.webpage.darkmode.policy.page Which pages to apply dark mode to. @@ -1704,6 +1706,10 @@ The underlying Chromium setting has been removed in QtWebEngine 5.15.3, thus thi This setting requires a restart. +On QtWebEngine, this setting requires Qt 5.14 or newer. + +On QtWebKit, this setting is unavailable. + Type: <<types,String>> Valid values: @@ -1713,10 +1719,6 @@ Valid values: Default: +pass:[smart]+ -On QtWebEngine, this setting requires Qt 5.14 or newer. - -On QtWebKit, this setting is unavailable. - [[colors.webpage.darkmode.threshold.background]] === colors.webpage.darkmode.threshold.background Threshold for inverting background elements with dark mode. @@ -1725,14 +1727,14 @@ Note: This behavior is the opposite of `colors.webpage.darkmode.threshold.text`! This setting requires a restart. -Type: <<types,Int>> - -Default: +pass:[0]+ - On QtWebEngine, this setting requires Qt 5.14 or newer. On QtWebKit, this setting is unavailable. +Type: <<types,Int>> + +Default: +pass:[0]+ + [[colors.webpage.darkmode.threshold.text]] === colors.webpage.darkmode.threshold.text Threshold for inverting text with dark mode. @@ -1740,14 +1742,14 @@ Text colors with brightness below this threshold will be inverted, and above it This setting requires a restart. -Type: <<types,Int>> - -Default: +pass:[256]+ - On QtWebEngine, this setting requires Qt 5.14 or newer. On QtWebKit, this setting is unavailable. +Type: <<types,Int>> + +Default: +pass:[256]+ + [[colors.webpage.preferred_color_scheme]] === colors.webpage.preferred_color_scheme Value to use for `prefers-color-scheme:` for websites. @@ -1756,6 +1758,10 @@ The "auto" value is broken on QtWebEngine 5.15.2 due to a Qt bug. There, it will This setting requires a restart. +On QtWebEngine, this setting requires Qt 5.14 or newer. + +On QtWebKit, this setting is unavailable. + Type: <<types,String>> Valid values: @@ -1766,10 +1772,6 @@ Valid values: Default: +pass:[auto]+ -On QtWebEngine, this setting requires Qt 5.14 or newer. - -On QtWebKit, this setting is unavailable. - [[completion.cmd_history_max_items]] === completion.cmd_history_max_items Number of commands to save in the command history. @@ -1941,12 +1943,12 @@ Automatically start playing `<video>` elements. This setting supports URL patterns. +This setting is only available with the QtWebEngine backend. + Type: <<types,Bool>> Default: +pass:[true]+ -This setting is only available with the QtWebEngine backend. - [[content.blocking.adblock.lists]] === content.blocking.adblock.lists List of URLs to ABP-style adblocking rulesets. @@ -2039,24 +2041,24 @@ An application cache acts like an HTTP cache in some sense. For documents that u This setting supports URL patterns. +This setting is only available with the QtWebKit backend. + Type: <<types,Bool>> Default: +pass:[true]+ -This setting is only available with the QtWebKit backend. - [[content.cache.maximum_pages]] === content.cache.maximum_pages 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/ +This setting is only available with the QtWebKit backend. + Type: <<types,Int>> Default: +pass:[0]+ -This setting is only available with the QtWebKit backend. - [[content.cache.size]] === content.cache.size Size (in bytes) of the HTTP network cache. Null to use the default value. @@ -2073,12 +2075,12 @@ Note this is needed for some websites to work properly. This setting requires a restart. +This setting is only available with the QtWebEngine backend. + Type: <<types,Bool>> Default: +pass:[true]+ -This setting is only available with the QtWebEngine backend. - [[content.cookies.accept]] === content.cookies.accept Which cookies to accept. @@ -2138,12 +2140,12 @@ Try to pre-fetch DNS entries to speed up browsing. This setting supports URL patterns. +This setting is only available with the QtWebEngine backend. + Type: <<types,Bool>> Default: +pass:[true]+ -This setting is only available with the QtWebEngine backend. - [[content.frame_flattening]] === content.frame_flattening Expand each subframe to its contents. @@ -2151,12 +2153,12 @@ This will flatten all the frames to become one scrollable page. This setting supports URL patterns. +This setting is only available with the QtWebKit backend. + Type: <<types,Bool>> Default: +pass:[false]+ -This setting is only available with the QtWebKit backend. - [[content.fullscreen.overlay_timeout]] === content.fullscreen.overlay_timeout Set fullscreen notification overlay timeout in milliseconds. @@ -2315,12 +2317,12 @@ Allow JavaScript to close tabs. This setting supports URL patterns. +This setting is only available with the QtWebKit backend. + Type: <<types,Bool>> Default: +pass:[false]+ -This setting is only available with the QtWebKit backend. - [[content.javascript.can_open_tabs_automatically]] === content.javascript.can_open_tabs_automatically Allow JavaScript to open new tabs without user interaction. @@ -2409,6 +2411,8 @@ Allow websites to record audio. This setting supports URL patterns. +This setting is only available with the QtWebEngine backend. + Type: <<types,BoolAsk>> Valid values: @@ -2419,14 +2423,14 @@ Valid values: Default: +pass:[ask]+ -This setting is only available with the QtWebEngine backend. - [[content.media.audio_video_capture]] === content.media.audio_video_capture Allow websites to record audio and video. This setting supports URL patterns. +This setting is only available with the QtWebEngine backend. + Type: <<types,BoolAsk>> Valid values: @@ -2437,14 +2441,14 @@ Valid values: Default: +pass:[ask]+ -This setting is only available with the QtWebEngine backend. - [[content.media.video_capture]] === content.media.video_capture Allow websites to record video. This setting supports URL patterns. +This setting is only available with the QtWebEngine backend. + Type: <<types,BoolAsk>> Valid values: @@ -2455,14 +2459,14 @@ Valid values: Default: +pass:[ask]+ -This setting is only available with the QtWebEngine backend. - [[content.mouse_lock]] === content.mouse_lock Allow websites to lock your mouse pointer. This setting supports URL patterns. +This setting is only available with the QtWebEngine backend. + Type: <<types,BoolAsk>> Valid values: @@ -2473,8 +2477,6 @@ Valid values: Default: +pass:[ask]+ -This setting is only available with the QtWebEngine backend. - [[content.mute]] === content.mute Automatically mute tabs. @@ -2501,6 +2503,8 @@ Allow websites to show notifications. This setting supports URL patterns. +On QtWebEngine, this setting requires Qt 5.13 or newer. + Type: <<types,BoolAsk>> Valid values: @@ -2511,8 +2515,6 @@ Valid values: Default: +pass:[ask]+ -On QtWebEngine, this setting requires Qt 5.13 or newer. - [[content.pdfjs]] === content.pdfjs Allow pdf.js to view PDF files in the browser. @@ -2530,6 +2532,8 @@ Allow websites to request persistent storage quota via `navigator.webkitPersiste This setting supports URL patterns. +This setting is only available with the QtWebEngine backend. + Type: <<types,BoolAsk>> Valid values: @@ -2540,8 +2544,6 @@ Valid values: Default: +pass:[ask]+ -This setting is only available with the QtWebEngine backend. - [[content.plugins]] === content.plugins Enable plugins in Web pages. @@ -2558,12 +2560,12 @@ Draw the background color and images also when the page is printed. This setting supports URL patterns. +This setting is only available with the QtWebEngine backend. + Type: <<types,Bool>> Default: +pass:[true]+ -This setting is only available with the QtWebEngine backend. - [[content.private_browsing]] === content.private_browsing Open new windows in private browsing mode which does not record visited pages. @@ -2591,18 +2593,20 @@ Default: +pass:[system]+ === content.proxy_dns_requests Send DNS requests over the configured proxy. +This setting is only available with the QtWebKit backend. + Type: <<types,Bool>> Default: +pass:[true]+ -This setting is only available with the QtWebKit backend. - [[content.register_protocol_handler]] === content.register_protocol_handler Allow websites to register protocol handlers via `navigator.registerProtocolHandler`. This setting supports URL patterns. +This setting is only available with the QtWebEngine backend. + Type: <<types,BoolAsk>> Valid values: @@ -2613,8 +2617,6 @@ Valid values: Default: +pass:[ask]+ -This setting is only available with the QtWebEngine backend. - [[content.site_specific_quirks]] === content.site_specific_quirks Enable quirks (such as faked user agent headers) needed to get specific sites to work properly. @@ -2647,6 +2649,8 @@ How navigation requests to URLs with unknown schemes are handled. This setting supports URL patterns. +This setting is only available with the QtWebEngine backend. + Type: <<types,String>> Valid values: @@ -2657,8 +2661,6 @@ Valid values: Default: +pass:[allow-from-user-interaction]+ -This setting is only available with the QtWebEngine backend. - [[content.user_stylesheets]] === content.user_stylesheets List of user stylesheet filenames to use. @@ -2683,6 +2685,8 @@ Which interfaces to expose via WebRTC. This setting requires a restart. +This setting is only available with the QtWebEngine backend. + Type: <<types,String>> Valid values: @@ -2694,8 +2698,6 @@ Valid values: Default: +pass:[all-interfaces]+ -This setting is only available with the QtWebEngine backend. - [[content.xss_auditing]] === content.xss_auditing Monitor load requests for cross-site scripting attempts. @@ -3119,6 +3121,8 @@ Default: +pass:[/usr/share/dict/words]+ === hints.find_implementation Which implementation to use to find elements to hint. +This setting is only available with the QtWebKit backend. + Type: <<types,String>> Valid values: @@ -3128,8 +3132,6 @@ Valid values: Default: +pass:[python]+ -This setting is only available with the QtWebKit backend. - [[hints.hide_unmatched_rapid_hints]] === hints.hide_unmatched_rapid_hints Hide unmatched hints in rapid mode. @@ -3391,6 +3393,21 @@ Type: <<types,Bool>> Default: +pass:[true]+ +[[input.media_keys]] +=== input.media_keys +Whether the underlying Chromium should handle media keys. +On Linux, disabling this also disables Chromium's MPRIS integration. + +This setting requires a restart. + +On QtWebEngine, this setting requires Qt 5.14 or newer. + +On QtWebKit, this setting is unavailable. + +Type: <<types,Bool>> + +Default: +pass:[true]+ + [[input.mouse.back_forward_buttons]] === input.mouse.back_forward_buttons Enable back and forward buttons on the mouse. @@ -3599,6 +3616,8 @@ This is needed for QtWebEngine to work with Nouveau drivers and can be useful in This setting requires a restart. +This setting is only available with the QtWebEngine backend. + Type: <<types,String>> Valid values: @@ -3610,8 +3629,6 @@ Valid values: Default: +pass:[none]+ -This setting is only available with the QtWebEngine backend. - [[qt.highdpi]] === qt.highdpi Turn on Qt HighDPI scaling. @@ -3631,6 +3648,8 @@ This improves the RAM usage of renderer processes, at the expense of performance This setting requires a restart. +This setting is only available with the QtWebEngine backend. + Type: <<types,String>> Valid values: @@ -3641,8 +3660,6 @@ Valid values: Default: +pass:[auto]+ -This setting is only available with the QtWebEngine backend. - [[qt.process_model]] === qt.process_model Which Chromium process model to use. @@ -3654,6 +3671,8 @@ See the following pages for more details: This setting requires a restart. +This setting is only available with the QtWebEngine backend. + Type: <<types,String>> Valid values: @@ -3664,8 +3683,18 @@ Valid values: Default: +pass:[process-per-site-instance]+ +[[qt.workarounds.locale]] +=== qt.workarounds.locale +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. + This setting is only available with the QtWebEngine backend. +Type: <<types,Bool>> + +Default: +pass:[false]+ + [[qt.workarounds.remove_service_workers]] === qt.workarounds.remove_service_workers Delete the QtWebEngine Service Worker directory on every start. @@ -3728,12 +3757,12 @@ Default: +pass:[true]+ === search.wrap Wrap around at the top and bottom of the page when advancing through text matches using `:search-next` and `:search-prev`. +On QtWebEngine, this setting requires Qt 5.14 or newer. + Type: <<types,Bool>> Default: +pass:[true]+ -On QtWebEngine, this setting requires Qt 5.14 or newer. - [[session.default_name]] === session.default_name Name of the session to save by default. @@ -3756,6 +3785,8 @@ Default: +pass:[false]+ 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. +This setting is only available with the QtWebEngine backend. + Type: <<types,List of String>> Valid values: @@ -3806,8 +3837,6 @@ Valid values: Default: empty -This setting is only available with the QtWebEngine backend. - [[statusbar.padding]] === statusbar.padding Padding (in pixels) for the statusbar. @@ -4425,12 +4454,12 @@ Apply the zoom factor on a frame only to the text or to all content. This setting supports URL patterns. +This setting is only available with the QtWebKit backend. + Type: <<types,Bool>> Default: +pass:[false]+ -This setting is only available with the QtWebKit backend. - == Setting types [[types]] [options="header",width="75%",cols="25%,75%"] |