:os tty - Doom Emacs v21.12 documentation

1. Description

This module configures Emacs for use in the terminal, by providing:

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

This module has no dedicated maintainers. Become a maintainer?

+osc: 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 with your clipboard through your terminal, even across SSH connections or Tmux. However, this requires a supported terminal.

No hacks documented for this module.

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)
- (If +osc is enabled) 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 in the terminal you need A terminal that supports VT’s DECSCUSR sequence, such as: Gnome Terminal, xterm, iTerm (macOS), Konsole, or mintty (Windows). Terminal.app (macOS) is supported too, but requires SIMBL and MouseTerm Plus to work.

This module has no usage documentation yet. Write some?

This module’s configuration documentation is incomplete. Complete it?

Emacs 27.x users don’t need todo anything, as true color support is built into 27.1+ and newer.

Emacs 26.3 users should consult the spacemacs wiki for details on achieving true color support in terminal Emacs.

There are no known problems with this module. Report one?

This module has no appendix yet. Write one?