Improve explanations for dicts in the config
This commit is contained in:
parent
66e4c3286a
commit
8e2b2d113b
@ -105,8 +105,8 @@ accepted values depend on the type of the option. Commonly used are:
|
|||||||
- Booleans: `c.completion.shrink = True`
|
- Booleans: `c.completion.shrink = True`
|
||||||
- Integers: `c.messages.timeout = 5000`
|
- Integers: `c.messages.timeout = 5000`
|
||||||
- Dictionaries:
|
- Dictionaries:
|
||||||
* `c.headers.custom = {'X-Hello': 'World'}` to override any other values in the
|
* `c.headers.custom = {'X-Hello': 'World', 'X-Awesome': 'yes'}` to override
|
||||||
dictionary.
|
any other values in the dictionary.
|
||||||
* `c.aliases['foo'] = ':message-info foo'` to add a single value.
|
* `c.aliases['foo'] = ':message-info foo'` to add a single value.
|
||||||
- Lists:
|
- Lists:
|
||||||
* `c.url.start_pages = ["https://www.qutebrowser.org/"]` to override any
|
* `c.url.start_pages = ["https://www.qutebrowser.org/"]` to override any
|
||||||
|
@ -254,6 +254,7 @@
|
|||||||
[[aliases]]
|
[[aliases]]
|
||||||
=== aliases
|
=== aliases
|
||||||
Aliases for commands.
|
Aliases for commands.
|
||||||
|
The keys of the given dictionary are the aliases, while the values are the commands they map to.
|
||||||
|
|
||||||
Type: <<types,Dict>>
|
Type: <<types,Dict>>
|
||||||
|
|
||||||
@ -1694,6 +1695,7 @@ Default: +pass:[true]+
|
|||||||
[[content.javascript.log]]
|
[[content.javascript.log]]
|
||||||
=== content.javascript.log
|
=== content.javascript.log
|
||||||
Log levels to use for JavaScript console logging messages.
|
Log levels to use for JavaScript console logging messages.
|
||||||
|
When a JavaScript message with the level given in the dictionary key is logged, the corresponding dictionary value selects the qutebrowser logger to use.
|
||||||
On QtWebKit, the "unknown" setting is always used.
|
On QtWebKit, the "unknown" setting is always used.
|
||||||
|
|
||||||
Type: <<types,Dict>>
|
Type: <<types,Dict>>
|
||||||
@ -3012,7 +3014,8 @@ Default:
|
|||||||
[[url.searchengines]]
|
[[url.searchengines]]
|
||||||
=== url.searchengines
|
=== url.searchengines
|
||||||
Definitions of search engines which can be used via the address bar.
|
Definitions of search engines which can be used via the address bar.
|
||||||
The searchengine named `DEFAULT` is used when `url.auto_search` is turned on and something else than a URL was entered to be opened. Other search engines can be used by prepending the search engine name to the search term, e.g. `:open google qutebrowser`. The string `{}` will be replaced by the search term, use `{{` and `}}` for literal `{`/`}` signs.
|
Maps a searchengine name (such as `DEFAULT`, or `ddg`) to a URL with a `{}` placeholder. The placeholder will be replaced by the search term, use `{{` and `}}` for literal `{`/`}` signs.
|
||||||
|
The searchengine named `DEFAULT` is used when `url.auto_search` is turned on and something else than a URL was entered to be opened. Other search engines can be used by prepending the search engine name to the search term, e.g. `:open google qutebrowser`.
|
||||||
|
|
||||||
Type: <<types,Dict>>
|
Type: <<types,Dict>>
|
||||||
|
|
||||||
|
@ -15,6 +15,9 @@ aliases:
|
|||||||
desc: >-
|
desc: >-
|
||||||
Aliases for commands.
|
Aliases for commands.
|
||||||
|
|
||||||
|
The keys of the given dictionary are the aliases, while the values are the
|
||||||
|
commands they map to.
|
||||||
|
|
||||||
confirm_quit:
|
confirm_quit:
|
||||||
type: ConfirmQuit
|
type: ConfirmQuit
|
||||||
default: [never]
|
default: [never]
|
||||||
@ -415,6 +418,10 @@ content.javascript.log:
|
|||||||
desc: >-
|
desc: >-
|
||||||
Log levels to use for JavaScript console logging messages.
|
Log levels to use for JavaScript console logging messages.
|
||||||
|
|
||||||
|
When a JavaScript message with the level given in the dictionary key is
|
||||||
|
logged, the corresponding dictionary value selects the qutebrowser logger to
|
||||||
|
use.
|
||||||
|
|
||||||
On QtWebKit, the "unknown" setting is always used.
|
On QtWebKit, the "unknown" setting is always used.
|
||||||
|
|
||||||
content.javascript.modal_dialog:
|
content.javascript.modal_dialog:
|
||||||
@ -1196,11 +1203,14 @@ url.searchengines:
|
|||||||
desc: >-
|
desc: >-
|
||||||
Definitions of search engines which can be used via the address bar.
|
Definitions of search engines which can be used via the address bar.
|
||||||
|
|
||||||
|
Maps a searchengine name (such as `DEFAULT`, or `ddg`) to a URL with a `{}`
|
||||||
|
placeholder. The placeholder will be replaced by the search term, use `{{`
|
||||||
|
and `}}` for literal `{`/`}` signs.
|
||||||
|
|
||||||
The searchengine named `DEFAULT` is used when `url.auto_search` is turned on
|
The searchengine named `DEFAULT` is used when `url.auto_search` is turned on
|
||||||
and something else than a URL was entered to be opened. Other search engines
|
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.
|
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
|
`:open google qutebrowser`.
|
||||||
term, use `{{` and `}}` for literal `{`/`}` signs.
|
|
||||||
|
|
||||||
url.start_pages:
|
url.start_pages:
|
||||||
type:
|
type:
|
||||||
|
Loading…
Reference in New Issue
Block a user