From b5c5cde0d4be510d14ec41016b12c980bdcdc073 Mon Sep 17 00:00:00 2001 From: Benno Schulenberg Date: Fri, 11 Oct 2019 19:41:01 +0200 Subject: [PATCH] docs: document the 'fixer' command, a per-syntax content arranger --- doc/nano.texi | 11 ++++++++++- doc/nanorc.5 | 11 ++++++++++- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/doc/nano.texi b/doc/nano.texi index fab503b0..72a6522f 100644 --- a/doc/nano.texi +++ b/doc/nano.texi @@ -1046,6 +1046,12 @@ file, to determine whether this syntax should be used for it. (This functionality only works when @code{libmagic} is installed 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{}] 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{}] 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}, -@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 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 defined by @option{--speller} or @code{set speller}. +@item fixer +Invokes a full-buffer-processing program (if the active syntax defines one). + @item linter Invokes a syntax-checking program (if the active syntax defines one). diff --git a/doc/nanorc.5 b/doc/nanorc.5 index 87d85713..982ac8a9 100644 --- a/doc/nanorc.5 +++ b/doc/nanorc.5 @@ -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 system and will be silently ignored otherwise.) .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...] Use the given \fIprogram\fR to run a syntax check on the current buffer. .TP @@ -438,7 +444,7 @@ to \fBicolor\fP. .BI extendsyntax " name command " \fR[ "arg " \fR...] Extend the syntax previously defined as \fIname\fR with another \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 slightly improve a syntax defined in one of the system-installed 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 defined by \fB\-\-speller\fR or \fBset speller\fR. .TP +.B fixer +Invokes a full-buffer-processing program (if the active syntax defines one). +.TP .B linter Invokes a syntax-checking program (if the active syntax defines one). .TP