2016-08-08 22:54:07 +02:00
// DO NOT EDIT THIS FILE DIRECTLY!
// It is autogenerated from docstrings by running:
// $ python3 scripts/dev/src2asciidoc.py
2014-09-07 23:22:38 +02:00
= Settings
.Quick reference for section ``general''
[options="header",width="75%",cols="25%,75%"]
|==============
|Setting|Description
2014-09-21 21:23:16 +02:00
|<<general-ignore-case,ignore-case>>|Whether to find text on a page case-insensitively.
|<<general-startpage,startpage>>|The default page(s) to open at the start, separated by commas.
2016-09-06 18:17:55 +02:00
|<<general-yank-ignored-url-parameters,yank-ignored-url-parameters>>|The URL parameters to strip with :yank url, separated by commas.
2015-04-04 15:10:22 +02:00
|<<general-default-page,default-page>>|The page to open if :open -t/-b/-w is used without URL. Use `about:blank` for a blank page.
2014-09-21 21:23:16 +02:00
|<<general-auto-search,auto-search>>|Whether to start a search when something else than a URL is entered.
|<<general-auto-save-config,auto-save-config>>|Whether to save the config automatically on quit.
2015-02-01 01:53:29 +01:00
|<<general-auto-save-interval,auto-save-interval>>|How often (in milliseconds) to auto-save config/cookies/etc.
2014-09-21 21:23:16 +02:00
|<<general-editor,editor>>|The editor (and arguments) to use for the `open-editor` command.
|<<general-editor-encoding,editor-encoding>>|Encoding to use for editor.
|<<general-private-browsing,private-browsing>>|Do not record visited pages in the history or store web page icons.
|<<general-developer-extras,developer-extras>>|Enable extra tools for Web developers.
|<<general-print-element-backgrounds,print-element-backgrounds>>|Whether the background color and images are also drawn when the page is printed.
|<<general-xss-auditing,xss-auditing>>|Whether load requests should be monitored for cross-site scripting attempts.
|<<general-site-specific-quirks,site-specific-quirks>>|Enable workarounds for broken sites.
|<<general-default-encoding,default-encoding>>|Default encoding to use for websites.
2014-10-26 19:48:26 +01:00
|<<general-new-instance-open-target,new-instance-open-target>>|How to open links in an existing instance if a new one is launched.
2016-08-10 09:13:35 +02:00
|<<general-new-instance-open-target.window,new-instance-open-target.window>>|Which window to choose when opening links as new tabs.
2015-11-30 08:08:52 +01:00
|<<general-log-javascript-console,log-javascript-console>>|How to log javascript console messages.
2015-02-17 07:45:06 +01:00
|<<general-save-session,save-session>>|Whether to always save the open pages.
2015-04-05 23:30:43 +02:00
|<<general-session-default-name,session-default-name>>|The name of the session to save by default, or empty for the last loaded session.
2015-09-30 19:49:17 +02:00
|<<general-url-incdec-segments,url-incdec-segments>>|The URL segments where `:navigate increment/decrement` will search for a number.
2014-09-07 23:22:38 +02:00
|==============
.Quick reference for section ``ui''
[options="header",width="75%",cols="25%,75%"]
|==============
|Setting|Description
2014-09-21 21:23:16 +02:00
|<<ui-zoom-levels,zoom-levels>>|The available zoom levels, separated by commas.
|<<ui-default-zoom,default-zoom>>|The default zoom level.
2015-04-09 12:54:59 +02:00
|<<ui-downloads-position,downloads-position>>|Where to show the downloaded files.
2016-07-04 19:05:44 +02:00
|<<ui-status-position,status-position>>|The position of the status bar.
2014-09-21 21:23:16 +02:00
|<<ui-message-timeout,message-timeout>>|Time (in ms) to show messages in the statusbar for.
2015-03-22 23:52:08 +01:00
|<<ui-message-unfocused,message-unfocused>>|Whether to show messages in unfocused windows.
2014-09-21 21:23:16 +02:00
|<<ui-confirm-quit,confirm-quit>>|Whether to confirm quitting the application.
|<<ui-zoom-text-only,zoom-text-only>>|Whether the zoom factor on a frame applies only to the text or to all content.
|<<ui-frame-flattening,frame-flattening>>|Whether to expand each subframe to its contents.
2015-06-08 18:54:07 +02:00
|<<ui-user-stylesheet,user-stylesheet>>|User stylesheet to use (absolute filename, filename relative to the config directory or CSS string). Will expand environment variables.
2014-09-21 21:23:16 +02:00
|<<ui-css-media-type,css-media-type>>|Set the CSS media type.
2015-05-15 23:53:08 +02:00
|<<ui-smooth-scrolling,smooth-scrolling>>|Whether to enable smooth scrolling for webpages.
2015-11-02 17:59:43 +01:00
|<<ui-remove-finished-downloads,remove-finished-downloads>>|Number of milliseconds to wait before removing finished downloads. Will not be removed if value is -1.
2015-01-25 22:43:13 +01:00
|<<ui-hide-statusbar,hide-statusbar>>|Whether to hide the statusbar unless a message is shown.
2015-08-27 22:13:30 +02:00
|<<ui-statusbar-padding,statusbar-padding>>|Padding for statusbar (top, bottom, left, right).
2015-01-28 08:40:16 +01:00
|<<ui-window-title-format,window-title-format>>|The format to use for the window title. The following placeholders are defined:
2015-05-31 21:41:32 +02:00
|<<ui-modal-js-dialog,modal-js-dialog>>|Use standard JavaScript modal dialog for alert() and confirm()
2015-09-16 08:52:51 +02:00
|<<ui-hide-wayland-decoration,hide-wayland-decoration>>|Hide the window decoration when using wayland (requires restart)
2016-05-25 22:05:06 +02:00
|<<ui-keyhint-blacklist,keyhint-blacklist>>|Keychains that shouldn't be shown in the keyhint dialog
2014-09-07 23:22:38 +02:00
|==============
.Quick reference for section ``network''
[options="header",width="75%",cols="25%,75%"]
|==============
|Setting|Description
2014-09-21 21:23:16 +02:00
|<<network-do-not-track,do-not-track>>|Value to send in the `DNT` header.
|<<network-accept-language,accept-language>>|Value to send in the `accept-language` header.
2015-08-01 13:35:54 +02:00
|<<network-referer-header,referer-header>>|Send the Referer header
2014-09-21 21:23:16 +02:00
|<<network-user-agent,user-agent>>|User agent to send. Empty to send the default.
|<<network-proxy,proxy>>|The proxy to use.
2014-12-16 23:34:19 +01:00
|<<network-proxy-dns-requests,proxy-dns-requests>>|Whether to send DNS requests over the configured proxy.
2014-09-21 21:23:16 +02:00
|<<network-ssl-strict,ssl-strict>>|Whether to validate SSL handshakes.
|<<network-dns-prefetch,dns-prefetch>>|Whether to try to pre-fetch DNS entries to speed up browsing.
2016-04-19 09:40:39 +02:00
|<<network-custom-headers,custom-headers>>|Set custom headers for qutebrowser HTTP requests.
2014-09-07 23:22:38 +02:00
|==============
.Quick reference for section ``completion''
[options="header",width="75%",cols="25%,75%"]
|==============
|Setting|Description
2016-08-29 07:14:44 +02:00
|<<completion-show,show>>|When to show the autocompletion window.
2015-03-06 16:57:58 +01:00
|<<completion-download-path-suggestion,download-path-suggestion>>|What to display in the download filename input.
2015-03-12 15:25:39 +01:00
|<<completion-timestamp-format,timestamp-format>>|How to format timestamps (e.g. for history)
2014-09-21 21:23:16 +02:00
|<<completion-height,height>>|The height of the completion, in px or as percentage of the window.
2015-03-13 19:50:20 +01:00
|<<completion-cmd-history-max-items,cmd-history-max-items>>|How many commands to save in the command history.
|<<completion-web-history-max-items,web-history-max-items>>|How many URLs to show in the web history.
2014-09-21 21:23:16 +02:00
|<<completion-quick-complete,quick-complete>>|Whether to move on to the next part when there's only one possible completion left.
|<<completion-shrink,shrink>>|Whether to shrink the completion to be smaller than the configured size if there are no scrollbars.
2015-10-19 05:18:30 +02:00
|<<completion-scrollbar-width,scrollbar-width>>|Width of the scrollbar in the completion window (in px).
|<<completion-scrollbar-padding,scrollbar-padding>>|Padding of scrollbar handle in completion window (in px).
2014-09-07 23:22:38 +02:00
|==============
.Quick reference for section ``input''
[options="header",width="75%",cols="25%,75%"]
|==============
|Setting|Description
2016-08-08 19:56:24 +02:00
|<<input-timeout,timeout>>|Timeout (in milliseconds) for ambiguous key bindings.
|<<input-partial-timeout,partial-timeout>>|Timeout (in milliseconds) for partially typed key bindings.
2014-09-21 21:23:16 +02:00
|<<input-insert-mode-on-plugins,insert-mode-on-plugins>>|Whether to switch to insert mode when clicking flash and other plugins.
|<<input-auto-leave-insert-mode,auto-leave-insert-mode>>|Whether to leave insert mode if a non-editable element is clicked.
|<<input-auto-insert-mode,auto-insert-mode>>|Whether to automatically enter insert mode if an editable element is focused after page load.
|<<input-forward-unbound-keys,forward-unbound-keys>>|Whether to forward unbound keys to the webview in normal mode.
2015-08-20 11:10:52 +02:00
|<<input-spatial-navigation,spatial-navigation>>|Enables or disables the Spatial Navigation feature.
2014-09-21 21:23:16 +02:00
|<<input-links-included-in-focus-chain,links-included-in-focus-chain>>|Whether hyperlinks should be included in the keyboard focus chain.
2015-03-03 12:56:40 +01:00
|<<input-rocker-gestures,rocker-gestures>>|Whether to enable Opera-like mouse rocker gestures. This disables the context menu.
2015-03-30 15:26:07 +02:00
|<<input-mouse-zoom-divider,mouse-zoom-divider>>|How much to divide the mouse wheel movements to translate them into zoom increments.
2014-09-07 23:22:38 +02:00
|==============
.Quick reference for section ``tabs''
[options="header",width="75%",cols="25%,75%"]
|==============
|Setting|Description
2014-09-21 21:23:16 +02:00
|<<tabs-background-tabs,background-tabs>>|Whether to open new tabs (middleclick/ctrl+click) in background.
|<<tabs-select-on-remove,select-on-remove>>|Which tab to select when the focused tab is removed.
|<<tabs-new-tab-position,new-tab-position>>|How new tabs are positioned.
2015-03-31 20:49:29 +02:00
|<<tabs-new-tab-position-explicit,new-tab-position-explicit>>|How new tabs opened explicitly are positioned.
2015-06-07 10:47:53 +02:00
|<<tabs-last-close,last-close>>|Behavior when the last tab is closed.
2015-08-01 22:43:20 +02:00
|<<tabs-show,show>>|When to show the tab bar
|<<tabs-show-switching-delay,show-switching-delay>>|Time to show the tab bar before hiding it when tabs->show is set to 'switching'.
2014-09-21 21:23:16 +02:00
|<<tabs-wrap,wrap>>|Whether to wrap when changing tabs.
|<<tabs-movable,movable>>|Whether tabs should be movable.
|<<tabs-close-mouse-button,close-mouse-button>>|On which mouse button to close tabs.
|<<tabs-position,position>>|The position of the tab bar.
|<<tabs-show-favicons,show-favicons>>|Whether to show favicons in the tab bar.
|<<tabs-width,width>>|The width of the tab bar if it's vertical, in px or as percentage of the window.
|<<tabs-indicator-width,indicator-width>>|Width of the progress indicator (0 to disable).
2014-11-23 21:27:46 +01:00
|<<tabs-tabs-are-windows,tabs-are-windows>>|Whether to open windows instead of tabs.
2015-02-14 00:29:12 +01:00
|<<tabs-title-format,title-format>>|The format to use for the tab title. The following placeholders are defined:
2015-12-07 21:13:30 +01:00
|<<tabs-title-alignment,title-alignment>>|Alignment of the text inside of tabs
2015-05-25 15:23:14 +02:00
|<<tabs-mousewheel-tab-switching,mousewheel-tab-switching>>|Switch between tabs using the mouse wheel.
2015-08-01 00:35:59 +02:00
|<<tabs-padding,padding>>|Padding for tabs (top, bottom, left, right).
|<<tabs-indicator-padding,indicator-padding>>|Padding for indicators (top, bottom, left, right).
2014-09-07 23:22:38 +02:00
|==============
.Quick reference for section ``storage''
[options="header",width="75%",cols="25%,75%"]
|==============
|Setting|Description
2015-02-18 16:16:54 +01:00
|<<storage-download-directory,download-directory>>|The directory to save downloads to. An empty value selects a sensible os-specific default. Will expand environment variables.
2015-08-06 18:58:09 +02:00
|<<storage-prompt-download-directory,prompt-download-directory>>|Whether to prompt the user for the download location.
2015-08-01 14:19:06 +02:00
|<<storage-remember-download-directory,remember-download-directory>>|Whether to remember the last used download directory.
2015-04-04 15:30:58 +02:00
|<<storage-maximum-pages-in-cache,maximum-pages-in-cache>>|The maximum number of pages to hold in the global memory page cache.
|<<storage-object-cache-capacities,object-cache-capacities>>|The capacities for the global memory cache for dead objects such as stylesheets or scripts. Syntax: cacheMinDeadCapacity, cacheMaxDead, totalCapacity.
2014-09-21 21:23:16 +02:00
|<<storage-offline-storage-default-quota,offline-storage-default-quota>>|Default quota for new offline storage databases.
|<<storage-offline-web-application-cache-quota,offline-web-application-cache-quota>>|Quota for the offline web application cache.
|<<storage-offline-storage-database,offline-storage-database>>|Whether support for the HTML 5 offline storage feature is enabled.
|<<storage-offline-web-application-storage,offline-web-application-storage>>|Whether support for the HTML 5 web application cache feature is enabled.
|<<storage-local-storage,local-storage>>|Whether support for the HTML 5 local storage feature is enabled.
|<<storage-cache-size,cache-size>>|Size of the HTTP network cache.
2014-09-07 23:22:38 +02:00
|==============
2014-11-26 21:16:27 +01:00
.Quick reference for section ``content''
2014-09-07 23:22:38 +02:00
[options="header",width="75%",cols="25%,75%"]
|==============
|Setting|Description
2014-11-26 21:16:27 +01:00
|<<content-allow-images,allow-images>>|Whether images are automatically loaded in web pages.
|<<content-allow-javascript,allow-javascript>>|Enables or disables the running of JavaScript programs.
|<<content-allow-plugins,allow-plugins>>|Enables or disables plugins in Web pages.
2016-08-04 21:33:53 +02:00
|<<content-webgl,webgl>>|Enables or disables WebGL. For QtWebEngine, Qt/PyQt >= 5.7 is required for this setting.
2015-05-16 00:39:20 +02:00
|<<content-css-regions,css-regions>>|Enable or disable support for CSS regions.
2015-05-16 00:42:26 +02:00
|<<content-hyperlink-auditing,hyperlink-auditing>>|Enable or disable hyperlink auditing (<a ping>).
2015-02-10 21:09:08 +01:00
|<<content-geolocation,geolocation>>|Allow websites to request geolocations.
|<<content-notifications,notifications>>|Allow websites to show notifications.
2016-09-05 17:09:14 +02:00
|<<content-javascript-can-open-windows-automatically,javascript-can-open-windows-automatically>>|Whether JavaScript programs can open new windows without user interaction.
2014-11-26 21:16:27 +01:00
|<<content-javascript-can-close-windows,javascript-can-close-windows>>|Whether JavaScript programs can close windows.
|<<content-javascript-can-access-clipboard,javascript-can-access-clipboard>>|Whether JavaScript programs can read or write to the clipboard.
2015-02-17 19:03:18 +01:00
|<<content-ignore-javascript-prompt,ignore-javascript-prompt>>|Whether all javascript prompts should be ignored.
|<<content-ignore-javascript-alert,ignore-javascript-alert>>|Whether all javascript alerts should be ignored.
2014-11-26 21:16:27 +01:00
|<<content-local-content-can-access-remote-urls,local-content-can-access-remote-urls>>|Whether locally loaded documents are allowed to access remote urls.
|<<content-local-content-can-access-file-urls,local-content-can-access-file-urls>>|Whether locally loaded documents are allowed to access other local urls.
2015-06-05 15:57:43 +02:00
|<<content-cookies-accept,cookies-accept>>|Control which cookies to accept.
2014-11-26 21:16:27 +01:00
|<<content-cookies-store,cookies-store>>|Whether to store cookies.
|<<content-host-block-lists,host-block-lists>>|List of URLs of lists which contain hosts to block.
2015-03-30 18:32:32 +02:00
|<<content-host-blocking-enabled,host-blocking-enabled>>|Whether host blocking is enabled.
2015-09-16 16:31:17 +02:00
|<<content-host-blocking-whitelist,host-blocking-whitelist>>|List of domains that should always be loaded, despite being ad-blocked.
2016-01-05 07:32:50 +01:00
|<<content-enable-pdfjs,enable-pdfjs>>|Enable pdf.js to view PDF files in the browser.
2014-09-07 23:22:38 +02:00
|==============
.Quick reference for section ``hints''
[options="header",width="75%",cols="25%,75%"]
|==============
|Setting|Description
2014-09-21 21:23:16 +02:00
|<<hints-border,border>>|CSS border value for hints.
|<<hints-mode,mode>>|Mode to use for hints.
|<<hints-chars,chars>>|Chars used for hint strings.
2015-10-04 15:41:42 +02:00
|<<hints-min-chars,min-chars>>|Minimum number of chars used for hint strings.
2016-06-07 15:43:17 +02:00
|<<hints-scatter,scatter>>|Whether to scatter hint key chains (like Vimium) or not (like dwb). Ignored for number hints.
2014-10-27 06:53:10 +01:00
|<<hints-uppercase,uppercase>>|Make chars in hint strings uppercase.
2016-02-02 18:59:00 +01:00
|<<hints-dictionary,dictionary>>|The dictionary file to be used by the word hints.
2016-08-16 12:59:54 +02:00
|<<hints-auto-follow,auto-follow>>|Controls when a hint can be automatically followed without the user pressing Enter.
2016-08-08 19:56:24 +02:00
|<<hints-auto-follow-timeout,auto-follow-timeout>>|A timeout (in milliseconds) to inhibit normal-mode key bindings after a successful auto-follow.
2014-09-21 21:23:16 +02:00
|<<hints-next-regexes,next-regexes>>|A comma-separated list of regexes to use for 'next' links.
|<<hints-prev-regexes,prev-regexes>>|A comma-separated list of regexes to use for 'prev' links.
2016-06-09 15:40:22 +02:00
|<<hints-find-implementation,find-implementation>>|Which implementation to use to find elements to hint.
2016-08-09 16:44:00 +02:00
|<<hints-hide-unmatched-rapid-hints,hide-unmatched-rapid-hints>>|Controls hiding unmatched hints in rapid mode.
2014-09-07 23:22:38 +02:00
|==============
.Quick reference for section ``colors''
[options="header",width="75%",cols="25%,75%"]
|==============
|Setting|Description
2014-09-21 21:23:16 +02:00
|<<colors-completion.fg,completion.fg>>|Text color of the completion widget.
|<<colors-completion.bg,completion.bg>>|Background color of the completion widget.
2015-03-15 23:25:57 +01:00
|<<colors-completion.alternate-bg,completion.alternate-bg>>|Alternating background color of the completion widget.
2014-09-21 21:23:16 +02:00
|<<colors-completion.category.fg,completion.category.fg>>|Foreground color of completion widget category headers.
|<<colors-completion.category.bg,completion.category.bg>>|Background color of the completion widget category headers.
|<<colors-completion.category.border.top,completion.category.border.top>>|Top border color of the completion widget category headers.
|<<colors-completion.category.border.bottom,completion.category.border.bottom>>|Bottom border color of the completion widget category headers.
|<<colors-completion.item.selected.fg,completion.item.selected.fg>>|Foreground color of the selected completion item.
|<<colors-completion.item.selected.bg,completion.item.selected.bg>>|Background color of the selected completion item.
|<<colors-completion.item.selected.border.top,completion.item.selected.border.top>>|Top border color of the completion widget category headers.
|<<colors-completion.item.selected.border.bottom,completion.item.selected.border.bottom>>|Bottom border color of the selected completion item.
|<<colors-completion.match.fg,completion.match.fg>>|Foreground color of the matched text in the completion.
2015-10-19 05:18:30 +02:00
|<<colors-completion.scrollbar.fg,completion.scrollbar.fg>>|Color of the scrollbar handle in completion view.
|<<colors-completion.scrollbar.bg,completion.scrollbar.bg>>|Color of the scrollbar in completion view
2014-09-21 21:23:16 +02:00
|<<colors-statusbar.fg,statusbar.fg>>|Foreground color of the statusbar.
2015-10-15 18:34:56 +02:00
|<<colors-statusbar.bg,statusbar.bg>>|Background color of the statusbar.
2015-06-10 20:55:15 +02:00
|<<colors-statusbar.fg.error,statusbar.fg.error>>|Foreground color of the statusbar if there was an error.
2014-09-21 21:23:16 +02:00
|<<colors-statusbar.bg.error,statusbar.bg.error>>|Background color of the statusbar if there was an error.
2015-06-10 20:55:15 +02:00
|<<colors-statusbar.fg.warning,statusbar.fg.warning>>|Foreground color of the statusbar if there is a warning.
2015-01-15 21:27:36 +01:00
|<<colors-statusbar.bg.warning,statusbar.bg.warning>>|Background color of the statusbar if there is a warning.
2015-06-10 20:55:15 +02:00
|<<colors-statusbar.fg.prompt,statusbar.fg.prompt>>|Foreground color of the statusbar if there is a prompt.
2014-09-21 21:23:16 +02:00
|<<colors-statusbar.bg.prompt,statusbar.bg.prompt>>|Background color of the statusbar if there is a prompt.
2015-06-10 20:55:15 +02:00
|<<colors-statusbar.fg.insert,statusbar.fg.insert>>|Foreground color of the statusbar in insert mode.
2014-09-21 21:23:16 +02:00
|<<colors-statusbar.bg.insert,statusbar.bg.insert>>|Background color of the statusbar in insert mode.
2015-06-10 20:55:15 +02:00
|<<colors-statusbar.fg.command,statusbar.fg.command>>|Foreground color of the statusbar in command mode.
|<<colors-statusbar.bg.command,statusbar.bg.command>>|Background color of the statusbar in command mode.
|<<colors-statusbar.fg.caret,statusbar.fg.caret>>|Foreground color of the statusbar in caret mode.
2015-05-18 22:34:21 +02:00
|<<colors-statusbar.bg.caret,statusbar.bg.caret>>|Background color of the statusbar in caret mode.
2015-06-10 20:55:15 +02:00
|<<colors-statusbar.fg.caret-selection,statusbar.fg.caret-selection>>|Foreground color of the statusbar in caret mode with a selection
2015-05-18 22:34:21 +02:00
|<<colors-statusbar.bg.caret-selection,statusbar.bg.caret-selection>>|Background color of the statusbar in caret mode with a selection
2014-09-21 21:23:16 +02:00
|<<colors-statusbar.progress.bg,statusbar.progress.bg>>|Background color of the progress bar.
|<<colors-statusbar.url.fg,statusbar.url.fg>>|Default foreground color of the URL in the statusbar.
2015-10-15 18:34:56 +02:00
|<<colors-statusbar.url.fg.success,statusbar.url.fg.success>>|Foreground color of the URL in the statusbar on successful load (http).
|<<colors-statusbar.url.fg.success.https,statusbar.url.fg.success.https>>|Foreground color of the URL in the statusbar on successful load (https).
2014-09-21 21:23:16 +02:00
|<<colors-statusbar.url.fg.error,statusbar.url.fg.error>>|Foreground color of the URL in the statusbar on error.
|<<colors-statusbar.url.fg.warn,statusbar.url.fg.warn>>|Foreground color of the URL in the statusbar when there's a warning.
|<<colors-statusbar.url.fg.hover,statusbar.url.fg.hover>>|Foreground color of the URL in the statusbar for hovered links.
2014-11-26 21:16:27 +01:00
|<<colors-tabs.fg.odd,tabs.fg.odd>>|Foreground color of unselected odd tabs.
|<<colors-tabs.bg.odd,tabs.bg.odd>>|Background color of unselected odd tabs.
2015-06-10 20:55:15 +02:00
|<<colors-tabs.fg.even,tabs.fg.even>>|Foreground color of unselected even tabs.
2014-11-26 21:16:27 +01:00
|<<colors-tabs.bg.even,tabs.bg.even>>|Background color of unselected even tabs.
2015-09-19 21:50:06 +02:00
|<<colors-tabs.fg.selected.odd,tabs.fg.selected.odd>>|Foreground color of selected odd tabs.
|<<colors-tabs.bg.selected.odd,tabs.bg.selected.odd>>|Background color of selected odd tabs.
|<<colors-tabs.fg.selected.even,tabs.fg.selected.even>>|Foreground color of selected even tabs.
|<<colors-tabs.bg.selected.even,tabs.bg.selected.even>>|Background color of selected even tabs.
2015-10-04 17:49:43 +02:00
|<<colors-tabs.bg.bar,tabs.bg.bar>>|Background color of the tab bar.
2014-11-26 21:16:27 +01:00
|<<colors-tabs.indicator.start,tabs.indicator.start>>|Color gradient start for the tab indicator.
|<<colors-tabs.indicator.stop,tabs.indicator.stop>>|Color gradient end for the tab indicator.
|<<colors-tabs.indicator.error,tabs.indicator.error>>|Color for the tab indicator on errors..
|<<colors-tabs.indicator.system,tabs.indicator.system>>|Color gradient interpolation system for the tab indicator.
2014-09-21 21:23:16 +02:00
|<<colors-hints.fg,hints.fg>>|Font color for hints.
2016-08-16 17:44:48 +02:00
|<<colors-hints.bg,hints.bg>>|Background color for hints. Note that you can use a `rgba(...)` value for transparency.
2015-06-10 20:55:15 +02:00
|<<colors-hints.fg.match,hints.fg.match>>|Font color for the matched part of hints.
2014-09-21 21:23:16 +02:00
|<<colors-downloads.bg.bar,downloads.bg.bar>>|Background color for the download bar.
2015-06-10 20:55:15 +02:00
|<<colors-downloads.fg.start,downloads.fg.start>>|Color gradient start for download text.
|<<colors-downloads.bg.start,downloads.bg.start>>|Color gradient start for download backgrounds.
|<<colors-downloads.fg.stop,downloads.fg.stop>>|Color gradient end for download text.
|<<colors-downloads.bg.stop,downloads.bg.stop>>|Color gradient stop for download backgrounds.
|<<colors-downloads.fg.system,downloads.fg.system>>|Color gradient interpolation system for download text.
|<<colors-downloads.bg.system,downloads.bg.system>>|Color gradient interpolation system for download backgrounds.
|<<colors-downloads.fg.error,downloads.fg.error>>|Foreground color for downloads with errors.
2014-10-26 19:48:26 +01:00
|<<colors-downloads.bg.error,downloads.bg.error>>|Background color for downloads with errors.
2015-06-01 22:29:49 +02:00
|<<colors-webpage.bg,webpage.bg>>|Background color for webpages if unset (or empty to use the theme's color)
2016-05-18 08:24:20 +02:00
|<<colors-keyhint.fg,keyhint.fg>>|Text color for the keyhint widget.
|<<colors-keyhint.fg.suffix,keyhint.fg.suffix>>|Highlight color for keys to complete the current keychain
|<<colors-keyhint.bg,keyhint.bg>>|Background color of the keyhint widget.
2014-09-07 23:22:38 +02:00
|==============
.Quick reference for section ``fonts''
[options="header",width="75%",cols="25%,75%"]
|==============
|Setting|Description
2014-09-21 21:23:16 +02:00
|<<fonts-_monospace,_monospace>>|Default monospace fonts.
|<<fonts-completion,completion>>|Font used in the completion widget.
2016-08-01 14:37:58 +02:00
|<<fonts-completion.category,completion.category>>|Font used in the completion categories.
2015-03-31 22:14:35 +02:00
|<<fonts-tabbar,tabbar>>|Font used in the tab bar.
2014-09-21 21:23:16 +02:00
|<<fonts-statusbar,statusbar>>|Font used in the statusbar.
|<<fonts-downloads,downloads>>|Font used for the downloadbar.
|<<fonts-hints,hints>>|Font used for the hints.
|<<fonts-debug-console,debug-console>>|Font used for the debugging console.
|<<fonts-web-family-standard,web-family-standard>>|Font family for standard fonts.
|<<fonts-web-family-fixed,web-family-fixed>>|Font family for fixed fonts.
|<<fonts-web-family-serif,web-family-serif>>|Font family for serif fonts.
|<<fonts-web-family-sans-serif,web-family-sans-serif>>|Font family for sans-serif fonts.
|<<fonts-web-family-cursive,web-family-cursive>>|Font family for cursive fonts.
|<<fonts-web-family-fantasy,web-family-fantasy>>|Font family for fantasy fonts.
|<<fonts-web-size-minimum,web-size-minimum>>|The hard minimum font size.
|<<fonts-web-size-minimum-logical,web-size-minimum-logical>>|The minimum logical font size that is applied when zooming out.
|<<fonts-web-size-default,web-size-default>>|The default font size for regular text.
|<<fonts-web-size-default-fixed,web-size-default-fixed>>|The default font size for fixed-pitch text.
2016-05-18 08:24:20 +02:00
|<<fonts-keyhint,keyhint>>|Font used in the keyhint widget.
2014-09-07 23:22:38 +02:00
|==============
== general
General/miscellaneous options.
[[general-ignore-case]]
=== ignore-case
Whether to find text on a page case-insensitively.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+: Search case-insensitively
* +false+: Search case-sensitively
* +smart+: Search case-sensitively if there are capital chars
2014-09-07 23:22:38 +02:00
Default: +pass:[smart]+
[[general-startpage]]
=== startpage
The default page(s) to open at the start, separated by commas.
2015-10-27 20:31:10 +01:00
Default: +pass:[https://duckduckgo.com]+
2014-09-07 23:22:38 +02:00
2016-09-06 18:17:55 +02:00
[[general-yank-ignored-url-parameters]]
=== yank-ignored-url-parameters
The URL parameters to strip with :yank url, separated by commas.
Default: +pass:[ref,utm_source,utm_medium,utm_campaign,utm_term,utm_content]+
2015-02-27 08:10:00 +01:00
[[general-default-page]]
=== default-page
2015-04-04 15:10:22 +02:00
The page to open if :open -t/-b/-w is used without URL. Use `about:blank` for a blank page.
2015-02-27 08:10:00 +01:00
Default: +pass:[${startpage}]+
2014-09-07 23:22:38 +02:00
[[general-auto-search]]
=== auto-search
Whether to start a search when something else than a URL is entered.
Valid values:
* +naive+: Use simple/naive check.
* +dns+: Use DNS requests (might be slow!).
* +false+: Never search automatically.
Default: +pass:[naive]+
[[general-auto-save-config]]
=== auto-save-config
Whether to save the config automatically on quit.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[true]+
2015-02-01 01:53:29 +01:00
[[general-auto-save-interval]]
=== auto-save-interval
How often (in milliseconds) to auto-save config/cookies/etc.
Default: +pass:[15000]+
2014-09-07 23:22:38 +02:00
[[general-editor]]
=== editor
The editor (and arguments) to use for the `open-editor` command.
2015-11-05 21:42:29 +01:00
The arguments get split like in a shell, so you can use `"` or `'` to quote them.
`{}` gets replaced by the filename of the file to be edited.
2014-09-07 23:22:38 +02:00
Default: +pass:[gvim -f "{}"]+
[[general-editor-encoding]]
=== editor-encoding
Encoding to use for editor.
Default: +pass:[utf-8]+
[[general-private-browsing]]
=== private-browsing
Do not record visited pages in the history or store web page icons.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[false]+
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2014-09-07 23:22:38 +02:00
[[general-developer-extras]]
=== developer-extras
Enable extra tools for Web developers.
This needs to be enabled for `:inspector` to work and also adds an _Inspect_ entry to the context menu.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[false]+
[[general-print-element-backgrounds]]
=== print-element-backgrounds
Whether the background color and images are also drawn when the page is printed.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[true]+
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2014-09-07 23:22:38 +02:00
[[general-xss-auditing]]
=== xss-auditing
Whether load requests should be monitored for cross-site scripting attempts.
Suspicious scripts will be blocked and reported in the inspector's JavaScript console. Enabling this feature might have an impact on performance.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[false]+
[[general-site-specific-quirks]]
=== site-specific-quirks
Enable workarounds for broken sites.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[true]+
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2014-09-07 23:22:38 +02:00
[[general-default-encoding]]
=== default-encoding
Default encoding to use for websites.
The encoding must be a string describing an encoding such as _utf-8_, _iso-8859-1_, etc. If left empty a default value will be used.
Default: empty
2014-10-26 19:48:26 +01:00
[[general-new-instance-open-target]]
=== new-instance-open-target
How to open links in an existing instance if a new one is launched.
Valid values:
2015-05-19 06:13:29 +02:00
* +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.
2014-10-26 19:48:26 +01:00
* +window+: Open in a new window.
2015-06-26 22:44:52 +02:00
Default: +pass:[tab]+
2014-10-26 19:48:26 +01:00
2016-08-10 09:13:35 +02:00
[[general-new-instance-open-target.window]]
=== new-instance-open-target.window
Which window to choose when opening links as new tabs.
Valid values:
2016-08-17 12:02:09 +02:00
* +first-opened+: Open new tabs in the first (oldest) opened window.
* +last-opened+: Open new tabs in the last (newest) opened window.
2016-08-10 09:13:35 +02:00
* +last-focused+: Open new tabs in the most recently focused window.
2016-08-10 17:40:27 +02:00
* +last-visible+: Open new tabs in the most recently visible window.
2016-08-10 09:13:35 +02:00
Default: +pass:[last-focused]+
2015-02-09 07:46:31 +01:00
[[general-log-javascript-console]]
=== log-javascript-console
2015-11-30 08:08:52 +01:00
How to log javascript console messages.
2015-02-09 07:46:31 +01:00
2015-02-17 07:45:06 +01:00
Valid values:
2015-11-30 08:08:52 +01:00
* +none+: Don't log messages.
* +debug+: Log messages with debug level.
* +info+: Log messages with info level.
2015-02-17 07:45:06 +01:00
2015-11-30 08:08:52 +01:00
Default: +pass:[debug]+
2015-02-17 07:45:06 +01:00
[[general-save-session]]
=== save-session
Whether to always save the open pages.
2015-02-09 07:46:31 +01:00
Valid values:
* +true+
* +false+
Default: +pass:[false]+
2015-04-05 23:30:43 +02:00
[[general-session-default-name]]
=== session-default-name
The name of the session to save by default, or empty for the last loaded session.
2015-04-05 23:35:00 +02:00
Default: empty
2015-04-05 23:30:43 +02:00
2015-09-30 19:49:17 +02:00
[[general-url-incdec-segments]]
=== url-incdec-segments
The URL segments where `:navigate increment/decrement` will search for a number.
Valid values:
* +host+
* +path+
* +query+
* +anchor+
Default: +pass:[path,query]+
2014-09-07 23:22:38 +02:00
== ui
General options related to the user interface.
[[ui-zoom-levels]]
=== zoom-levels
The available zoom levels, separated by commas.
Default: +pass:[25%,33%,50%,67%,75%,90%,100%,110%,125%,150%,175%,200%,250%,300%,400%,500%]+
[[ui-default-zoom]]
=== default-zoom
The default zoom level.
Default: +pass:[100%]+
2015-04-09 12:54:59 +02:00
[[ui-downloads-position]]
=== downloads-position
Where to show the downloaded files.
Valid values:
2015-08-05 23:33:58 +02:00
* +top+
* +bottom+
2015-04-09 12:54:59 +02:00
2015-08-05 23:33:58 +02:00
Default: +pass:[top]+
2015-04-09 12:54:59 +02:00
2016-07-04 19:05:44 +02:00
[[ui-status-position]]
=== status-position
The position of the status bar.
Valid values:
* +top+
* +bottom+
Default: +pass:[bottom]+
2014-09-07 23:22:38 +02:00
[[ui-message-timeout]]
=== message-timeout
Time (in ms) to show messages in the statusbar for.
Default: +pass:[2000]+
2015-03-22 23:52:08 +01:00
[[ui-message-unfocused]]
=== message-unfocused
Whether to show messages in unfocused windows.
Valid values:
* +true+
* +false+
Default: +pass:[false]+
2014-09-07 23:22:38 +02:00
[[ui-confirm-quit]]
=== confirm-quit
Whether to confirm quitting the application.
Valid values:
* +always+: Always show a confirmation.
* +multiple-tabs+: Show a confirmation if multiple tabs are opened.
2015-01-06 11:29:13 +01:00
* +downloads+: Show a confirmation if downloads are running
2014-09-07 23:22:38 +02:00
* +never+: Never show a confirmation.
Default: +pass:[never]+
[[ui-zoom-text-only]]
=== zoom-text-only
Whether the zoom factor on a frame applies only to the text or to all content.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[false]+
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2014-09-07 23:22:38 +02:00
[[ui-frame-flattening]]
=== frame-flattening
Whether to expand each subframe to its contents.
This will flatten all the frames to become one scrollable page.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[false]+
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2014-09-07 23:22:38 +02:00
[[ui-user-stylesheet]]
=== user-stylesheet
2015-06-08 18:54:07 +02:00
User stylesheet to use (absolute filename, filename relative to the config directory or CSS string). Will expand environment variables.
2014-09-07 23:22:38 +02:00
2016-08-15 19:35:50 +02:00
Default: +pass:[html > ::-webkit-scrollbar { width: 0px; height: 0px; }]+
2014-09-07 23:22:38 +02:00
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2014-09-07 23:22:38 +02:00
[[ui-css-media-type]]
=== css-media-type
Set the CSS media type.
Default: empty
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2015-05-15 23:53:08 +02:00
[[ui-smooth-scrolling]]
=== smooth-scrolling
Whether to enable smooth scrolling for webpages.
Valid values:
* +true+
* +false+
Default: +pass:[false]+
2014-12-10 20:53:50 +01:00
[[ui-remove-finished-downloads]]
=== remove-finished-downloads
2015-11-02 17:59:43 +01:00
Number of milliseconds to wait before removing finished downloads. Will not be removed if value is -1.
2014-12-10 20:53:50 +01:00
2015-11-02 17:59:43 +01:00
Default: +pass:[-1]+
2014-12-10 20:53:50 +01:00
2015-01-25 22:43:13 +01:00
[[ui-hide-statusbar]]
=== hide-statusbar
Whether to hide the statusbar unless a message is shown.
Valid values:
* +true+
* +false+
Default: +pass:[false]+
2015-08-27 22:13:30 +02:00
[[ui-statusbar-padding]]
=== statusbar-padding
Padding for statusbar (top, bottom, left, right).
Default: +pass:[1,1,0,0]+
2015-01-28 08:40:16 +01:00
[[ui-window-title-format]]
=== window-title-format
The format to use for the window title. The following placeholders are defined:
* `{perc}`: The percentage as a string like `[10%]`.
* `{perc_raw}`: The raw percentage, e.g. `10`
2015-03-31 22:14:35 +02:00
* `{title}`: The title of the current web page
2015-01-28 08:40:16 +01:00
* `{title_sep}`: The string ` - ` if a title is set, empty otherwise.
2015-02-14 00:29:12 +01:00
* `{id}`: The internal window ID of this window.
2015-09-30 21:32:48 +02:00
* `{scroll_pos}`: The page scroll position.
2016-06-10 20:45:36 +02:00
* `{host}`: The host of the current web page.
2015-01-28 08:40:16 +01:00
Default: +pass:[{perc}{title}{title_sep}qutebrowser]+
2015-05-31 21:41:32 +02:00
[[ui-modal-js-dialog]]
=== modal-js-dialog
Use standard JavaScript modal dialog for alert() and confirm()
Valid values:
* +true+
* +false+
Default: +pass:[false]+
2015-09-16 08:52:51 +02:00
[[ui-hide-wayland-decoration]]
=== hide-wayland-decoration
Hide the window decoration when using wayland (requires restart)
Valid values:
* +true+
* +false+
Default: +pass:[false]+
2016-05-25 22:05:06 +02:00
[[ui-keyhint-blacklist]]
=== keyhint-blacklist
Keychains that shouldn't be shown in the keyhint dialog
2016-05-18 08:24:20 +02:00
2016-05-25 22:05:06 +02:00
Globs are supported, so ';*' will blacklist all keychainsstarting with ';'. Use '*' to disable keyhints
2016-05-18 08:24:20 +02:00
2016-05-25 22:05:06 +02:00
Default: empty
2016-05-18 08:24:20 +02:00
2014-09-07 23:22:38 +02:00
== network
Settings related to the network.
[[network-do-not-track]]
=== do-not-track
Value to send in the `DNT` header.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[true]+
[[network-accept-language]]
=== accept-language
Value to send in the `accept-language` header.
Default: +pass:[en-US,en]+
2015-08-01 13:35:54 +02:00
[[network-referer-header]]
=== referer-header
Send the Referer header
Valid values:
* +always+: Always send.
* +never+: Never send; this is not recommended, as some sites may break.
* +same-domain+: Only send for the same domain. This will still protect your privacy, but shouldn't break any sites.
Default: +pass:[same-domain]+
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2014-09-07 23:22:38 +02:00
[[network-user-agent]]
=== user-agent
User agent to send. Empty to send the default.
Default: empty
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2014-09-07 23:22:38 +02:00
[[network-proxy]]
=== proxy
The proxy to use.
In addition to the listed values, you can use a `socks://...` or `http://...` URL.
Valid values:
* +system+: Use the system wide proxy.
* +none+: Don't use any proxy
Default: +pass:[system]+
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2014-12-16 23:34:19 +01:00
[[network-proxy-dns-requests]]
=== proxy-dns-requests
Whether to send DNS requests over the configured proxy.
Valid values:
* +true+
* +false+
Default: +pass:[true]+
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2014-09-07 23:22:38 +02:00
[[network-ssl-strict]]
=== ssl-strict
Whether to validate SSL handshakes.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
* +ask+
2014-11-30 21:58:26 +01:00
Default: +pass:[ask]+
2014-09-07 23:22:38 +02:00
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2014-09-07 23:22:38 +02:00
[[network-dns-prefetch]]
=== dns-prefetch
Whether to try to pre-fetch DNS entries to speed up browsing.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[true]+
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2016-04-19 09:40:39 +02:00
[[network-custom-headers]]
=== custom-headers
Set custom headers for qutebrowser HTTP requests.
Default: empty
2014-09-07 23:22:38 +02:00
== completion
Options related to completion and command history.
2016-08-29 07:14:44 +02:00
[[completion-show]]
=== show
When to show the autocompletion window.
2015-06-27 19:59:06 +02:00
Valid values:
2016-08-29 07:14:44 +02:00
* +always+: Whenever a completion is available.
* +auto+: Whenever a completion is requested.
* +never+: Never.
2015-06-27 19:59:06 +02:00
2016-08-29 07:14:44 +02:00
Default: +pass:[always]+
2015-06-27 19:59:06 +02:00
2015-03-06 16:57:58 +01:00
[[completion-download-path-suggestion]]
=== download-path-suggestion
What to display in the download filename input.
Valid values:
* +path+: Show only the download path.
* +filename+: Show only download filename.
* +both+: Show download path and filename.
Default: +pass:[path]+
2015-03-12 15:25:39 +01:00
[[completion-timestamp-format]]
=== timestamp-format
How to format timestamps (e.g. for history)
Default: +pass:[%Y-%m-%d]+
2014-09-07 23:22:38 +02:00
[[completion-height]]
=== height
The height of the completion, in px or as percentage of the window.
Default: +pass:[50%]+
2015-03-13 19:50:20 +01:00
[[completion-cmd-history-max-items]]
=== cmd-history-max-items
How many commands to save in the command history.
2014-09-07 23:22:38 +02:00
0: no history / -1: unlimited
Default: +pass:[100]+
2015-03-13 19:50:20 +01:00
[[completion-web-history-max-items]]
=== web-history-max-items
How many URLs to show in the web history.
0: no history / -1: unlimited
Default: +pass:[1000]+
2014-09-07 23:22:38 +02:00
[[completion-quick-complete]]
=== quick-complete
Whether to move on to the next part when there's only one possible completion left.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[true]+
[[completion-shrink]]
=== shrink
Whether to shrink the completion to be smaller than the configured size if there are no scrollbars.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[false]+
2015-10-19 05:18:30 +02:00
[[completion-scrollbar-width]]
=== scrollbar-width
Width of the scrollbar in the completion window (in px).
Default: +pass:[12]+
[[completion-scrollbar-padding]]
=== scrollbar-padding
Padding of scrollbar handle in completion window (in px).
Default: +pass:[2]+
2014-09-07 23:22:38 +02:00
== input
Options related to input modes.
[[input-timeout]]
=== timeout
2016-08-08 19:56:24 +02:00
Timeout (in milliseconds) for ambiguous key bindings.
2014-09-07 23:22:38 +02:00
2016-04-26 05:27:58 +02:00
If the current input forms both a complete match and a partial match, the complete match will be executed after this time.
2014-09-07 23:22:38 +02:00
Default: +pass:[500]+
2015-02-27 12:46:13 +01:00
[[input-partial-timeout]]
=== partial-timeout
2016-08-08 19:56:24 +02:00
Timeout (in milliseconds) for partially typed key bindings.
2015-02-27 12:46:13 +01:00
2016-04-26 05:27:58 +02:00
If the current input forms only partial matches, the keystring will be cleared after this time.
2016-05-18 08:24:20 +02:00
Default: +pass:[5000]+
2015-02-27 12:46:13 +01:00
2014-09-07 23:22:38 +02:00
[[input-insert-mode-on-plugins]]
=== insert-mode-on-plugins
Whether to switch to insert mode when clicking flash and other plugins.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[false]+
[[input-auto-leave-insert-mode]]
=== auto-leave-insert-mode
Whether to leave insert mode if a non-editable element is clicked.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[true]+
[[input-auto-insert-mode]]
=== auto-insert-mode
Whether to automatically enter insert mode if an editable element is focused after page load.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[false]+
[[input-forward-unbound-keys]]
=== forward-unbound-keys
Whether to forward unbound keys to the webview in normal mode.
Valid values:
* +all+: Forward all unbound keys.
* +auto+: Forward unbound non-alphanumeric keys.
* +none+: Don't forward any keys.
Default: +pass:[auto]+
[[input-spatial-navigation]]
=== spatial-navigation
2015-08-20 11:10:52 +02:00
Enables or disables the Spatial Navigation feature.
2014-09-07 23:22:38 +02:00
Spatial navigation consists in the ability to navigate between focusable elements in a Web page, such as hyperlinks and form controls, by using Left, Right, Up and Down arrow keys. For example, if a user presses the Right key, heuristics determine whether there is an element he might be trying to reach towards the right and which element he probably wants.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[false]+
[[input-links-included-in-focus-chain]]
=== links-included-in-focus-chain
Whether hyperlinks should be included in the keyboard focus chain.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[true]+
2015-03-03 12:56:40 +01:00
[[input-rocker-gestures]]
=== rocker-gestures
Whether to enable Opera-like mouse rocker gestures. This disables the context menu.
Valid values:
* +true+
* +false+
Default: +pass:[false]+
2015-03-30 15:26:07 +02:00
[[input-mouse-zoom-divider]]
=== mouse-zoom-divider
How much to divide the mouse wheel movements to translate them into zoom increments.
Default: +pass:[512]+
2014-09-07 23:22:38 +02:00
== tabs
Configuration of the tab bar.
[[tabs-background-tabs]]
=== background-tabs
Whether to open new tabs (middleclick/ctrl+click) in background.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[false]+
[[tabs-select-on-remove]]
=== select-on-remove
Which tab to select when the focused tab is removed.
Valid values:
* +left+: Select the tab on the left.
* +right+: Select the tab on the right.
* +previous+: Select the previously selected tab.
Default: +pass:[right]+
[[tabs-new-tab-position]]
=== new-tab-position
How new tabs are positioned.
Valid values:
* +left+: On the left of the current tab.
* +right+: On the right of the current tab.
* +first+: At the left end.
* +last+: At the right end.
Default: +pass:[right]+
[[tabs-new-tab-position-explicit]]
=== new-tab-position-explicit
2015-03-31 20:49:29 +02:00
How new tabs opened explicitly are positioned.
2014-09-07 23:22:38 +02:00
Valid values:
* +left+: On the left of the current tab.
* +right+: On the right of the current tab.
* +first+: At the left end.
* +last+: At the right end.
Default: +pass:[last]+
[[tabs-last-close]]
=== last-close
2015-06-07 10:47:53 +02:00
Behavior when the last tab is closed.
2014-09-07 23:22:38 +02:00
Valid values:
* +ignore+: Don't do anything.
* +blank+: Load a blank page.
2015-04-07 17:35:53 +02:00
* +startpage+: Load the start page.
* +default-page+: Load the default page.
2014-10-07 20:32:17 +02:00
* +close+: Close the window.
2014-09-07 23:22:38 +02:00
Default: +pass:[ignore]+
2015-08-01 22:43:20 +02:00
[[tabs-show]]
=== show
When to show the tab bar
2014-09-22 21:01:58 +02:00
2014-11-30 22:16:31 +01:00
Valid values:
2015-08-01 22:43:20 +02:00
* +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.
2015-01-24 18:10:45 +01:00
2015-08-01 22:43:20 +02:00
Default: +pass:[always]+
2015-01-24 18:10:45 +01:00
2015-08-01 22:43:20 +02:00
[[tabs-show-switching-delay]]
=== show-switching-delay
Time to show the tab bar before hiding it when tabs->show is set to 'switching'.
2015-01-24 18:10:45 +01:00
2015-08-01 22:43:20 +02:00
Default: +pass:[800]+
2015-01-24 18:10:45 +01:00
2014-09-07 23:22:38 +02:00
[[tabs-wrap]]
=== wrap
Whether to wrap when changing tabs.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[true]+
[[tabs-movable]]
=== movable
Whether tabs should be movable.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[true]+
[[tabs-close-mouse-button]]
=== close-mouse-button
On which mouse button to close tabs.
Valid values:
* +right+: Close tabs on right-click.
* +middle+: Close tabs on middle-click.
* +none+: Don't close tabs using the mouse.
Default: +pass:[middle]+
[[tabs-position]]
=== position
The position of the tab bar.
Valid values:
2015-08-05 23:33:58 +02:00
* +top+
* +bottom+
* +left+
* +right+
2014-09-07 23:22:38 +02:00
2015-08-05 23:33:58 +02:00
Default: +pass:[top]+
2014-09-07 23:22:38 +02:00
[[tabs-show-favicons]]
=== show-favicons
Whether to show favicons in the tab bar.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[true]+
[[tabs-width]]
=== width
The width of the tab bar if it's vertical, in px or as percentage of the window.
Default: +pass:[20%]+
[[tabs-indicator-width]]
=== indicator-width
Width of the progress indicator (0 to disable).
Default: +pass:[3]+
2014-11-23 21:27:46 +01:00
[[tabs-tabs-are-windows]]
=== tabs-are-windows
Whether to open windows instead of tabs.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-11-23 21:27:46 +01:00
Default: +pass:[false]+
2015-02-14 00:29:12 +01:00
[[tabs-title-format]]
=== title-format
The format to use for the tab title. The following placeholders are defined:
* `{perc}`: The percentage as a string like `[10%]`.
* `{perc_raw}`: The raw percentage, e.g. `10`
2015-03-31 22:14:35 +02:00
* `{title}`: The title of the current web page
2015-02-14 00:29:12 +01:00
* `{title_sep}`: The string ` - ` if a title is set, empty otherwise.
* `{index}`: The index of this tab.
* `{id}`: The internal tab ID of this tab.
2015-09-30 21:32:48 +02:00
* `{scroll_pos}`: The page scroll position.
2016-06-10 20:45:36 +02:00
* `{host}`: The host of the current web page.
2015-02-14 00:29:12 +01:00
Default: +pass:[{index}: {title}]+
2015-12-07 21:13:30 +01:00
[[tabs-title-alignment]]
=== title-alignment
Alignment of the text inside of tabs
Valid values:
* +left+
* +right+
* +center+
Default: +pass:[left]+
2015-05-25 15:23:14 +02:00
[[tabs-mousewheel-tab-switching]]
=== mousewheel-tab-switching
Switch between tabs using the mouse wheel.
Valid values:
* +true+
* +false+
Default: +pass:[true]+
2015-08-01 00:19:04 +02:00
[[tabs-padding]]
=== padding
2015-08-01 00:35:59 +02:00
Padding for tabs (top, bottom, left, right).
2015-08-01 00:19:04 +02:00
Default: +pass:[0,0,5,5]+
[[tabs-indicator-padding]]
=== indicator-padding
2015-08-01 00:35:59 +02:00
Padding for indicators (top, bottom, left, right).
2015-08-01 00:19:04 +02:00
Default: +pass:[2,2,0,4]+
2014-09-07 23:22:38 +02:00
== storage
Settings related to cache and storage.
[[storage-download-directory]]
=== download-directory
2015-02-18 16:16:54 +01:00
The directory to save downloads to. An empty value selects a sensible os-specific default. Will expand environment variables.
2014-09-07 23:22:38 +02:00
Default: empty
2015-08-06 18:58:09 +02:00
[[storage-prompt-download-directory]]
=== prompt-download-directory
Whether to prompt the user for the download location.
If set to false, 'download-directory' will be used.
Valid values:
* +true+
* +false+
Default: +pass:[true]+
2015-08-01 14:19:06 +02:00
[[storage-remember-download-directory]]
=== remember-download-directory
Whether to remember the last used download directory.
Valid values:
* +true+
* +false+
Default: +pass:[true]+
2014-09-07 23:22:38 +02:00
[[storage-maximum-pages-in-cache]]
=== maximum-pages-in-cache
2015-04-04 15:30:58 +02:00
The maximum number of pages to hold in the global memory page cache.
2014-09-07 23:22:38 +02:00
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: http://webkit.org/blog/427/webkit-page-cache-i-the-basics/
Default: empty
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2014-09-07 23:22:38 +02:00
[[storage-object-cache-capacities]]
=== object-cache-capacities
2015-04-04 15:30:58 +02:00
The capacities for the global memory cache for dead objects such as stylesheets or scripts. Syntax: cacheMinDeadCapacity, cacheMaxDead, totalCapacity.
2014-09-07 23:22:38 +02:00
The _cacheMinDeadCapacity_ specifies the minimum number of bytes that dead objects should consume when the cache is under pressure.
_cacheMaxDead_ is the maximum number of bytes that dead objects should consume when the cache is *not* under pressure.
_totalCapacity_ specifies the maximum number of bytes that the cache should consume *overall*.
Default: empty
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2014-09-07 23:22:38 +02:00
[[storage-offline-storage-default-quota]]
=== offline-storage-default-quota
Default quota for new offline storage databases.
Default: empty
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2014-09-07 23:22:38 +02:00
[[storage-offline-web-application-cache-quota]]
=== offline-web-application-cache-quota
Quota for the offline web application cache.
Default: empty
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2014-09-07 23:22:38 +02:00
[[storage-offline-storage-database]]
=== offline-storage-database
Whether support for the HTML 5 offline storage feature is enabled.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[true]+
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2014-09-07 23:22:38 +02:00
[[storage-offline-web-application-storage]]
=== offline-web-application-storage
Whether support for the HTML 5 web application cache feature is enabled.
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.
The feature is described in details at: http://dev.w3.org/html5/spec/Overview.html#appcache
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[true]+
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2014-09-07 23:22:38 +02:00
[[storage-local-storage]]
=== local-storage
Whether support for the HTML 5 local storage feature is enabled.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[true]+
[[storage-cache-size]]
=== cache-size
Size of the HTTP network cache.
Default: +pass:[52428800]+
2014-11-26 21:16:27 +01:00
== content
2014-09-07 23:22:38 +02:00
Loaded plugins/scripts and allowed actions.
2014-11-26 21:16:27 +01:00
[[content-allow-images]]
2014-09-07 23:22:38 +02:00
=== allow-images
Whether images are automatically loaded in web pages.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[true]+
2014-11-26 21:16:27 +01:00
[[content-allow-javascript]]
2014-09-07 23:22:38 +02:00
=== allow-javascript
Enables or disables the running of JavaScript programs.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[true]+
2014-11-26 21:16:27 +01:00
[[content-allow-plugins]]
2014-09-07 23:22:38 +02:00
=== allow-plugins
Enables or disables plugins in Web pages.
Qt plugins with a mimetype such as "application/x-qt-plugin" are not affected by this setting.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[false]+
2015-05-16 00:31:13 +02:00
[[content-webgl]]
=== webgl
2016-08-04 21:33:53 +02:00
Enables or disables WebGL. For QtWebEngine, Qt/PyQt >= 5.7 is required for this setting.
2015-05-16 00:31:13 +02:00
Valid values:
* +true+
* +false+
2016-05-03 06:51:24 +02:00
Default: +pass:[false]+
2015-05-16 00:31:13 +02:00
2015-05-16 00:39:20 +02:00
[[content-css-regions]]
=== css-regions
Enable or disable support for CSS regions.
Valid values:
* +true+
* +false+
Default: +pass:[true]+
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2015-05-16 00:42:26 +02:00
[[content-hyperlink-auditing]]
=== hyperlink-auditing
Enable or disable hyperlink auditing (<a ping>).
Valid values:
* +true+
* +false+
Default: +pass:[false]+
2015-02-10 21:09:08 +01:00
[[content-geolocation]]
=== geolocation
Allow websites to request geolocations.
Valid values:
2015-05-06 22:46:41 +02:00
* +true+
2015-02-10 21:09:08 +01:00
* +false+
* +ask+
Default: +pass:[ask]+
[[content-notifications]]
=== notifications
Allow websites to show notifications.
Valid values:
2015-05-06 22:46:41 +02:00
* +true+
2015-02-10 21:09:08 +01:00
* +false+
* +ask+
Default: +pass:[ask]+
2016-09-05 17:09:14 +02:00
[[content-javascript-can-open-windows-automatically]]
=== javascript-can-open-windows-automatically
Whether JavaScript programs can open new windows without user interaction.
2014-09-07 23:22:38 +02:00
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[false]+
2014-11-26 21:16:27 +01:00
[[content-javascript-can-close-windows]]
2014-09-07 23:22:38 +02:00
=== javascript-can-close-windows
Whether JavaScript programs can close windows.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[false]+
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2014-11-26 21:16:27 +01:00
[[content-javascript-can-access-clipboard]]
2014-09-07 23:22:38 +02:00
=== javascript-can-access-clipboard
Whether JavaScript programs can read or write to the clipboard.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[false]+
2015-02-17 19:03:18 +01:00
[[content-ignore-javascript-prompt]]
=== ignore-javascript-prompt
Whether all javascript prompts should be ignored.
Valid values:
* +true+
* +false+
Default: +pass:[false]+
[[content-ignore-javascript-alert]]
=== ignore-javascript-alert
Whether all javascript alerts should be ignored.
Valid values:
* +true+
* +false+
Default: +pass:[false]+
2014-11-26 21:16:27 +01:00
[[content-local-content-can-access-remote-urls]]
2014-09-07 23:22:38 +02:00
=== local-content-can-access-remote-urls
Whether locally loaded documents are allowed to access remote urls.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[false]+
2014-11-26 21:16:27 +01:00
[[content-local-content-can-access-file-urls]]
2014-09-07 23:22:38 +02:00
=== local-content-can-access-file-urls
Whether locally loaded documents are allowed to access other local urls.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[true]+
2014-11-26 21:16:27 +01:00
[[content-cookies-accept]]
2014-09-07 23:22:38 +02:00
=== cookies-accept
2015-06-05 15:57:43 +02:00
Control which cookies to accept.
2014-09-07 23:22:38 +02:00
Valid values:
2015-06-05 15:57:43 +02:00
* +all+: Accept all cookies.
* +no-3rdparty+: Accept cookies from the same origin only.
* +no-unknown-3rdparty+: Accept cookies from the same origin only, unless a cookie is already set for the domain.
2014-09-07 23:22:38 +02:00
* +never+: Don't accept cookies at all.
2015-06-05 15:57:43 +02:00
Default: +pass:[no-3rdparty]+
2014-09-07 23:22:38 +02:00
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2014-11-26 21:16:27 +01:00
[[content-cookies-store]]
2014-09-07 23:22:38 +02:00
=== cookies-store
Whether to store cookies.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-09-07 23:22:38 +02:00
Default: +pass:[true]+
2016-08-03 11:35:08 +02:00
This setting is only available with the QtWebKit backend.
2014-11-26 21:16:27 +01:00
[[content-host-block-lists]]
2014-11-24 21:05:09 +01:00
=== host-block-lists
List of URLs of lists which contain hosts to block.
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).
2015-01-04 13:37:09 +01:00
Default: +pass:[http://www.malwaredomainlist.com/hostslist/hosts.txt,http://someonewhocares.org/hosts/hosts,http://winhelp2002.mvps.org/hosts.zip,http://malwaredomains.lehigh.edu/files/justdomains.zip,http://pgl.yoyo.org/adservers/serverlist.php?hostformat=hosts&mimetype=plaintext]+
2014-11-24 21:05:09 +01:00
2015-03-30 18:32:32 +02:00
[[content-host-blocking-enabled]]
=== host-blocking-enabled
Whether host blocking is enabled.
Valid values:
* +true+
* +false+
Default: +pass:[true]+
2015-09-16 16:31:17 +02:00
[[content-host-blocking-whitelist]]
=== host-blocking-whitelist
List of domains that should always be loaded, despite being ad-blocked.
Domains may contain * and ? wildcards and are otherwise required to exactly match the requested domain.
Local domains are always exempt from hostblocking.
2015-09-17 06:53:28 +02:00
Default: +pass:[piwik.org]+
2015-09-16 16:31:17 +02:00
2016-01-05 07:32:50 +01:00
[[content-enable-pdfjs]]
=== enable-pdfjs
Enable pdf.js to view PDF files in the browser.
Note that the files can still be downloaded by clicking the download button in the pdf.js viewer.
Valid values:
* +true+
* +false+
Default: +pass:[false]+
2014-09-07 23:22:38 +02:00
== hints
Hinting settings.
[[hints-border]]
=== border
CSS border value for hints.
Default: +pass:[1px solid #E3BE23]+
[[hints-mode]]
=== mode
Mode to use for hints.
Valid values:
* +number+: Use numeric hints.
* +letter+: Use the chars in the hints -> chars setting.
2016-02-02 18:59:00 +01:00
* +word+: Use hints words based on the html elements and the extra words.
2014-09-07 23:22:38 +02:00
Default: +pass:[letter]+
[[hints-chars]]
=== chars
Chars used for hint strings.
Default: +pass:[asdfghjkl]+
2015-02-26 06:13:58 +01:00
[[hints-min-chars]]
=== min-chars
2015-10-04 15:41:42 +02:00
Minimum number of chars used for hint strings.
2015-02-26 06:13:58 +01:00
Default: +pass:[1]+
2015-03-10 21:19:47 +01:00
[[hints-scatter]]
=== scatter
2016-06-07 15:43:17 +02:00
Whether to scatter hint key chains (like Vimium) or not (like dwb). Ignored for number hints.
2015-03-10 21:19:47 +01:00
Valid values:
* +true+
* +false+
Default: +pass:[true]+
2014-10-27 06:53:10 +01:00
[[hints-uppercase]]
=== uppercase
Make chars in hint strings uppercase.
2014-11-30 22:16:31 +01:00
Valid values:
* +true+
* +false+
2014-10-27 06:53:10 +01:00
Default: +pass:[false]+
2016-02-02 18:59:00 +01:00
[[hints-dictionary]]
=== dictionary
The dictionary file to be used by the word hints.
Default: +pass:[/usr/share/dict/words]+
2014-09-07 23:22:38 +02:00
[[hints-auto-follow]]
=== auto-follow
2016-08-16 12:59:54 +02:00
Controls when a hint can be automatically followed without the user pressing Enter.
2014-09-07 23:22:38 +02:00
2014-11-30 22:16:31 +01:00
Valid values:
2016-08-16 12:59:54 +02:00
* +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.
2014-11-30 22:16:31 +01:00
2016-08-16 12:59:54 +02:00
Default: +pass:[unique-match]+
2014-09-07 23:22:38 +02:00
2016-06-07 15:43:17 +02:00
[[hints-auto-follow-timeout]]
=== auto-follow-timeout
2016-08-08 19:56:24 +02:00
A timeout (in milliseconds) to inhibit normal-mode key bindings after a successful auto-follow.
2016-06-07 15:43:17 +02:00
Default: +pass:[0]+
2014-09-07 23:22:38 +02:00
[[hints-next-regexes]]
=== next-regexes
A comma-separated list of regexes to use for 'next' links.
2015-06-07 17:38:27 +02:00
Default: +pass:[\bnext\b,\bmore\b,\bnewer\b,\b[>→≫]\b,\b(>>|»)\b,\bcontinue\b]+
2014-09-07 23:22:38 +02:00
[[hints-prev-regexes]]
=== prev-regexes
A comma-separated list of regexes to use for 'prev' links.
Default: +pass:[\bprev(ious)?\b,\bback\b,\bolder\b,\b[<←≪]\b,\b(<<|«)\b]+
2016-06-09 15:40:22 +02:00
[[hints-find-implementation]]
=== find-implementation
Which implementation to use to find elements to hint.
Valid values:
* +javascript+: Better but slower
* +python+: Slightly worse but faster
2016-08-03 11:35:08 +02:00
Default: +pass:[python]+
2016-06-09 15:40:22 +02:00
2016-08-09 16:44:00 +02:00
[[hints-hide-unmatched-rapid-hints]]
=== hide-unmatched-rapid-hints
Controls hiding unmatched hints in rapid mode.
Valid values:
* +true+
* +false+
Default: +pass:[true]+
2014-09-07 23:22:38 +02:00
== searchengines
Definitions of search engines which can be used via the address bar.
2015-04-03 20:54:27 +02:00
The searchengine named `DEFAULT` is used when `general -> auto-search` is true 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`. The string `{}` will be replaced by the search term, use `{{` and `}}` for literal `{`/`}` signs.
2014-09-07 23:22:38 +02:00
== aliases
Aliases for commands.
By default, no aliases are defined. Example which adds a new command `:qtb` to open qutebrowsers website:
`qtb = open http://www.qutebrowser.org/`
== colors
Colors used in the UI.
A value can be in one of the following format:
* `#RGB`/`#RRGGBB`/`#RRRGGGBBB`/`#RRRRGGGGBBBB`
2016-07-05 08:34:03 +02:00
* An SVG color name as specified in http://www.w3.org/TR/SVG/types.html#ColorKeywords[the W3C specification].
2014-09-07 23:22:38 +02:00
* transparent (no color)
* `rgb(r, g, b)` / `rgba(r, g, b, a)` (values 0-255 or percentages)
* `hsv(h, s, v)` / `hsva(h, s, v, a)` (values 0-255, hue 0-359)
2015-06-12 16:59:33 +02:00
* A gradient as explained in http://doc.qt.io/qt-5/stylesheet-reference.html#list-of-property-types[the Qt documentation] under ``Gradient''.
2014-09-07 23:22:38 +02:00
2015-06-10 20:55:15 +02:00
A *.system value determines the color system to use for color interpolation between similarly-named *.start and *.stop entries, regardless of how they are defined in the options. Valid values are 'rgb', 'hsv', and 'hsl'.
2014-09-07 23:22:38 +02:00
The `hints.*` values are a special case as they're real CSS colors, not Qt-CSS colors. There, for a gradient, you need to use `-webkit-gradient`, see https://www.webkit.org/blog/175/introducing-css-gradients/[the WebKit documentation].
[[colors-completion.fg]]
=== completion.fg
Text color of the completion widget.
Default: +pass:[white]+
[[colors-completion.bg]]
=== completion.bg
Background color of the completion widget.
Default: +pass:[#333333]+
2015-03-15 23:25:57 +01:00
[[colors-completion.alternate-bg]]
=== completion.alternate-bg
Alternating background color of the completion widget.
Default: +pass:[#444444]+
2014-09-07 23:22:38 +02:00
[[colors-completion.category.fg]]
=== completion.category.fg
Foreground color of completion widget category headers.
Default: +pass:[white]+
[[colors-completion.category.bg]]
=== completion.category.bg
Background color of the completion widget category headers.
Default: +pass:[qlineargradient(x1:0, y1:0, x2:0, y2:1, stop:0 #888888, stop:1 #505050)]+
[[colors-completion.category.border.top]]
=== completion.category.border.top
Top border color of the completion widget category headers.
Default: +pass:[black]+
[[colors-completion.category.border.bottom]]
=== completion.category.border.bottom
Bottom border color of the completion widget category headers.
Default: +pass:[${completion.category.border.top}]+
[[colors-completion.item.selected.fg]]
=== completion.item.selected.fg
Foreground color of the selected completion item.
Default: +pass:[black]+
[[colors-completion.item.selected.bg]]
=== completion.item.selected.bg
Background color of the selected completion item.
Default: +pass:[#e8c000]+
[[colors-completion.item.selected.border.top]]
=== completion.item.selected.border.top
Top border color of the completion widget category headers.
Default: +pass:[#bbbb00]+
[[colors-completion.item.selected.border.bottom]]
=== completion.item.selected.border.bottom
Bottom border color of the selected completion item.
Default: +pass:[${completion.item.selected.border.top}]+
[[colors-completion.match.fg]]
=== completion.match.fg
Foreground color of the matched text in the completion.
Default: +pass:[#ff4444]+
2015-10-19 05:18:30 +02:00
[[colors-completion.scrollbar.fg]]
=== completion.scrollbar.fg
Color of the scrollbar handle in completion view.
Default: +pass:[${completion.fg}]+
[[colors-completion.scrollbar.bg]]
=== completion.scrollbar.bg
Color of the scrollbar in completion view
Default: +pass:[${completion.bg}]+
2015-06-10 20:55:15 +02:00
[[colors-statusbar.fg]]
=== statusbar.fg
Foreground color of the statusbar.
Default: +pass:[white]+
2014-09-07 23:22:38 +02:00
[[colors-statusbar.bg]]
=== statusbar.bg
2015-10-15 18:34:56 +02:00
Background color of the statusbar.
2014-09-07 23:22:38 +02:00
Default: +pass:[black]+
2015-06-10 20:55:15 +02:00
[[colors-statusbar.fg.error]]
=== statusbar.fg.error
Foreground color of the statusbar if there was an error.
2014-09-07 23:22:38 +02:00
2015-06-10 20:55:15 +02:00
Default: +pass:[${statusbar.fg}]+
2014-09-07 23:22:38 +02:00
[[colors-statusbar.bg.error]]
=== statusbar.bg.error
Background color of the statusbar if there was an error.
Default: +pass:[red]+
2015-06-10 20:55:15 +02:00
[[colors-statusbar.fg.warning]]
=== statusbar.fg.warning
Foreground color of the statusbar if there is a warning.
Default: +pass:[${statusbar.fg}]+
2015-01-15 21:27:36 +01:00
[[colors-statusbar.bg.warning]]
=== statusbar.bg.warning
Background color of the statusbar if there is a warning.
Default: +pass:[darkorange]+
2015-06-10 20:55:15 +02:00
[[colors-statusbar.fg.prompt]]
=== statusbar.fg.prompt
Foreground color of the statusbar if there is a prompt.
Default: +pass:[${statusbar.fg}]+
2014-09-07 23:22:38 +02:00
[[colors-statusbar.bg.prompt]]
=== statusbar.bg.prompt
Background color of the statusbar if there is a prompt.
Default: +pass:[darkblue]+
2015-06-10 20:55:15 +02:00
[[colors-statusbar.fg.insert]]
=== statusbar.fg.insert
Foreground color of the statusbar in insert mode.
Default: +pass:[${statusbar.fg}]+
2014-09-07 23:22:38 +02:00
[[colors-statusbar.bg.insert]]
=== statusbar.bg.insert
Background color of the statusbar in insert mode.
Default: +pass:[darkgreen]+
2015-06-10 20:55:15 +02:00
[[colors-statusbar.fg.command]]
=== statusbar.fg.command
Foreground color of the statusbar in command mode.
Default: +pass:[${statusbar.fg}]+
[[colors-statusbar.bg.command]]
=== statusbar.bg.command
Background color of the statusbar in command mode.
Default: +pass:[${statusbar.bg}]+
[[colors-statusbar.fg.caret]]
=== statusbar.fg.caret
Foreground color of the statusbar in caret mode.
Default: +pass:[${statusbar.fg}]+
2015-05-18 22:34:21 +02:00
[[colors-statusbar.bg.caret]]
=== statusbar.bg.caret
Background color of the statusbar in caret mode.
Default: +pass:[purple]+
2015-06-10 20:55:15 +02:00
[[colors-statusbar.fg.caret-selection]]
=== statusbar.fg.caret-selection
Foreground color of the statusbar in caret mode with a selection
Default: +pass:[${statusbar.fg}]+
2015-05-18 22:34:21 +02:00
[[colors-statusbar.bg.caret-selection]]
=== statusbar.bg.caret-selection
Background color of the statusbar in caret mode with a selection
Default: +pass:[#a12dff]+
2014-09-07 23:22:38 +02:00
[[colors-statusbar.progress.bg]]
=== statusbar.progress.bg
Background color of the progress bar.
Default: +pass:[white]+
[[colors-statusbar.url.fg]]
=== statusbar.url.fg
Default foreground color of the URL in the statusbar.
Default: +pass:[${statusbar.fg}]+
[[colors-statusbar.url.fg.success]]
=== statusbar.url.fg.success
2015-10-15 18:34:56 +02:00
Foreground color of the URL in the statusbar on successful load (http).
Default: +pass:[white]+
[[colors-statusbar.url.fg.success.https]]
=== statusbar.url.fg.success.https
Foreground color of the URL in the statusbar on successful load (https).
2014-09-07 23:22:38 +02:00
Default: +pass:[lime]+
[[colors-statusbar.url.fg.error]]
=== statusbar.url.fg.error
Foreground color of the URL in the statusbar on error.
Default: +pass:[orange]+
[[colors-statusbar.url.fg.warn]]
=== statusbar.url.fg.warn
Foreground color of the URL in the statusbar when there's a warning.
Default: +pass:[yellow]+
[[colors-statusbar.url.fg.hover]]
=== statusbar.url.fg.hover
Foreground color of the URL in the statusbar for hovered links.
Default: +pass:[aqua]+
2014-11-26 21:16:27 +01:00
[[colors-tabs.fg.odd]]
=== tabs.fg.odd
2014-10-26 22:56:00 +01:00
Foreground color of unselected odd tabs.
Default: +pass:[white]+
2014-11-26 21:16:27 +01:00
[[colors-tabs.bg.odd]]
=== tabs.bg.odd
2014-09-07 23:22:38 +02:00
Background color of unselected odd tabs.
Default: +pass:[grey]+
2015-06-10 20:55:15 +02:00
[[colors-tabs.fg.even]]
=== tabs.fg.even
Foreground color of unselected even tabs.
Default: +pass:[white]+
2014-11-26 21:16:27 +01:00
[[colors-tabs.bg.even]]
=== tabs.bg.even
2014-09-07 23:22:38 +02:00
Background color of unselected even tabs.
Default: +pass:[darkgrey]+
2015-09-19 21:50:06 +02:00
[[colors-tabs.fg.selected.odd]]
=== tabs.fg.selected.odd
Foreground color of selected odd tabs.
2015-06-10 20:55:15 +02:00
Default: +pass:[white]+
2015-09-19 21:50:06 +02:00
[[colors-tabs.bg.selected.odd]]
=== tabs.bg.selected.odd
Background color of selected odd tabs.
2014-09-07 23:22:38 +02:00
Default: +pass:[black]+
2015-09-19 21:50:06 +02:00
[[colors-tabs.fg.selected.even]]
=== tabs.fg.selected.even
Foreground color of selected even tabs.
Default: +pass:[${tabs.fg.selected.odd}]+
[[colors-tabs.bg.selected.even]]
=== tabs.bg.selected.even
Background color of selected even tabs.
Default: +pass:[${tabs.bg.selected.odd}]+
2015-10-04 17:49:43 +02:00
[[colors-tabs.bg.bar]]
=== tabs.bg.bar
Background color of the tab bar.
Default: +pass:[#555555]+
2014-11-26 21:16:27 +01:00
[[colors-tabs.indicator.start]]
=== tabs.indicator.start
2014-09-07 23:22:38 +02:00
Color gradient start for the tab indicator.
Default: +pass:[#0000aa]+
2014-11-26 21:16:27 +01:00
[[colors-tabs.indicator.stop]]
=== tabs.indicator.stop
2014-09-07 23:22:38 +02:00
Color gradient end for the tab indicator.
Default: +pass:[#00aa00]+
2014-11-26 21:16:27 +01:00
[[colors-tabs.indicator.error]]
=== tabs.indicator.error
2014-09-07 23:22:38 +02:00
Color for the tab indicator on errors..
Default: +pass:[#ff0000]+
2014-11-26 21:16:27 +01:00
[[colors-tabs.indicator.system]]
=== tabs.indicator.system
2014-09-07 23:22:38 +02:00
Color gradient interpolation system for the tab indicator.
Valid values:
* +rgb+: Interpolate in the RGB color system.
* +hsv+: Interpolate in the HSV color system.
* +hsl+: Interpolate in the HSL color system.
2015-10-24 16:04:53 +02:00
* +none+: Don't show a gradient.
2014-09-07 23:22:38 +02:00
Default: +pass:[rgb]+
[[colors-hints.fg]]
=== hints.fg
Font color for hints.
Default: +pass:[black]+
[[colors-hints.bg]]
=== hints.bg
2016-08-16 17:44:48 +02:00
Background color for hints. Note that you can use a `rgba(...)` value for transparency.
2014-09-07 23:22:38 +02:00
2016-08-17 20:17:17 +02:00
Default: +pass:[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))]+
2014-09-07 23:22:38 +02:00
2015-06-10 20:55:15 +02:00
[[colors-hints.fg.match]]
=== hints.fg.match
Font color for the matched part of hints.
2014-09-07 23:22:38 +02:00
2015-06-10 20:55:15 +02:00
Default: +pass:[green]+
2014-09-07 23:22:38 +02:00
[[colors-downloads.bg.bar]]
=== downloads.bg.bar
Background color for the download bar.
Default: +pass:[black]+
2015-06-10 20:55:15 +02:00
[[colors-downloads.fg.start]]
=== downloads.fg.start
Color gradient start for download text.
Default: +pass:[white]+
2014-09-07 23:22:38 +02:00
[[colors-downloads.bg.start]]
=== downloads.bg.start
2015-06-10 20:55:15 +02:00
Color gradient start for download backgrounds.
2014-09-07 23:22:38 +02:00
Default: +pass:[#0000aa]+
2015-06-10 20:55:15 +02:00
[[colors-downloads.fg.stop]]
=== downloads.fg.stop
Color gradient end for download text.
Default: +pass:[${downloads.fg.start}]+
2014-09-07 23:22:38 +02:00
[[colors-downloads.bg.stop]]
=== downloads.bg.stop
2015-06-10 20:55:15 +02:00
Color gradient stop for download backgrounds.
2014-09-07 23:22:38 +02:00
Default: +pass:[#00aa00]+
2015-06-10 20:55:15 +02:00
[[colors-downloads.fg.system]]
=== downloads.fg.system
Color gradient interpolation system for download text.
Valid values:
* +rgb+: Interpolate in the RGB color system.
* +hsv+: Interpolate in the HSV color system.
* +hsl+: Interpolate in the HSL color system.
2015-10-24 16:04:53 +02:00
* +none+: Don't show a gradient.
2015-06-10 20:55:15 +02:00
Default: +pass:[rgb]+
2014-09-07 23:22:38 +02:00
[[colors-downloads.bg.system]]
=== downloads.bg.system
2015-06-10 20:55:15 +02:00
Color gradient interpolation system for download backgrounds.
2014-09-07 23:22:38 +02:00
Valid values:
* +rgb+: Interpolate in the RGB color system.
* +hsv+: Interpolate in the HSV color system.
* +hsl+: Interpolate in the HSL color system.
2015-10-24 16:04:53 +02:00
* +none+: Don't show a gradient.
2014-09-07 23:22:38 +02:00
Default: +pass:[rgb]+
2015-06-10 20:55:15 +02:00
[[colors-downloads.fg.error]]
=== downloads.fg.error
Foreground color for downloads with errors.
Default: +pass:[white]+
2014-10-26 19:48:26 +01:00
[[colors-downloads.bg.error]]
=== downloads.bg.error
Background color for downloads with errors.
Default: +pass:[red]+
2015-06-01 22:29:49 +02:00
[[colors-webpage.bg]]
=== webpage.bg
Background color for webpages if unset (or empty to use the theme's color)
Default: +pass:[white]+
2016-09-07 09:49:37 +02:00
This setting is only available with the QtWebKit backend.
2016-05-18 08:24:20 +02:00
[[colors-keyhint.fg]]
=== keyhint.fg
Text color for the keyhint widget.
Default: +pass:[#FFFFFF]+
[[colors-keyhint.fg.suffix]]
=== keyhint.fg.suffix
Highlight color for keys to complete the current keychain
Default: +pass:[#FFFF00]+
[[colors-keyhint.bg]]
=== keyhint.bg
Background color of the keyhint widget.
Default: +pass:[rgba(0, 0, 0, 80%)]+
2014-09-07 23:22:38 +02:00
== fonts
Fonts used for the UI, with optional style/weight/size.
* Style: `normal`/`italic`/`oblique`
* Weight: `normal`, `bold`, `100`..`900`
* Size: _number_ `px`/`pt`
[[fonts-_monospace]]
=== _monospace
Default monospace fonts.
2016-03-14 19:05:45 +01:00
Default: +pass:[Terminus, Monospace, "DejaVu Sans Mono", Monaco, "Bitstream Vera Sans Mono", "Andale Mono", "Courier New", Courier, "Liberation Mono", monospace, Fixed, Consolas, Terminal]+
2014-09-07 23:22:38 +02:00
[[fonts-completion]]
=== completion
Font used in the completion widget.
Default: +pass:[8pt ${_monospace}]+
2016-08-01 14:37:58 +02:00
[[fonts-completion.category]]
=== completion.category
Font used in the completion categories.
Default: +pass:[bold ${completion}]+
2014-09-07 23:22:38 +02:00
[[fonts-tabbar]]
=== tabbar
2015-03-31 22:14:35 +02:00
Font used in the tab bar.
2014-09-07 23:22:38 +02:00
Default: +pass:[8pt ${_monospace}]+
[[fonts-statusbar]]
=== statusbar
Font used in the statusbar.
Default: +pass:[8pt ${_monospace}]+
[[fonts-downloads]]
=== downloads
Font used for the downloadbar.
Default: +pass:[8pt ${_monospace}]+
[[fonts-hints]]
=== hints
Font used for the hints.
2016-08-17 12:42:24 +02:00
Default: +pass:[bold 13px ${_monospace}]+
2014-09-07 23:22:38 +02:00
[[fonts-debug-console]]
=== debug-console
Font used for the debugging console.
Default: +pass:[8pt ${_monospace}]+
[[fonts-web-family-standard]]
=== web-family-standard
Font family for standard fonts.
Default: empty
[[fonts-web-family-fixed]]
=== web-family-fixed
Font family for fixed fonts.
Default: empty
[[fonts-web-family-serif]]
=== web-family-serif
Font family for serif fonts.
Default: empty
[[fonts-web-family-sans-serif]]
=== web-family-sans-serif
Font family for sans-serif fonts.
Default: empty
[[fonts-web-family-cursive]]
=== web-family-cursive
Font family for cursive fonts.
Default: empty
[[fonts-web-family-fantasy]]
=== web-family-fantasy
Font family for fantasy fonts.
Default: empty
[[fonts-web-size-minimum]]
=== web-size-minimum
The hard minimum font size.
Default: empty
[[fonts-web-size-minimum-logical]]
=== web-size-minimum-logical
The minimum logical font size that is applied when zooming out.
Default: empty
[[fonts-web-size-default]]
=== web-size-default
The default font size for regular text.
Default: empty
[[fonts-web-size-default-fixed]]
=== web-size-default-fixed
The default font size for fixed-pitch text.
Default: empty
2016-05-18 08:24:20 +02:00
[[fonts-keyhint]]
=== keyhint
Font used in the keyhint widget.
Default: +pass:[8pt ${_monospace}]+