summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMathieu Ablasou <alexherbo2@gmail.com>2020-11-23 00:30:15 +0100
committerMathieu Ablasou <alexherbo2@gmail.com>2020-11-23 00:31:53 +0100
commita27e7781edf496f48210a21360eeddba6d1d7753 (patch)
tree5b2d80019f0d146e9c229aff501543c58573102e
parent394e2b77592c2705d94a7c2f53215fd661dec769 (diff)
Document environment variables
-rw-r--r--README.md6
-rw-r--r--docs/recipes.md6
2 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4597545..1032d20 100644
--- a/README.md
+++ b/README.md
@@ -220,6 +220,12 @@ You can modify your shell [prompt][Prompt customization] to notify you whenever
PS1='$(test "$IN_KAKOUNE_CONNECT" && printf 🐈)$ '
```
+Available variables are:
+
+- `IN_KAKOUNE_CONNECT` (_1_ when _true_)
+- `KAKOUNE_SESSION`
+- `KAKOUNE_CLIENT`
+
## Documentation
[Documentation]: #documentation
diff --git a/docs/recipes.md b/docs/recipes.md
index 789e6ce..af555d0 100644
--- a/docs/recipes.md
+++ b/docs/recipes.md
@@ -23,6 +23,12 @@ You can modify your shell [prompt][Prompt customization] to notify you whenever
PS1='$(test "$IN_KAKOUNE_CONNECT" && printf 🐈)$ '
```
+Available variables are:
+
+- `IN_KAKOUNE_CONNECT` (_1_ when _true_)
+- `KAKOUNE_SESSION`
+- `KAKOUNE_CLIENT`
+
## Change directory
In complement to `:cd!` which syncs the client to your current working directory,