diff options
| -rw-r--r-- | README.md | 8 | ||||
| -rw-r--r-- | vterm.el | 10 |
2 files changed, 12 insertions, 6 deletions
@@ -10,16 +10,18 @@ report a bug! # Installation -You need to have `libvterm` installed, on Linux use your distros package manager, for example: +First, you need to have `libvterm` installed in your system. + +**On Ubuntu:** ``` sudo apt-get install libvterm ``` -On MAC OS X: +**On macOS:** ``` -hombrew install libvterm +brew install libvterm ``` Then clone the repository: @@ -48,8 +48,9 @@ (defcustom vterm-keymap-exceptions '("C-c" "C-x" "C-u" "C-g" "C-h" "M-x" "M-o" "C-v" "M-v") "Exceptions for vterm-keymap. -If you use a keybinding with a prefix-key that prefix-key cannot -be send to the terminal." +If you use a keybinding with a prefix-key, add that prefix-key to +this list. Note that after doing so that prefix-key cannot be sent +to the terminal anymore." :type '(repeat string) :group 'vterm) @@ -57,7 +58,10 @@ be send to the terminal." "Shell exit hook. This hook applies only to new vterms, created after setting this -value with `add-hook'." +value with `add-hook'. + +Note that this hook will not work if another package like +`shell-pop' sets its own sentinel to the `vterm' process." :type 'hook :group 'vterm) |