boxes/pages/editors-emacs.md
Mike Woolley bd1711aa24 Updated the Emacs editor integration instructions.
● Added instructions for installing the `boxes` Emacs package from MELPA.

● Updated the manual installation instructions.
2022-12-13 17:44:26 +01:00

2.2 KiB

title permalink created_at last_modified_at
Editor Integration - Emacs editors-emacs.html 1999-04-06 2022-12-12 17:34:00 +0000

Back to All Editors

Integration with Emacs

MELPA

The easiest way is to install the boxes package from MELPA, however it can also be installed manually if desired:

  • Installation from MELPA

    1. Make sure MELPA is in your package archives list.

    2. M-x package-install boxes

    3. Add key bindings for the boxes commands to your startup file:

       (global-set-key "\C-cb" 'boxes-command-on-region)
       (global-set-key "\C-cq" 'boxes-create)
       (global-set-key "\C-cr" 'boxes-remove)
      
    4. Alternatively, if use-package is installed you can automatically install the boxes binary & elisp packages and add the key bindings with the following form, just like magic 😊

       (use-package boxes
         :ensure t
         :ensure-system-package boxes
         :bind (("C-c b" . boxes-command-on-region)
                ("C-c q" . boxes-create)
                ("C-c r" . boxes-remove)))
      
  • Manual Installation

    1. [Download](https://github.com/{{ site.github }}/blob/master/doc/boxes.el) boxes.el to a directory and add it to your load-path:

       (add-to-list 'load-path <install directory>)
      
    2. Add autoloads to your startup file so boxes will be loaded on first use:

       (autoload 'boxes-command-on-region "boxes" nil t)
       (autoload 'boxes-remove "boxes" nil t)
       (autoload 'boxes-create "boxes" nil t)
      
    3. Add key bindings for the boxes commands to your startup file:

       (global-set-key "\C-cb" 'boxes-command-on-region)
       (global-set-key "\C-cq" 'boxes-create)
       (global-set-key "\C-cr" 'boxes-remove)