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

Improve explanations for dicts in the config

Browse Source
This commit is contained in:
Florian Bruhin 2017-09-18 06:25:39 +02:00
parent 66e4c3286a
commit 8e2b2d113b
3 changed files with 18 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/help/configuring.asciidoc
View File

@ -105,8 +105,8 @@ accepted values depend on the type of the option. Commonly used are:
- Booleans: `c.completion.shrink = True`
- Integers: `c.messages.timeout = 5000`
- Dictionaries:
* `c.headers.custom = {'X-Hello': 'World'}` to override any other values in the
dictionary.
* `c.headers.custom = {'X-Hello': 'World', 'X-Awesome': 'yes'}` to override
any other values in the dictionary.
* `c.aliases['foo'] = ':message-info foo'` to add a single value.
- Lists:
* `c.url.start_pages = ["https://www.qutebrowser.org/"]` to override any

5
doc/help/settings.asciidoc
View File

@ -254,6 +254,7 @@
[[aliases]]
=== aliases
Aliases for commands.
The keys of the given dictionary are the aliases, while the values are the commands they map to.
Type: <<types,Dict>>
@ -1694,6 +1695,7 @@ Default: +pass:[true]+
[[content.javascript.log]]
=== content.javascript.log
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.
Type: <<types,Dict>>
@ -3012,7 +3014,8 @@ Default:
[[url.searchengines]]
=== url.searchengines
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>>

14
qutebrowser/config/configdata.yml
View File

@ -15,6 +15,9 @@ aliases:
desc: >-
Aliases for commands.
The keys of the given dictionary are the aliases, while the values are the
commands they map to.
confirm_quit:
type: ConfirmQuit
default: [never]
@ -415,6 +418,10 @@ content.javascript.log:
desc: >-
Log levels to use for JavaScript console logging messages.
When a JavaScript message with the level given in the dictionary key is
logged, the corresponding dictionary value selects the qutebrowser logger to
use.
On QtWebKit, the "unknown" setting is always used.
content.javascript.modal_dialog:
@ -1196,11 +1203,14 @@ url.searchengines:
desc: >-
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
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.
`:open google qutebrowser`.
url.start_pages:
type: