rnhmjoj/qutebrowser
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve more docs

Browse Source
This commit is contained in:
Florian Bruhin 2017-07-03 16:02:43 +02:00
parent 5ada3606d8
commit be94098597
1 changed files with 93 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

170
qutebrowser/config/configdata.yml
View File

@ -18,7 +18,7 @@ aliases:
confirm_quit: confirm_quit:
type: ConfirmQuit type: ConfirmQuit
default: [never] default: [never]
desc: Whether to confirm quitting the application. desc: Whether quitting the application requires a confirmation.
history_gap_interval: history_gap_interval:
type: Int type: Int
@ -38,7 +38,7 @@ ignore_case:
- never: Search case-sensitively - never: Search case-sensitively
- smart: Search case-sensitively if there are capital chars - smart: Search case-sensitively if there are capital chars
default: smart default: smart
desc: Whether to find text on a page case-insensitively. desc: Find text on a page case-insensitively.
new_instance_open_target: new_instance_open_target:
type: type:
@ -90,7 +90,7 @@ session_default_name:
auto_save.config: auto_save.config:
type: Bool type: Bool
default: true default: true
desc: Whether to save the config automatically on quit. desc: Save the config automatically on quit.
auto_save.interval: auto_save.interval:
type: type:
@ -103,7 +103,7 @@ auto_save.interval:
auto_save.session: auto_save.session:
type: Bool type: Bool
default: false default: false
desc: Whether to always restore open sites when qutebrowser is reopened. desc: Always restore open sites when qutebrowser is reopened.
## content ## content
@ -162,7 +162,7 @@ content.cookies.store:
default: true default: true
type: Bool type: Bool
desc: >- desc: >-
Whether to store cookies. Store cookies.
Note this option needs a restart with QtWebEngine on Qt < 5.9. Note this option needs a restart with QtWebEngine on Qt < 5.9.
@ -190,14 +190,14 @@ content.dns_prefetch:
default: true default: true
type: Bool type: Bool
backend: QtWebKit backend: QtWebKit
desc: Whether to try to pre-fetch DNS entries to speed up browsing. desc: Try to pre-fetch DNS entries to speed up browsing.
content.frame_flattening: content.frame_flattening:
default: false default: false
type: Bool type: Bool
backend: QtWebKit backend: QtWebKit
desc: >- desc: >-
Whether to expand each subframe to its contents. Expand each subframe to its contents.
This will flatten all the frames to become one scrollable page. This will flatten all the frames to become one scrollable page.
@ -240,12 +240,17 @@ content.headers.referer:
type: type:
name: String name: String
valid_values: valid_values:
- always: "Always send." - always: "Always send the Referer."
- never: "Never send; this is not recommended, as some sites may break." - never: "Never send the Referer. This is not recommended, as some sites
- same-domain: "Only send for the same domain. This will still protect may break."
your privacy, but shouldn't break any sites." - same-domain: "Only send the Referer for the same domain. This will still
protect your privacy, but shouldn't break any sites."
backend: QtWebKit backend: QtWebKit
desc: Send the Referer header desc: >-
Send the Referer header.
The Referer header tells websites from which website you were coming from
when visting them.
content.headers.user_agent: content.headers.user_agent:
default: null default: null
@ -358,10 +363,10 @@ content.javascript.can_access_clipboard:
default: false default: false
type: Bool type: Bool
desc: >- desc: >-
Whether JavaScript programs can read or write to the clipboard. Whether JavaScript can read from or write to the clipboard.
With QtWebEngine, writing the clipboard as response to a user interaction is always With QtWebEngine, writing the clipboard as response to a user interaction is
allowed. always allowed.
content.javascript.can_close_windows: content.javascript.can_close_windows:
default: false default: false
@ -378,7 +383,7 @@ content.javascript.can_open_windows_automatically:
content.javascript.enabled: content.javascript.enabled:
default: true default: true
type: Bool type: Bool
desc: Enables or disables the running of JavaScript programs. desc: Enables or disables JavaScript.
content.javascript.log: content.javascript.log:
type: type:
@ -388,7 +393,7 @@ content.javascript.log:
- debug: Log messages with debug level. - debug: Log messages with debug level.
- info: Log messages with info level. - info: Log messages with info level.
default: debug default: debug
desc: How to log javascript console messages. desc: How to log JavaScript console messages.
content.javascript.modal_dialog: content.javascript.modal_dialog:
type: Bool type: Bool
@ -479,20 +484,19 @@ content.proxy_dns_requests:
default: true default: true
type: Bool type: Bool
backend: QtWebKit backend: QtWebKit
desc: Whether to send DNS requests over the configured proxy. desc: Send DNS requests over the configured proxy.
content.ssl_strict: content.ssl_strict:
default: ask default: ask
type: BoolAsk type: BoolAsk
desc: Whether to validate SSL handshakes. desc: Validate SSL handshakes.
content.user_stylesheet: content.user_stylesheet:
type: type:
name: File name: File
none_ok: True none_ok: True
default: null default: null
desc: User stylesheet to use (absolute filename or filename relative to the config desc: User stylesheet to use.
directory). Will expand environment variables.
content.webgl: content.webgl:
default: true default: true
@ -533,7 +537,7 @@ completion.height:
completion.quick: completion.quick:
default: true default: true
type: Bool type: Bool
desc: "Whether to move on to the next part when there's only one possible completion desc: "Move on to the next part when there's only one possible completion
left." left."
completion.show: completion.show:
@ -549,7 +553,7 @@ completion.show:
completion.shrink: completion.shrink:
default: false default: false
type: Bool type: Bool
desc: Whether to shrink the completion to be smaller than the configured size if desc: Shrink the completion to be smaller than the configured size if
there are no scrollbars. there are no scrollbars.
completion.scrollbar.width: completion.scrollbar.width:
@ -564,14 +568,14 @@ completion.scrollbar.padding:
type: type:
name: Int name: Int
minval: 0 minval: 0
desc: Padding of scrollbar handle in completion window (in px). desc: Padding of scrollbar handle in the completion window (in px).
completion.timestamp_format: completion.timestamp_format:
type: type:
name: TimestampTemplate name: TimestampTemplate
none_ok: true none_ok: true
default: '%Y-%m-%d' default: '%Y-%m-%d'
desc: How to format timestamps (e.g. for history) desc: How to format timestamps (e.g. for the history completion).
completion.web_history_max_items: completion.web_history_max_items:
default: 1000 default: 1000
@ -594,20 +598,19 @@ downloads.location.directory:
The directory to save downloads to. The directory to save downloads to.
If unset, a sensible os-specific default is used. If unset, a sensible os-specific default is used.
Will expand environment variables.
downloads.location.prompt: downloads.location.prompt:
default: true default: true
type: Bool type: Bool
desc: >- desc: >-
Whether to prompt the user for the download location. Prompt the user for the download location.
If set to false, `download-directory` will be used. If set to false, `download-directory` will be used.
downloads.location.remember: downloads.location.remember:
default: true default: true
type: Bool type: Bool
desc: Whether to remember the last used download directory. desc: Remember the last used download directory.
downloads.location.suggestion: downloads.location.suggestion:
default: path default: path
@ -625,8 +628,9 @@ downloads.open_dispatcher:
none_ok: true none_ok: true
default: null default: null
desc: >- desc: >-
The default program used to open downloads. If unset, the default internal The default program used to open downloads.
handler is used.
If null, the default internal handler is used.
Any `{}` in the string will be expanded to the filename, else the filename Any `{}` in the string will be expanded to the filename, else the filename
will be appended. will be appended.
@ -641,8 +645,10 @@ downloads.remove_finished:
type: type:
name: Int name: Int
minval: -1 minval: -1
desc: Number of milliseconds to wait before removing finished downloads. Will not desc: >-
be removed if value is -1. Number of milliseconds to wait before removing finished downloads.
If set to -1, downloads are never removed.
## editor ## editor
@ -654,9 +660,6 @@ editor.command:
desc: >- desc: >-
The editor (and arguments) to use for the `open-editor` command. The editor (and arguments) to use for the `open-editor` command.
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. `{}` gets replaced by the filename of the file to be edited.
editor.encoding: editor.encoding:
@ -677,13 +680,13 @@ hints.auto_follow:
- full-match: "Follow the hint when the user typed the whole hint (letter, - 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)." 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." - never: "The user will always need to press Enter to follow a hint."
desc: Controls when a hint can be automatically followed without the user desc: Controls when a hint can be automatically followed without pressing
pressing Enter. Enter.
hints.auto_follow_timeout: hints.auto_follow_timeout:
default: 0 default: 0
type: Int type: Int
desc: A timeout (in milliseconds) to inhibit normal-mode key bindings after a desc: A timeout (in milliseconds) to ignore normal-mode key bindings after a
successful auto-follow. successful auto-follow.
hints.border: hints.border:
@ -721,7 +724,7 @@ hints.find_implementation:
hints.hide_unmatched_rapid_hints: hints.hide_unmatched_rapid_hints:
default: true default: true
type: Bool type: Bool
desc: Controls hiding unmatched hints in rapid mode. desc: Hide unmatched hints in rapid mode.
hints.min_chars: hints.min_chars:
default: 1 default: 1
@ -738,7 +741,7 @@ hints.mode:
- number: Use numeric hints. (In this mode you can also type letters from - number: Use numeric hints. (In this mode you can also type letters from
the hinted element to filter and reduce the number of elements that the hinted element to filter and reduce the number of elements that
are hinted.) are hinted.)
- letter: Use the chars in the hints.chars setting. - letter: Use the chars in the `hints.chars` setting.
- word: Use hints words based on the html elements and the extra words. - word: Use hints words based on the html elements and the extra words.
desc: Mode to use for hints. desc: Mode to use for hints.
@ -755,7 +758,7 @@ hints.next_regexes:
valtype: valtype:
name: Regex name: Regex
flags: IGNORECASE flags: IGNORECASE
desc: "A comma-separated list of regexes to use for 'next' links." desc: A comma-separated list of regexes to use for 'next' links.
hints.prev_regexes: hints.prev_regexes:
default: default:
@ -774,8 +777,10 @@ hints.prev_regexes:
hints.scatter: hints.scatter:
default: true default: true
type: Bool type: Bool
desc: Whether to scatter hint key chains (like Vimium) or not (like dwb). Ignored desc: >-
for number hints. Scatter hint key chains (like Vimium) or not (like dwb).
Ignored for number hints.
hints.uppercase: hints.uppercase:
default: false default: false
@ -805,28 +810,28 @@ input.forward_unbound_keys:
- all: "Forward all unbound keys." - all: "Forward all unbound keys."
- auto: "Forward unbound non-alphanumeric keys." - auto: "Forward unbound non-alphanumeric keys."
- none: "Don't forward any keys." - none: "Don't forward any keys."
desc: Whether to forward unbound keys to the webview in normal mode. desc: Forward unbound keys to the webview in normal mode.
input.insert_mode.auto_load: input.insert_mode.auto_load:
default: false default: false
type: Bool type: Bool
desc: Whether to automatically enter insert mode if an editable element is focused desc: Automatically enter insert mode if an editable element is focused after
after page load. loading the page.
input.insert_mode.auto_leave: input.insert_mode.auto_leave:
default: true default: true
type: Bool type: Bool
desc: Whether to leave insert mode if a non-editable element is clicked. desc: Leave insert mode if a non-editable element is clicked.
input.insert_mode.plugins: input.insert_mode.plugins:
default: false default: false
type: Bool type: Bool
desc: Whether to switch to insert mode when clicking flash and other plugins. desc: Switch to insert mode when clicking flash and other plugins.
input.links_included_in_focus_chain: input.links_included_in_focus_chain:
default: true default: true
type: Bool type: Bool
desc: Whether hyperlinks should be included in the keyboard focus chain. desc: Include hyperlinks in the keyboard focus chain when tabbing.
input.partial_timeout: input.partial_timeout:
default: 5000 default: 5000
@ -843,14 +848,16 @@ input.partial_timeout:
input.rocker_gestures: input.rocker_gestures:
default: false default: false
type: Bool type: Bool
desc: Whether to enable Opera-like mouse rocker gestures. This disables the context desc: >-
menu. Enable Opera-like mouse rocker gestures.
This disables the context menu.
input.spatial_navigation: input.spatial_navigation:
default: false default: false
type: Bool type: Bool
desc: >- desc: >-
Enables or disables the Spatial Navigation feature. Enable Spatial Navigation.
Spatial navigation consists in the ability to navigate between focusable elements 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 in a Web page, such as hyperlinks and form controls, by using Left, Right, Up
@ -878,7 +885,7 @@ keyhint.delay:
name: Int name: Int
minval: 0 minval: 0
default: 500 default: 500
desc: Time from pressing a key to seeing the keyhint dialog (ms) desc: Time from pressing a key to seeing the keyhint dialog (ms).
## messages ## messages
@ -895,7 +902,7 @@ messages.timeout:
messages.unfocused: messages.unfocused:
type: Bool type: Bool
default: false default: false
desc: Whether to show messages in unfocused windows. desc: Show messages in unfocused windows.
## prompt ## prompt
@ -921,7 +928,7 @@ scrolling.bar:
statusbar.hide: statusbar.hide:
type: Bool type: Bool
default: false default: false
desc: Whether to hide the statusbar unless a message is shown. desc: Hide the statusbar unless a message is shown.
statusbar.padding: statusbar.padding:
type: Padding type: Padding
@ -940,15 +947,17 @@ statusbar.position:
scrolling.smooth: scrolling.smooth:
type: Bool type: Bool
default: false default: false
desc: Whether to enable smooth scrolling for web pages. Note smooth scrolling does desc: >-
not work with the `:scroll-px` command. Enable smooth scrolling for web pages.
Note smooth scrolling does not work with the `:scroll-px` command.
## tabs ## tabs
tabs.background: tabs.background:
default: false default: false
type: Bool type: Bool
desc: Whether to open new tabs (middleclick/ctrl+click) in background. desc: Open new tabs (middleclick/ctrl+click) in the background.
tabs.close_mouse_button: tabs.close_mouse_button:
default: middle default: middle
@ -965,12 +974,14 @@ tabs.favicons.scale:
type: type:
name: Float name: Float
minval: 0.0 minval: 0.0
desc: Scale for favicons in the tab bar. The tab size is unchanged, so big favicons desc: >-
also require extra `tabs.padding`. Scaling for favicons in the tab bar.
The tab size is unchanged, so big favicons also require extra `tabs.padding`.
tabs.favicons.show: tabs.favicons.show:
default: true default: true
desc: Whether to show favicons in the tab bar. desc: Show favicons in the tab bar.
type: Bool type: Bool
tabs.indicator_padding: tabs.indicator_padding:
@ -980,7 +991,7 @@ tabs.indicator_padding:
left: 0 left: 0
right: 4 right: 4
type: Padding type: Padding
desc: Padding for indicators desc: Padding for tab indicators
tabs.last_close: tabs.last_close:
default: ignore default: ignore
@ -1016,7 +1027,7 @@ tabs.padding:
left: 5 left: 5
right: 5 right: 5
type: Padding type: Padding
desc: Padding for tabs desc: Padding around text for tabs
tabs.position: tabs.position:
default: top default: top
@ -1048,12 +1059,12 @@ tabs.show_switching_delay:
tabs.tabs_are_windows: tabs.tabs_are_windows:
default: false default: false
type: Bool type: Bool
desc: Whether to open windows instead of tabs. desc: Open a new window for every tab.
tabs.title.alignment: tabs.title.alignment:
default: left default: left
type: TextAlignment type: TextAlignment
desc: Alignment of the text inside of tabs desc: Alignment of the text inside of tabs.
tabs.title.format: tabs.title.format:
default: '{index}: {title}' default: '{index}: {title}'
@ -1071,7 +1082,8 @@ tabs.title.format:
- private - private
none_ok: true none_ok: true
desc: | desc: |
The format to use for the tab title. The following placeholders are defined: The format to use for the tab title.
The following placeholders are defined:
* `{perc}`: The percentage as a string like `[10%]`. * `{perc}`: The percentage as a string like `[10%]`.
* `{perc_raw}`: The raw percentage, e.g. `10` * `{perc_raw}`: The raw percentage, e.g. `10`
@ -1146,8 +1158,9 @@ url.default_page:
type: FuzzyUrl type: FuzzyUrl
default: https://start.duckduckgo.com/ default: https://start.duckduckgo.com/
desc: >- desc: >-
The page to open if :open -t/-b/-w is used without URL. Use `about:blank` The page to open if :open -t/-b/-w is used without URL.
for a blank page.
Use `about:blank` for a blank page.
url.incdec_segments: url.incdec_segments:
type: type:
@ -1179,7 +1192,7 @@ url.start_pages:
name: List name: List
valtype: FuzzyUrl valtype: FuzzyUrl
default: ["https://start.duckduckgo.com"] default: ["https://start.duckduckgo.com"]
desc: The default page(s) to open at the start. desc: The page(s) to open at the start.
url.yank_ignored_parameters: url.yank_ignored_parameters:
type: type:
@ -1193,7 +1206,7 @@ url.yank_ignored_parameters:
- utm_campaign - utm_campaign
- utm_term - utm_term
- utm_content - utm_content
desc: The URL parameters to strip with :yank url. desc: The URL parameters to strip with `:yank url`.
## window ## window
@ -1217,7 +1230,8 @@ window.title_format:
- private - private
default: '{perc}{title}{title_sep}qutebrowser' default: '{perc}{title}{title_sep}qutebrowser'
desc: | desc: |
The format to use for the window title. The following placeholders are defined: The format to use for the window title.
The following placeholders are defined:
* `{perc}`: The percentage as a string like `[10%]`. * `{perc}`: The percentage as a string like `[10%]`.
* `{perc_raw}`: The raw percentage, e.g. `10` * `{perc_raw}`: The raw percentage, e.g. `10`
@ -1411,8 +1425,10 @@ colors.hints.bg:
default: qlineargradient(x1:0, y1:0, x2:0, y2:1, stop:0 rgba(255, 247, 133, 0.8), default: qlineargradient(x1:0, y1:0, x2:0, y2:1, stop:0 rgba(255, 247, 133, 0.8),
stop:1 rgba(255, 197, 66, 0.8)) stop:1 rgba(255, 197, 66, 0.8))
type: QssColor type: QssColor
desc: Background color for hints. Note that you can use a `rgba(...)` value for desc: >-
transparency. Background color for hints.
Note that you can use a `rgba(...)` value for transparency.
colors.hints.match.fg: colors.hints.match.fg:
default: green default: green
@ -1427,7 +1443,7 @@ colors.keyhint.fg:
colors.keyhint.suffix.fg: colors.keyhint.suffix.fg:
default: '#FFFF00' default: '#FFFF00'
type: QssColor type: QssColor
desc: Highlight color for keys to complete the current keychain desc: Highlight color for keys to complete the current keychain.
colors.keyhint.bg: colors.keyhint.bg:
default: rgba(0, 0, 0, 80%) default: rgba(0, 0, 0, 80%)
@ -1547,12 +1563,12 @@ colors.statusbar.caret.bg:
colors.statusbar.caret.selection.fg: colors.statusbar.caret.selection.fg:
default: white default: white
type: QssColor type: QssColor
desc: Foreground color of the statusbar in caret mode with a selection desc: Foreground color of the statusbar in caret mode with a selection.
colors.statusbar.caret.selection.bg: colors.statusbar.caret.selection.bg:
default: '#a12dff' default: '#a12dff'
type: QssColor type: QssColor
desc: Background color of the statusbar in caret mode with a selection desc: Background color of the statusbar in caret mode with a selection.
colors.statusbar.progress.bg: colors.statusbar.progress.bg:
default: white default: white
@ -1607,7 +1623,7 @@ colors.tabs.indicator.stop:
colors.tabs.indicator.error: colors.tabs.indicator.error:
default: '#ff0000' default: '#ff0000'
type: QtColor type: QtColor
desc: Color for the tab indicator on errors.. desc: Color for the tab indicator on errors.
colors.tabs.indicator.system: colors.tabs.indicator.system:
default: rgb default: rgb