From 7ae8671131fb923bdee72eeb4361a4a0c145740e Mon Sep 17 00:00:00 2001 From: larryhynes Date: Fri, 8 Apr 2016 17:05:36 +0100 Subject: Add section on visrc.lua to README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index f0a5821..462df25 100644 --- a/README.md +++ b/README.md @@ -440,6 +440,14 @@ 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 + +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 +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. + ### Runtime Configurable Key Bindings Vis supports run time key bindings via the `:{un,}map{,-window}` set of -- cgit v1.2.3 From ebe726c599c537ec3663361f691fd48d6cac78f6 Mon Sep 17 00:00:00 2001 From: larryhynes Date: Fri, 8 Apr 2016 18:07:08 +0100 Subject: Add more detail on configuring to README.md --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) 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 -- cgit v1.2.3