Improve documentation for general -> editor.

This commit is contained in:
Florian Bruhin 2015-11-05 21:42:29 +01:00
parent 5541e3ed32
commit 3fcc27636a
2 changed files with 5 additions and 3 deletions

View File

@ -345,7 +345,8 @@ Default: +pass:[15000]+
=== editor
The editor (and arguments) to use for the `open-editor` command.
Use `{}` for the filename. The value gets split like in a shell, so you can use `"` or `'` to quote arguments.
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.
Default: +pass:[gvim -f "{}"]+

View File

@ -165,8 +165,9 @@ def data(readonly=False):
SettingValue(typ.ShellCommand(placeholder=True), 'gvim -f "{}"'),
"The editor (and arguments) to use for the `open-editor` "
"command.\n\n"
"Use `{}` for the filename. The value gets split like in a "
"shell, so you can use `\"` or `'` to quote arguments."),
"The arguments get split like in a shell, so you can use `\"` or "
"`'` to quote them.\n"
"`{}` gets replaced by the filename of the file to be edited."),
('editor-encoding',
SettingValue(typ.Encoding(), 'utf-8'),