From b84dea989846218357dd72fe5e5ccedafb3f785c Mon Sep 17 00:00:00 2001 From: Benno Schulenberg Date: Wed, 30 May 2018 19:57:28 +0200 Subject: [PATCH] docs: improve description of 'speller' and related bindable functions --- doc/nano.texi | 12 ++++++------ doc/nanorc.5 | 16 ++++++++-------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/doc/nano.texi b/doc/nano.texi index 2d7623c7..247b9930 100644 --- a/doc/nano.texi +++ b/doc/nano.texi @@ -355,7 +355,7 @@ The default value is @t{-8}. This option conflicts with @option{-w} @itemx --speller=@var{program} Use the given program to do spell checking and correcting. By default, @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 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.) @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.) @item formatter @var{program} [@var{arg} @dots{}] -Use the given @var{program} to automatically reformat text --- -useful for a programming language like Go. +Use the given @var{program} to automatically reformat the text in +the current buffer --- useful for a programming language like Go. (This overrides the speller and linter functions.) @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. @item speller -Invokes a spell-checking program (or a linting program, if the current -syntax highlighting defines one). +Invokes a spell-checking program (or linting program, or formatter program, +if the active syntax defines such a thing). @item justify Justifies the current paragraph. A paragraph is a group of contiguous lines diff --git a/doc/nanorc.5 b/doc/nanorc.5 index 0328c697..963125c0 100644 --- a/doc/nanorc.5 +++ b/doc/nanorc.5 @@ -243,9 +243,9 @@ Use smooth scrolling by default. .B set softwrap Enable soft line wrapping for easier viewing of very long lines. .TP -.B set speller "\fIspellprog\fP" -Use spelling checker \fIspellprog\fP instead of the built-in one, which -calls \fIspell\fP. +.B set speller "\fIprogram\fP" +Use the given \fIprogram\fR to do spell checking and correcting, +instead of the built-in corrector that calls \fBspell\fR. .TP .B set statuscolor \fIfgcolor\fR,\fIbgcolor\fR 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.) .TP .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.) .TP .BI formatter " program " \fR[ "arg " \fR...] -Use the given \fIprogram\fR to automatically reformat text -- -useful in a programming language like Go. +Use the given \fIprogram\fR to automatically reformat the text in +the current buffer -- useful in a programming language like Go. (This overrides the speller and linter functions.) .TP .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. .TP .B speller -Invokes a spell-checking program (or a linting program, if the current -syntax highlighting defines one). +Invokes a spell-checking program (or linting program, or formatter program, +if the active syntax defines such a thing). .TP .B linter A synonym of \fBspeller\fR (for when the speller has not been configured).