ariadne
/
smol
2
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: document the 'fixer' command, a per-syntax content arranger

master
Benno Schulenberg 2019-10-11 19:41:01 +02:00
parent d8c03cd4cd
commit b5c5cde0d4
2 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/nano.texi
View File

@ -1046,6 +1046,12 @@ file, to determine whether this syntax should be used for it.
(This functionality only works when @code{libmagic} is installed (This functionality only works when @code{libmagic} is installed
on the system and will be silently ignored otherwise.) on the system and will be silently ignored otherwise.)
@item fixer @var{program} [@var{arg} @dots{}]
Run the given @var{program} on the full contents of the current buffer.
(The current buffer is written out to a temporary file, the program is
run on it, and then the temporary file is read back in, replacing the
contents of the buffer.)
@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 buffer. Use the given @var{program} to do a syntax check on the current buffer.
@ -1102,7 +1108,7 @@ to @code{icolor}.
@item extendsyntax @var{name} @var{command} [@var{arg} @dots{}] @item extendsyntax @var{name} @var{command} [@var{arg} @dots{}]
Extend the syntax previously defined as "@var{name}" with another @var{command}. Extend the syntax previously defined as "@var{name}" with another @var{command}.
This allows you to add a new @code{color}, @code{icolor}, @code{header}, This allows you to add a new @code{color}, @code{icolor}, @code{header},
@code{magic}, @code{comment}, or @code{linter} command to an already @code{magic}, @code{comment}, @code{linter}, or @code{fixer} command to an already
defined syntax --- useful when you want to slightly improve a syntax defined defined syntax --- useful when you want to slightly improve a syntax defined
in one of the system-installed files (which normally are not writable). in one of the system-installed files (which normally are not writable).
@ -1259,6 +1265,9 @@ Counts the number of words, lines and characters in the current buffer.
Invokes a spell-checking program, either the default one, or the one Invokes a spell-checking program, either the default one, or the one
defined by @option{--speller} or @code{set speller}. defined by @option{--speller} or @code{set speller}.
@item fixer
Invokes a full-buffer-processing program (if the active syntax defines one).
@item linter @item linter
Invokes a syntax-checking program (if the active syntax defines one). Invokes a syntax-checking program (if the active syntax defines one).

11
doc/nanorc.5
View File

@ -382,6 +382,12 @@ file, to determine whether this syntax should be used for it.
(This functionality only works when \fBlibmagic\fP is installed on the (This functionality only works when \fBlibmagic\fP is installed on the
system and will be silently ignored otherwise.) system and will be silently ignored otherwise.)
.TP .TP
.BI fixer " program " \fR[ "arg " \fR...]
Run the given \fIprogram\fR on the full contents of the current buffer.
(The current buffer is written out to a temporary file, the program is
run on it, and then the temporary file is read back in, replacing the
contents of the buffer.)
.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 buffer. Use the given \fIprogram\fR to run a syntax check on the current buffer.
.TP .TP
@ -438,7 +444,7 @@ to \fBicolor\fP.
.BI extendsyntax " name command " \fR[ "arg " \fR...] .BI extendsyntax " name command " \fR[ "arg " \fR...]
Extend the syntax previously defined as \fIname\fR with another Extend the syntax previously defined as \fIname\fR with another
\fIcommand\fR. This allows adding a new \fBcolor\fP, \fBicolor\fP, \fIcommand\fR. This allows adding a new \fBcolor\fP, \fBicolor\fP,
\fBheader\fP, \fBmagic\fP, \fBcomment\fP, or \fBlinter\fP \fBheader\fP, \fBmagic\fP, \fBcomment\fP, \fBlinter\fP, or \fBfixer\fR
command to an already defined syntax -- useful when you want to command to an already defined syntax -- useful when you want to
slightly improve a syntax defined in one of the system-installed slightly improve a syntax defined in one of the system-installed
files (which normally are not writable). files (which normally are not writable).
@ -588,6 +594,9 @@ Counts the number of words, lines and characters in the current buffer.
Invokes a spell-checking program, either the default one, or the one Invokes a spell-checking program, either the default one, or the one
defined by \fB\-\-speller\fR or \fBset speller\fR. defined by \fB\-\-speller\fR or \fBset speller\fR.
.TP .TP
.B fixer
Invokes a full-buffer-processing program (if the active syntax defines one).
.TP
.B linter .B linter
Invokes a syntax-checking program (if the active syntax defines one). Invokes a syntax-checking program (if the active syntax defines one).
.TP .TP