History

SteamedFish 16b7c58da9 use fboundp instead of string-match-p		2019-02-21 23:22:04 +08:00
..
autoload.el	rename vterm from :emacs to :tools	2019-02-17 00:18:39 +08:00
config.el	Lazy-load vterm & refactor config	2019-02-18 18:56:20 -05:00
doctor.el	use fboundp instead of string-match-p	2019-02-21 23:22:04 +08:00
packages.el	Include all files with vterm package	2019-02-18 18:49:02 -05:00
readme.org	rename vterm from :emacs to :tools	2019-02-17 00:18:39 +08:00

readme.org

tools/vterm

Description
Prerequisites

Description

An emacs-libvterm module.

Prerequisites

Emacs requirement

You have to compile emacs with --with-modules option.

Lookat the system-configuration-options variable to see if your emacs has this option.

Compiler requirement

Your system need to have make cmake and a c compiler to compile libvterm-module, Emacs will automatically compile the module for you.

You can also put your pre-compiled vterm-module.so to your vterm installation folder, which is usually ~/.emacs.d/.local/packages/quelpa/build/vterm/, and make sure vterm-module.so file is executable, instead of let emacs compile it for you.

System requirement

You need to have libvterm installed in your system.

On Ubuntu or Debian:

sudo apt install libvterm-dev

On ArchLinux or Manjaro:

sudo pacman -S libvterm

On macOS:

brew install libvterm