summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Leferry 2 <alexherbo2@gmail.com>2020-06-29 11:31:49 +0200
committerAlex Leferry 2 <alexherbo2@gmail.com>2020-06-29 11:31:49 +0200
commit564a927306c76e37f25f47aec1d7caa501d555bb (patch)
treec0cc7b2148790a1cdc6aef647ff00b522e813e1c
parent40e73ed6154d760bea0efeeb129f95a10124ef2a (diff)
README: Document environment variables
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index fe1c9d2..7fed335 100644
--- a/README.md
+++ b/README.md
@@ -145,3 +145,17 @@ set-option global connect_environment %{
- `it`: Get the current buffer.
- `send`: Send a command.
- `get`: Get a property.
+
+#### Environment variables
+
+Defined in [`env`](rc/env).
+
+- `KAKOUNE_SESSION`: Kakoune session.
+- `KAKOUNE_CLIENT`: Kakoune client.
+- `KAKOUNE_CONNECT_SCRIPT`: Path to connect script, used by `:connect-detach` for writing shell commands.
+- `KAKOUNE_CONNECT_ATTACH`: Whether to attach to terminal.
+- `EDITOR`: Editor to be used. Default is `edit`.
+- `VISUAL`: Visual editor to be used. Default is `edit`.
+- `GIT_EDITOR`: [Git] editor to be used. Default is `edit -wait`.
+
+[Git]: https://git-scm.com