summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorsph <sph@sphnet.in>2026-03-09 10:20:10 +0100
committerdana <dana@dana.is>2026-05-16 19:04:18 -0500
commit6cd02b9e2a005e2a2fb3bd4af09878bf86e7b7c9 (patch)
tree5828a18f1814c529b667d18564deeeb296dc16af /Doc
parentgithub #170 (tweaked): Clarify the documentation about -d flag in compadd (diff)
downloadzsh-6cd02b9e2a005e2a2fb3bd4af09878bf86e7b7c9.tar
zsh-6cd02b9e2a005e2a2fb3bd4af09878bf86e7b7c9.tar.gz
zsh-6cd02b9e2a005e2a2fb3bd4af09878bf86e7b7c9.tar.bz2
zsh-6cd02b9e2a005e2a2fb3bd4af09878bf86e7b7c9.tar.lz
zsh-6cd02b9e2a005e2a2fb3bd4af09878bf86e7b7c9.tar.xz
zsh-6cd02b9e2a005e2a2fb3bd4af09878bf86e7b7c9.tar.zst
zsh-6cd02b9e2a005e2a2fb3bd4af09878bf86e7b7c9.zip
github #161 (tweaked): zkbd: allow zkbd to generate config in a custom directory
+ check for empty arg
Diffstat (limited to 'Doc')
-rw-r--r--Doc/Zsh/contrib.yo8
1 files changed, 5 insertions, 3 deletions
diff --git a/Doc/Zsh/contrib.yo b/Doc/Zsh/contrib.yo
index 1e088907c..eb52c1fe7 100644
--- a/Doc/Zsh/contrib.yo
+++ b/Doc/Zsh/contrib.yo
@@ -190,9 +190,11 @@ ordinary, such as a Delete key that sends neither tt(^H) nor tt(^?).
The keystrokes read by tt(zkbd) are recorded as a definition for an
associative array named tt(key), written to a file in the subdirectory
-tt(.zkbd) within either your tt(HOME) or tt(ZDOTDIR) directory. The name
-of the file is composed from the tt(TERM), tt(VENDOR) and tt(OSTYPE)
-parameters, joined by hyphens.
+tt(.zkbd) within either your tt(HOME) or, if specified, tt(ZDOTDIR) directory.
+Alternatively, you can tell tt(zkbd) the directory to write new files into
+with the tt(-d) option, e.g. tt(zkbd -d $ZCACHEDIR/zkbd). In either case, the
+directory is created if it did not exist. The name of the file is composed from
+the tt(TERM), tt(VENDOR) and tt(OSTYPE) parameters, joined by hyphens.
You may read this file into your tt(.zshrc) or another startup file with
the `tt(source)' or `tt(.)' commands, then reference the tt(key) parameter