From eddc7db22c92ebb01c9e0bbe2a05f2b4dfdfb04f Mon Sep 17 00:00:00 2001 From: Felix Rath Date: Sat, 1 May 2021 15:57:24 +0200 Subject: [PATCH] README.org: Add info about vterm in NixOS I hit a problem with `epkgs.vterm` from `nixos-20.09` being too old and thus missing `vterm-goto-char` which is present in newer versions of `epkgs.vterm`. I added a note to clear this up for future users, and added two other changes/clarifications as well: * Changed `epkgs.emacs-libvterm` -> `epkgs.vterm`, as the old name is deprecated. * Added note that `epkgs.vterm` already contains a `vterm-module.so` * Added note that the version of `emacs` needs to be recent enough and that otherwise bugs might occur. --- modules/term/vterm/README.org | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/modules/term/vterm/README.org b/modules/term/vterm/README.org index 42ae0a1ae..7be253d72 100644 --- a/modules/term/vterm/README.org +++ b/modules/term/vterm/README.org @@ -60,7 +60,7 @@ variable (=SPC h v system-configuration-options=). systemPackages = with pkgs; [ # emacs # no need for this, the next line includes emacs ((emacsPackagesNgGen emacs).emacsWithPackages (epkgs: [ - epkgs.emacs-libvterm + epkgs.vterm ])) ]; #+END_SRC @@ -70,9 +70,17 @@ variable (=SPC h v system-configuration-options=). #+BEGIN_SRC nix programs.emacs = { enable = true; - extraPackages = epkgs: [ epkgs.emacs-libvterm ]; + extraPackages = epkgs: [ epkgs.vterm ]; }; #+END_SRC + + This already contains a version of =vterm-module.so=, so NixOS users need + not compile the module themselves as described below. + + Note: The =nixpkgs=-version that is used needs to be compatible with the rest + of the plugins installed in =doom=. Therefore it might be necessary to pull in + =emacs= and/or =emacsPackagesNgGen= from =unstable= or another channel. Otherwise + arbitrary functionality of =vterm= might not work. ** Compilation tools for vterm-module.so When you first load vterm, it will compile =vterm-module.so= for you. For this