doomemacs/modules/tools/vterm

tools/vterm

• Description
• Prerequisites
  • Emacs requirement
  • System requirement
  • Module requirement

Description

An emacs-libvterm module.

Prerequisites

Emacs requirement

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

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

• On Archlinux or Manjaro, if you install emacs with pacman, this option is enabled.

• On macOS:

  • If you use Emacs For Mac OS X, this option is enabled.
  • If you use emacs-plus, this option is enabled by default.

  • If you use emacs-mac, this options is not enabled by default. You may have to reinstall emacs with the option:

    brew install emacs-mac --with-modules

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

Module requirement

You have to compile and install the requied module vterm-module.so.

In order to compile it you need to have:

• Compilation tools. This include make, cmake and a c compiler such as gcc.
• Internet connection, because cmake will automatically download some requied libraries from the internet.

There are several ways to install the module:

1. You can use M-x vterm-module-compile to let emacs automatically compile and install the module. WARNING: Emacs will hang during the compilation. It may take a while.
2. A fully byte-compile will cause emacs to automatically compile and install the module if it cannot find an executable vterm-module.so file.

3. You can compile and install the module yourself. Go to the vterm installation directory, which is usually ~/.emacs.d/.local/packages/elpa/vterm-<version>, and run the following:

   mkdir -p build
   cd build
   cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo ..
   make

4. You can also compile the module at other place, and install the compiled vterm-module.so file to your vterm installation folder, which is usually ~/.emacs.d/.local/packages/elpa/vterm-<version>/. Also make sure the module file is executable.