Files
doomemacs/modules/os/tty/README.org
Henrik Lissner 0a4841b247 Add :os tty module
- Moves clipetty to its own, opt-in module (#2671, #3195, #3498)
- Fix cursor shape changing between evil states (#1994)
- Moves `xterm-mouse-mode` and `visible-cursor` config out of core.
2020-08-07 23:44:39 -04:00

2.3 KiB

os/tty

Description

This module configures Emacs for terminal usage.

  • System clipboard integration (through an external clipboard program or OSC-52 escape codes in supported terminals).
  • Fixes cursor-shape changing across evil states in terminal that support it.
  • Mouse support in the terminal.

Maintainers

This module has no dedicated maintainers.

Module Flags

  • +osx Instead of piping your kill ring through external programs, like xclip or pbcopy, have Emacs emit OSC-52 escape codes instead, allowing Emacs to communicate to your clipboard through your terminal. This allows for clipboard communication over SSH connections or tmux. However, this requires a supported terminal.

Plugins

  • clipetty
  • evil-terminal-cursor-changer
  • xclip

Prerequisites

This module has no hard prerequisites, but in order for its features to work you need

  • For system clipboard integration:

    • A supported clipboard program, such as:

      • Linux: xclip, xsel, or wl-clibpoard (Wayland)
      • macOS: pbcopy and pbpaste (included with macOS)
      • Windows: getclip and putclip (cygwin)
    • A terminal that supports OSC 52 escape codes, such as: xterm (unix), iTerm2 (macOS), alacritty (cross platform), kitty (macOS, linux), mintty (Windows), hterm (javascript), st (unix), mlterm (cross platform)
  • For cursor shape changing:

    • A terminal that supports VT's DECSCUSR sequence, such as: Gnome Terminal, xterm, iTerm (macOS), Konsole, or mintty (Windows). Terminal.app (macOS) is supported to, but requires SIMBL and MouseTerm Plus to work.

Configuration

Troubleshooting