2017-11-10 19:50:54 +01:00
|
|
|
= Buffers
|
|
|
|
|
|
|
|
== Commands
|
|
|
|
|
2017-11-12 15:44:04 +01:00
|
|
|
To open buffers or navigate through the buffers list see
|
|
|
|
<<commands#files-and-buffers,`:doc commands files-and-buffers`>>.
|
2017-11-10 19:50:54 +01:00
|
|
|
|
|
|
|
== Scratch Buffers
|
|
|
|
|
|
|
|
Scratch buffers are useful for volatile data and quick prototyping.
|
|
|
|
They are not linked to files.
|
|
|
|
|
2017-11-12 15:44:04 +01:00
|
|
|
One particular scratch buffer, named *\*scratch*\*, is automatically
|
|
|
|
created when there are no other buffers left in the current
|
|
|
|
session. (which is also the case at Kakoune's startup when no files to
|
|
|
|
open have been provided)
|
2017-11-10 19:50:54 +01:00
|
|
|
|
2017-11-12 15:44:04 +01:00
|
|
|
A scratch buffer can be created by passing the `-scratch` switch to the
|
|
|
|
`:edit` command.
|
2017-11-10 19:50:54 +01:00
|
|
|
|
|
|
|
== Debug Buffers
|
|
|
|
|
2017-11-12 15:44:04 +01:00
|
|
|
Debug buffers are used to gather diagnostics. They are not accessible
|
|
|
|
while cycling over the buffers list.
|
2017-11-10 19:50:54 +01:00
|
|
|
|
2017-11-12 15:44:04 +01:00
|
|
|
A specific *\*debug*\* buffer is used by Kakoune to write errors or
|
|
|
|
warnings. This is also where the ouput of the `:debug` and the `:echo
|
|
|
|
-debug` commands will land.
|
2017-11-10 19:50:54 +01:00
|
|
|
|
2018-05-11 12:52:19 +02:00
|
|
|
A debug buffer can be created by passing the `-debug` switch to the
|
2017-11-12 15:44:04 +01:00
|
|
|
`:edit` command.
|
2017-11-10 19:50:54 +01:00
|
|
|
|
|
|
|
== FIFO Buffers
|
|
|
|
|
2018-04-03 10:17:19 +02:00
|
|
|
The `:edit` command can take a `-fifo` switch:
|
2017-11-10 19:50:54 +01:00
|
|
|
|
|
|
|
---------------------------------------------
|
|
|
|
:edit -fifo <filename> [-scroll] <buffername>
|
|
|
|
---------------------------------------------
|
|
|
|
|
2017-11-12 15:44:04 +01:00
|
|
|
In this case, a buffer named `<buffername>` is created which reads
|
2018-04-03 10:17:19 +02:00
|
|
|
its content from the fifo (also called "named pipe") `<filename>`.
|
|
|
|
When the fifo is written to, the buffer is automatically updated.
|
2017-11-10 19:50:54 +01:00
|
|
|
|
|
|
|
If the `-scroll` switch is specified, the window displaying the buffer
|
|
|
|
will scroll so that the newest data is always visible.
|
|
|
|
|
2017-11-12 15:44:04 +01:00
|
|
|
This is very useful for running some commands asynchronously while
|
|
|
|
displaying their result in a buffer. See `rc/make.kak` and `rc/grep.kak`
|
|
|
|
for examples.
|
2017-11-10 19:50:54 +01:00
|
|
|
|
2017-11-12 15:44:04 +01:00
|
|
|
When the buffer is deleted, the fifo will be closed, so any program
|
|
|
|
writing to it will receive `SIGPIPE`. This is useful as it permits to
|
|
|
|
stop the writing program when the buffer is deleted.
|