1 # vmd.el
2 
3 vmd is an Emacs package to interact with [OpenBSD' vmd][vmd].
4 
5 ![vmd buffer with transient open](vmd.png)
6 
7 
8 ### vterm integration
9 
10 To use vterm (or any other packages really) to handle a shell for the
11 console, `vmd-console-function` must point to a function that accepts
12 two parameters, name and cmd, and execute cmd (a list of strings) in
13 your preferred terminal.  By default, `ansi-term` (bundled with Emacs)
14 is used, so it's easy to switch to vterm:
15 
16 ```elisp
17 (defun my/vmd-vterm (name cmd)
18   (let ((vterm-shell (mapconcat #'shell-quote-argument cmd " "))
19         (vterm-buffer-name (concat "*" name "*")))
20     (vterm)))
21 (setq vmd-console-function #'my/vmd-vterm)
22 ```
23 
24 
25 [vmd]: http://man.openbsd.org/vmd