This emacs module implements a bridge to libvterm to display a terminal in a emacs buffer.
This is a alpha-release, so it will crash your emacs. If it does, please report a bug!
Clone the repository:
git clone https://github.com/akermu/emacs-libvterm.git
Run the build:
mkdir -p build
cd build
cmake ..
make
And add this to your init.el
:
(add-to-list 'load-path "path/to/emacs-libvterm")
(require 'vterm)
If you want to have the module compiled, wrap the call to require
as follows:
(add-to-list 'load-path "path/to/emacs-libvterm")
(let (vterm-install)
(require 'vterm))
If you have successfully build the module, you can test the module by executing
the following command in the build
directory:
make run
Open a terminal in the current window.
Open a terminal in another window.
Shell to run in a new vterm. Defaults to $SHELL
.
If you want a key to be send to the terminal bind it to vterm--self-insert
,
otherwise remove it from vterm-mode-map
. By default vterm.el binds most of the
C-<char>
and M-<char>
keys, <f1>
through <f12>
and some special keys
like <backspace>
and <return>
. Sending a keyboard interrupt is by default
bound to C-c C-c
.
Set the :foreground
and :background
attributes of the following faces to a
color you like:
- vterm-color-default
- vterm-color-black
- vterm-color-black
- vterm-color-red
- vterm-color-green
- vterm-color-yellow
- vterm-color-blue
- vterm-color-magenta
- vterm-color-cyan
- vterm-color-white