Describe 'filter mode' in more detail.
Even though the synopsis mentioned `kak -f` accepts filenames, it wasn't clear to me that Kakoune would filter them in-place by default (I guess I assumed it would write them to stdout like sed(1)).
This commit is contained in:
parent
716f1f967a
commit
19e4d58467
22
doc/kak.1
22
doc/kak.1
|
@ -96,10 +96,24 @@ Execute
|
||||||
after the server initialization phase.
|
after the server initialization phase.
|
||||||
.
|
.
|
||||||
.It Fl f Ar keys
|
.It Fl f Ar keys
|
||||||
Enter in
|
Run Kakoune in
|
||||||
.Sq filter mode :
|
.Sq filter mode ,
|
||||||
select the whole file, then execute
|
like
|
||||||
.Ar keys .
|
.Xr sed 1 .
|
||||||
|
For standard input and each file named on the command line,
|
||||||
|
the whole buffer is selected
|
||||||
|
(as with
|
||||||
|
.Li % )
|
||||||
|
then
|
||||||
|
.Ar keys
|
||||||
|
are executed.
|
||||||
|
The filtered version of standard input
|
||||||
|
is written to standard output.
|
||||||
|
Any files mentioned on the command line
|
||||||
|
are modified in-place,
|
||||||
|
but if
|
||||||
|
.Fl i
|
||||||
|
is provided then Kakoune makes a backup of the original version.
|
||||||
.
|
.
|
||||||
.It Fl i Ar suffix
|
.It Fl i Ar suffix
|
||||||
Backup the files on which a filter is applied, using the given suffix.
|
Backup the files on which a filter is applied, using the given suffix.
|
||||||
|
|
Loading…
Reference in New Issue
Block a user