docs(plugins/xterm): describe dependencies

This commit is contained in:
Koichi Murase
2024-04-28 16:11:19 +09:00
parent b5e62a33cb
commit b73773d39d

View File

@ -42,6 +42,13 @@ _⚠ if you want to add only this plugin and not Oh My Bash, you can copy the
file `xterm.plugin.bash` in a place you like and edit the file to comment out
the line `_omb_module_require plugin:bash-preexec`. Then, source
`xterm.plugin.bash` in `~/.basrhc` (for interactive uses) or in a shell script
(for a standalone shell program). You may instead copy and paste the functions
directly into a script file, in which case the plugin will not receive updates
and possible errors will have to be solved by you_
(for a standalone shell program). To make the xterm title be automatically
updated, you also need to get a copy of `bash-preexec.sh` (a not up-to-date one
is found in the repository of Oh My Bash at `tools/bash-preexec.sh`) and source
it as well. You may instead copy and paste the functions directly into a
script file, in which case the plugin will not receive updates and possible
errors will have to be solved by you_
## Dependencies
This plugin relies on `bash-preexec.sh` for the preexec and precmd hooks.