jsyjr / edm

An emacs dispaly manager

Edm

Edm is a dynamic window manager for Emacs. It automatically arranges your Emacs panes (called “windows” in Emacs parlance) into predefined layouts, dwm-style.

Status

Edm is new and experimental. While it works very well on the subset of Emacs that I use, you will definitely encounter bugs if you venture outside of that. Patches welcome!

Installation

MELPA

After enabling installation of MELPA packages, install edm with M-x package-install.

Manual

Copy or clone Edm somewhere on your system:

git clone https://github.com/ajgrf/edm ~/.emacs.d/edm

Then add its location to load-path:

(add-to-list 'load-path
             (expand-file-name "~/.emacs.d/edm"))

use-package

Here’s a complete example configuration with use-package for reference:

(use-package edm
  :ensure t
  :config
  (setq display-buffer-base-action '(display-buffer-below-selected))
  (edm-setup-dwm-keys)
  (edm-mode 1))

Usage

Edm divides the frame into 2 areas, the master area and the stack. The master area contains the largest window(s), and other windows are placed in the stack. Edm tries to place the master area to the side, but if the frame is too narrow for 2 columns it will put it on top instead.

+-----------+---------+     +-----------+
|           |    1    |     |           |
|           +---------+     |  master   |
|  master   |    2    |     |           |
|           +---------+     +-----------+
|           |    3    |     |     1     |
+-----------+---------+     +-----------+

Edm arranges windows according to just a few parameters: the size of the master area, the number of windows in master, the order of windows, and the current layout. By operating on these parameters instead of manually manipulating individual windows, you can greatly reduce the effort required to resize and reposition windows.

Key Bindings

By default these keys are prefixed with C-c C-w. Customize edm-keymap-prefix to change the prefix.

Binding	Action
r, C-r	Arrange windows
n, C-n, SPC	Move to next window
p, C-p	Move to previous window
N, C-S-n	Swap places with the next window
P, C-S-p	Swap places with the previous window
%, {, [	Decrease the size of the master area
^, }, ]	Increase the size of the master area
d, C-d	Decrease number of windows in master
i	Increase number of windows in master
k, C-k	Delete window
RET	Cycle window to/from master area
c, C-c	Clone current window

See also (edm-setup-dwm-keys) to set up alternative dwm-like key bindings.

Scope

Edm does not provide workspaces or window rules, instead delegating such functionality to other plugins and Emacs facilities (like eyebrowse).

I recommend setting display-buffer to open a new window by default, then defining any exceptions in display-buffer-alist.

(setq display-buffer-base-action '(display-buffer-below-selected))