Add documentation

* `:open`
* `:buffer-close`
* `:buffer-close!`
* `:write`
* `:new`
pull/997/head
Omnikar 3 years ago
parent aee10cf741
commit 32d0ef45b4
No known key found for this signature in database
GPG Key ID: 7DE6694CDA7885ED

@ -0,0 +1,6 @@
`:buffer-close!`
Aliases: `:bc!`, `:bclose!`
Closes the current buffer, discarding any
unsaved changes to the buffer.

@ -0,0 +1,6 @@
`:buffer-close`
Aliases: `:bc`, `:bclose`
Closes the current buffer, failing if the buffer
has unsaved changes.

@ -0,0 +1,6 @@
`:new`
Aliases: `:n`
Creates and switches to a new scratch buffer. This
buffer will not be associated with any file path.

@ -0,0 +1,8 @@
`:open <path>`
Aliases: `:o`
If <path> exists, opens the file at <path>.
If <path> does not exist, creates a new buffer
and associates it with <path>. Note that this
does not automatically save the created buffer.

@ -0,0 +1,9 @@
`:write [path]`
Aliases: `:w`
Writes (saves) the buffer to disk.
If [path] is supplied, that path is written to.
If the buffer is a scratch buffer, meaning it
is not already bound to a file path, [path]
becomes required for this command to succeed.
Loading…
Cancel
Save