Jump to content

# EXWM

2 languages

- 日本語
- 中文（简体）

From ArchWiki

Related articles

- Window manager

EXWM is a window manager based on Emacs.

## Installation

Make sure you have emacs installed. You will also need xorg-xinit.

Install EXWM from within Emacs: `M-x package-install RET exwm RET`.

Edit xinitrc and add:

    exec emacs

In your emacs init file, add:

    (require 'exwm)
    (require 'exwm-config)
    (exwm-config-example)

to use the default settings. If you want to use your own settings, use `(exwm-enable)` instead of `(exwm-config-example)` (and you do not need to `(require 'exwm-config)`).

It is also possible to start emacs in server mode and to start EXWM from commandline. See https://github.com/ch11ng/exwm/issues/284.

## Configuration

EXWM is a full X window manager, so Emacs manages X windows such as your browser, vlc, etc. You may use all the normal Emacs window commands to control window placement. In X windows (i.e. not "normal" Emacs buffers), some commands are caught by EXWM and not passed through to the program. These keys are store in `exwm-input-prefix-keys`. Alternatively, you can set global commands by customizing `exwm-input-global-keys`. If you would rather set `exwm-input-global-keys` in elisp rather than using the customization feature, be aware that you may have to restart EXWM (and set `exwm-input-global-keys` before enabling exwm). Alternatively, you could try using the `cset` macro from the "or emacs" blog[dead link 2025-04-05—domain name not resolved], which should work for redefining `exwm-input-global-keys` without restarting EXWM. To use s-& as a keyboard shortcut to launch a program (e.g. firefox), you can do:

    (setq exwm-input-global-keys `(,(kbd "s-&") .
                                   (lambda (command)
                                     (interactive (list (read-shell-command "$ ")))
                                     (start-process-shell-command command nil command))))

### Multi-monitor

EXWM can handle multi-monitor through the (optional) `exwm-randr` package. You will need to install xrandr and enable exwm-randr in your emacs configuration file before calling `(exwm-enable)`. You will need to adjust the values of "DP-1" and "DP-2" to the values your computer uses; call `xrandr` at the command line with no arguments to see available outputs.

    (require 'exwm-randr)
    (setq exwm-randr-workspace-output-plist '(1 "DP-1"))
    (add-hook 'exwm-randr-screen-change-hook
              (lambda ()
                (start-process-shell-command
                 "xrandr" nil "xrandr --output DP-1 --right-of DP-2 --auto")))

### System tray

EXWM supports a system tray, but it is not enabled by default. To enable it, put the following before `(exwm-enable)` in your dotemacs file:

    (require 'exwm-systemtray)
    (exwm-systemtray-mode 1)

You may need to adjust the height afterwards; this can be adjusted with the `exwm-systemtray-height` variable.

## Embedding within LXDE

EXWM can be used in place of openbox, allowing you to still use LXDE session management tools.

Before doing this, make sure you have your init file for emacs already set up to run EXWM (see above)

lxsession uses the window manager defined in `~/.config/lxsession/LXDE/desktop.conf` (Openbox by default). If this file does not exist, it searches in `/etc/xdg/lxsession/LXDE/desktop.conf` instead.

Replace `openbox-lxde` in either file with emacs:

    [Session]
    window_manager=emacs

### lxsession-logout

You can create the following function within emacs to log out, shutdown, or reboot cleanly from within a LXDE session:

    (defun exwm-logout ()
      (interactive)
      (recentf-save-list)
      (save-some-buffers)
      (start-process-shell-command "logout" nil "lxsession-logout"))

This stores your recentf history to disk, prompts you to save, discard, or diff changes within unsaved buffers, then launches the logout manager. You can bind this function to any key within emacs.

## Troubleshooting

### Screen tearing in Firefox

You may experience screen tearing in some programs, particularly Firefox. You can try:

- turning off smooth scrolling in Preferences > Advanced > Use Smooth Scrolling.
- installing (and activating) Compton or another composite manager: Xorg#Composite.

### Confusing Buffer Names

You may see the buffer names being named '*EXWM*'. This makes it confusing while switching between buffers .EXWM allows the buffers to name themself . To allow buffers to name themself put the following in your dotemacs .

    ;; Make buffer name more meaningful
    (add-hook 'exwm-update-class-hook
              (lambda ()
              (exwm-workspace-rename-buffer exwm-class-name)))

## See also

- EXWM wiki

Category:

- Tiling window managers

Hidden category:

- Pages with dead links