aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFlorian Fischer <florian.fischer@muhq.space>2024-05-10 08:41:29 +0200
committerFlorian Fischer <florian.fischer@muhq.space>2024-05-10 08:41:29 +0200
commite814360daa0227124b83da1d83c4925f1f4665a3 (patch)
treea41710827fbf7d9319102b25e3b549df0f60413e /README.md
parent229d79dd351e208c2cad17d62d2d663c12772fd4 (diff)
downloadvis-lockfiles-e814360daa0227124b83da1d83c4925f1f4665a3.tar.gz
vis-lockfiles-e814360daa0227124b83da1d83c4925f1f4665a3.zip
detect backend availability ahead of time and allow user function
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/README.md b/README.md
index 584f9ff..af812ee 100644
--- a/README.md
+++ b/README.md
@@ -7,8 +7,10 @@ multiple vis processes.
By default, the lockfiles will be placed in `${XDG_STATE_HOME:-${HOME}/.local/state}/vis/locks/`.
-The `directory` member of the module table can be used to define the lock file
-location.
+* The `directory` member of the module table can be used to define the lock file location.
+* The `backend` member can be used to specify one of the supported backends: `whiptail` or `vis-menu`.
+ Additionally, it can provide a custom backend function with the following signature `f(filename, lockfilename, lockpid) => bool, ['a', 'e', 'q']`.
+
```lua
local lockfiles = require('plugins/vis-lockfiles')