aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorlarryhynes <larryhynes@users.noreply.github.com>2016-04-08 18:07:08 +0100
committerlarryhynes <larryhynes@users.noreply.github.com>2016-04-08 18:07:08 +0100
commitebe726c599c537ec3663361f691fd48d6cac78f6 (patch)
tree43bf3983e199378646e5e58e14d5c8efe9d0ed2a
parent7ae8671131fb923bdee72eeb4361a4a0c145740e (diff)
downloadvis-ebe726c599c537ec3663361f691fd48d6cac78f6.tar.gz
vis-ebe726c599c537ec3663361f691fd48d6cac78f6.tar.xz
Add more detail on configuring to README.md
-rw-r--r--README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.md b/README.md
index 462df25..1257fa6 100644
--- a/README.md
+++ b/README.md
@@ -440,7 +440,7 @@ Operators can be forced to work line wise by specifying `V`.
:e *.c # opens a menu with all C files
:e . # opens a menu with all files of the current directory
-### The vis config file: visrc.lua
+### Configuring vis: visrc.lua, and environment variables
Settings and keymaps can be specified in a `visrc.lua` file, which will
be read by `vis` at runtime. An example `visrc.lua` file is installed
@@ -448,6 +448,22 @@ in `/usr/local/share/vis` by default. This file can be copied to
`$XDG_CONFIG_HOME/vis` (which defaults to `$HOME/.config/vis`) for
further configuration.
+The environment variable `VIS_PATH` can be set to override the path
+that `vis` will look for Lua support files as used for syntax
+highlighting. `VIS_PATH` defaults (in this order) to
+
+- The location of the `vis` binary
+- `$XDG_CONFIG_HOME/vis`, where `$XDG_CONFIG_HOME` refers to
+`$HOME/.config` if unset
+- `/usr/local/share/vis`
+- `/usr/share/vis`
+
+The environment variable `VIS_THEME` can be set to specify the
+theme used by `vis` e.g.
+
+ VIS_THEME=/path/to/your/theme.lua
+ export VIS_THEME
+
### Runtime Configurable Key Bindings
Vis supports run time key bindings via the `:{un,}map{,-window}` set of