emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

README.org: Add info about vterm in NixOS

Browse source 
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.
This commit is contained in:
Felix Rath 2021-05-01 15:57:24 +02:00 • committed by GitHub
parent 8bb54a95f6
commit eddc7db22c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

12
modules/term/vterm/README.org
View file

@ -60,7 +60,7 @@ variable (=SPC h v system-configuration-options=).
systemPackages = with pkgs; [ systemPackages = with pkgs; [
# emacs # no need for this, the next line includes emacs # emacs # no need for this, the next line includes emacs
((emacsPackagesNgGen emacs).emacsWithPackages (epkgs: [ ((emacsPackagesNgGen emacs).emacsWithPackages (epkgs: [
epkgs.emacs-libvterm epkgs.vterm
])) ]))
]; ];
#+END_SRC #+END_SRC
@ -70,10 +70,18 @@ variable (=SPC h v system-configuration-options=).
#+BEGIN_SRC nix #+BEGIN_SRC nix
programs.emacs = { programs.emacs = {
enable = true; enable = true;
extraPackages = epkgs: [ epkgs.emacs-libvterm ]; extraPackages = epkgs: [ epkgs.vterm ];
}; };
#+END_SRC #+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 ** Compilation tools for vterm-module.so
When you first load vterm, it will compile =vterm-module.so= for you. For this When you first load vterm, it will compile =vterm-module.so= for you. For this
to succeed, you need the following: to succeed, you need the following: