Introduction

This emacs module implements a bridge to libvterm to display a terminal in a emacs buffer.

Warning

This is a alpha-release, so it will crash your emacs. If it does, please report a bug!

git clone https://github.com/akermu/emacs-libvterm.git

mkdir -p build
cd build
cmake ..
make

And add this to your init.el

(add-to-list 'load-path "path/to/emacs-libvterm")

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.

List of keys, which should be processed by emacs and not by the terminal.

Set the :foreground and :background attributes of the following faces to a color you like:

Failed to load latest commit information.
.clang-format	Add .clang-format	Nov 15, 2017
.dir-locals.el	Switch to cmake build system	Nov 15, 2017
.gitignore	Put vterm-module.so into project root	Nov 16, 2017
CMakeLists.txt	add -Q option when printing emacs version	Mar 13, 2018
LICENSE	Add LICENSE file	Aug 8, 2017
README.md	Use a emacs process for spawning the shell	Sep 20, 2018
elisp.c	Add support for custom colors	Nov 21, 2017
elisp.h	Use a emacs process for spawning the shell	Sep 20, 2018
utf8.c	Extract utf8.c	Nov 16, 2017
utf8.h	Add include guards to header files	Nov 21, 2017
vterm-module.c	Use a emacs process for spawning the shell	Sep 20, 2018
vterm-module.h	Use a emacs process for spawning the shell	Sep 20, 2018
vterm.el	Use a emacs process for spawning the shell	Sep 20, 2018