docs: improve description of 'speller' and related bindable functions

master
Benno Schulenberg 2018-05-30 19:57:28 +02:00
parent 8492de53f7
commit b84dea9898
2 changed files with 14 additions and 14 deletions

View File

@ -355,7 +355,7 @@ The default value is @t{-8}. This option conflicts with @option{-w}
@itemx --speller=@var{program} @itemx --speller=@var{program}
Use the given program to do spell checking and correcting. By default, Use the given program to do spell checking and correcting. By default,
@command{nano} uses the command specified in the @env{SPELL} environment @command{nano} uses the command specified in the @env{SPELL} environment
variable for this. If @env{SPELL} is not set, and @option{--speller} is variable. If @env{SPELL} is not set, and @option{--speller} is
not specified either, then @command{nano} uses its own interactive spell not specified either, then @command{nano} uses its own interactive spell
corrector, which requires the GNU @command{spell} program to be installed. corrector, which requires the GNU @command{spell} program to be installed.
@ -989,12 +989,12 @@ file, to determine whether this syntax should be used for it.
on the system and will be silently ignored otherwise.) on the system and will be silently ignored otherwise.)
@item linter @var{program} [@var{arg} @dots{}] @item linter @var{program} [@var{arg} @dots{}]
Use the given @var{program} to do a syntax check on the current file. Use the given @var{program} to do a syntax check on the current buffer.
(This overrides the speller function.) (This overrides the speller function.)
@item formatter @var{program} [@var{arg} @dots{}] @item formatter @var{program} [@var{arg} @dots{}]
Use the given @var{program} to automatically reformat text --- Use the given @var{program} to automatically reformat the text in
useful for a programming language like Go. the current buffer --- useful for a programming language like Go.
(This overrides the speller and linter functions.) (This overrides the speller and linter functions.)
@item comment "@var{string}" @item comment "@var{string}"
@ -1161,8 +1161,8 @@ Shows the current cursor position: the line, column, and character positions.
Counts the number of words, lines and characters in the current buffer. Counts the number of words, lines and characters in the current buffer.
@item speller @item speller
Invokes a spell-checking program (or a linting program, if the current Invokes a spell-checking program (or linting program, or formatter program,
syntax highlighting defines one). if the active syntax defines such a thing).
@item justify @item justify
Justifies the current paragraph. A paragraph is a group of contiguous lines Justifies the current paragraph. A paragraph is a group of contiguous lines

View File

@ -243,9 +243,9 @@ Use smooth scrolling by default.
.B set softwrap .B set softwrap
Enable soft line wrapping for easier viewing of very long lines. Enable soft line wrapping for easier viewing of very long lines.
.TP .TP
.B set speller "\fIspellprog\fP" .B set speller "\fIprogram\fP"
Use spelling checker \fIspellprog\fP instead of the built-in one, which Use the given \fIprogram\fR to do spell checking and correcting,
calls \fIspell\fP. instead of the built-in corrector that calls \fBspell\fR.
.TP .TP
.B set statuscolor \fIfgcolor\fR,\fIbgcolor\fR .B set statuscolor \fIfgcolor\fR,\fIbgcolor\fR
Specify the color combination to use for the status bar. Specify the color combination to use for the status bar.
@ -342,12 +342,12 @@ file, to determine whether this syntax should be used for it.
system and will be silently ignored otherwise.) system and will be silently ignored otherwise.)
.TP .TP
.BI linter " program " \fR[ "arg " \fR...] .BI linter " program " \fR[ "arg " \fR...]
Use the given \fIprogram\fR to run a syntax check on the current file. Use the given \fIprogram\fR to run a syntax check on the current buffer.
(This overrides the speller function.) (This overrides the speller function.)
.TP .TP
.BI formatter " program " \fR[ "arg " \fR...] .BI formatter " program " \fR[ "arg " \fR...]
Use the given \fIprogram\fR to automatically reformat text -- Use the given \fIprogram\fR to automatically reformat the text in
useful in a programming language like Go. the current buffer -- useful in a programming language like Go.
(This overrides the speller and linter functions.) (This overrides the speller and linter functions.)
.TP .TP
.BR comment " ""\fIstring\fR""" .BR comment " ""\fIstring\fR"""
@ -510,8 +510,8 @@ Shows the current cursor position: the line, column, and character positions.
Counts the number of words, lines and characters in the current buffer. Counts the number of words, lines and characters in the current buffer.
.TP .TP
.B speller .B speller
Invokes a spell-checking program (or a linting program, if the current Invokes a spell-checking program (or linting program, or formatter program,
syntax highlighting defines one). if the active syntax defines such a thing).
.TP .TP
.B linter .B linter
A synonym of \fBspeller\fR (for when the speller has not been configured). A synonym of \fBspeller\fR (for when the speller has not been configured).