summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorian Bruhin <me@the-compiler.org>2019-12-20 16:34:33 +0100
committerFlorian Bruhin <me@the-compiler.org>2019-12-20 16:53:17 +0100
commitde466b3c783e5e7a9c014bb6323c89e3a3f6cfac (patch)
tree2b4bc8166c11a2ff7e12c6b5ac4e8a805c51054a
parent4151680e9388f5266677e77596f9989867a48fbd (diff)
downloadqutebrowser-de466b3c783e5e7a9c014bb6323c89e3a3f6cfac.tar.gz
qutebrowser-de466b3c783e5e7a9c014bb6323c89e3a3f6cfac.zip
Fix doc formatting
-rw-r--r--doc/help/settings.asciidoc30
-rw-r--r--qutebrowser/config/configdata.yml4
2 files changed, 26 insertions, 8 deletions
diff --git a/doc/help/settings.asciidoc b/doc/help/settings.asciidoc
index fe34f511d..35fae2b53 100644
--- a/doc/help/settings.asciidoc
+++ b/doc/help/settings.asciidoc
@@ -181,7 +181,7 @@
|<<downloads.open_dispatcher,downloads.open_dispatcher>>|Default program used to open downloads.
|<<downloads.position,downloads.position>>|Where to show the downloaded files.
|<<downloads.remove_finished,downloads.remove_finished>>|Duration (in milliseconds) to wait before removing finished downloads.
-|<<editor.command,editor.command>>|Editor (and arguments) to use for the `open-editor` command. The following placeholders are defined:
+|<<editor.command,editor.command>>|Editor (and arguments) to use for the `open-editor` command.
|<<editor.encoding,editor.encoding>>|Encoding to use for the editor.
|<<fonts.completion.category,fonts.completion.category>>|Font used in the completion categories.
|<<fonts.completion.entry,fonts.completion.entry>>|Font used in the completion widget.
@@ -1841,13 +1841,24 @@ Default: +pass:[same-domain]+
[[content.headers.user_agent]]
=== content.headers.user_agent
User agent to send.
+
The following placeholders are defined:
-* `{os_info}`: Something like "X11; Linux x86_64". * `{webkit_version}`: The underlying WebKit version (set to a fixed value
+
+* `{os_info}`: Something like "X11; Linux x86_64".
+* `{webkit_version}`: The underlying WebKit version (set to a fixed value
with QtWebEngine).
-* `{qt_key}`: "Qt" for QtWebKit, "QtWebEngine" for QtWebEngine. * `{qt_version}`: The underlying Qt version. * `{upstream_browser_key}`: "Version" for QtWebKit, "Chrome" for QtWebEngine. * `{upstream_browser_version}`: The corresponding Safari/Chrome version. * `{qutebrowser_version}`: The currently running qutebrowser version.
-The default value is equal to the unchanged user agent of QtWebKit/QtWebEngine.
+* `{qt_key}`: "Qt" for QtWebKit, "QtWebEngine" for QtWebEngine.
+* `{qt_version}`: The underlying Qt version.
+* `{upstream_browser_key}`: "Version" for QtWebKit, "Chrome" for QtWebEngine.
+* `{upstream_browser_version}`: The corresponding Safari/Chrome version.
+* `{qutebrowser_version}`: The currently running qutebrowser version.
+
+The default value is equal to the unchanged user agent of
+QtWebKit/QtWebEngine.
+
Note that the value read from JavaScript is always the global value.
+
This setting supports URL patterns.
Type: <<types,FormatString>>
@@ -2360,8 +2371,15 @@ Default: +pass:[-1]+
[[editor.command]]
=== editor.command
-Editor (and arguments) to use for the `open-editor` command. The following placeholders are defined:
-* `{file}`: Filename of the file to be edited. * `{line}`: Line in which the caret is found in the text. * `{column}`: Column in which the caret is found in the text. * `{line0}`: Same as `{line}`, but starting from index 0. * `{column0}`: Same as `{column}`, but starting from index 0.
+Editor (and arguments) to use for the `open-editor` command.
+The following placeholders are defined:
+
+* `{file}`: Filename of the file to be edited.
+* `{line}`: Line in which the caret is found in the text.
+* `{column}`: Column in which the caret is found in the text.
+* `{line0}`: Same as `{line}`, but starting from index 0.
+* `{column0}`: Same as `{column}`, but starting from index 0.
+
Type: <<types,ShellCommand>>
diff --git a/qutebrowser/config/configdata.yml b/qutebrowser/config/configdata.yml
index f105f89c8..8316835a8 100644
--- a/qutebrowser/config/configdata.yml
+++ b/qutebrowser/config/configdata.yml
@@ -495,7 +495,7 @@ content.headers.user_agent:
Gecko) Chrome/76.0.3809.132 Safari/537.36"
- Chrome 76 Linux
supports_pattern: true
- desc: >-
+ desc: |
User agent to send.
The following placeholders are defined:
@@ -1029,7 +1029,7 @@ editor.command:
name: ShellCommand
placeholder: true
default: ["gvim", "-f", "{file}", "-c", "normal {line}G{column0}l"]
- desc: >-
+ desc: |
Editor (and arguments) to use for the `open-editor` command.
The following placeholders are defined: