2020-08-07 23:40:06 -04:00
#+TITLE : os/tty
#+DATE : August 7, 2020
#+SINCE : v3.0.0
#+STARTUP : inlineimages nofold
* Table of Contents :TOC_3:noexport:
- [[#description ][Description ]]
- [[#maintainers ][Maintainers ]]
- [[#module-flags ][Module Flags ]]
- [[#plugins ][Plugins ]]
- [[#prerequisites ][Prerequisites ]]
- [[#configuration ][Configuration ]]
2020-08-08 03:06:26 -04:00
- [[#true-color-and-italic-support ][True-color and italic support ]]
2020-08-07 23:40:06 -04:00
- [[#troubleshooting ][Troubleshooting ]]
* Description
2021-03-06 11:23:00 -05:00
This module configures Emacs for use in the terminal, by providing:
2020-08-07 23:40:06 -04:00
+ System clipboard integration (through an external clipboard program or OSC-52
escape codes in supported terminals).
2021-03-06 11:23:00 -05:00
+ Cursor-shape changing across evil states (requires a terminal that supports
it).
2020-08-07 23:40:06 -04:00
+ Mouse support in the terminal.
** Maintainers
This module has no dedicated maintainers.
** Module Flags
2020-08-08 23:35:53 -06:00
+ =+osc= Instead of piping your kill ring through external programs, like xclip
2020-08-07 23:40:06 -04:00
or pbcopy, have Emacs emit OSC-52 escape codes instead, allowing Emacs to
2021-03-06 11:23:00 -05:00
communicate with your clipboard through your terminal, even across SSH
connections or Tmux. However, this requires [[https://github.com/spudlyo/clipetty#terminals-that-support-osc-clipboard-operations ][a supported terminal ]].
2020-08-07 23:40:06 -04:00
** Plugins
2021-03-06 11:23:00 -05:00
+ [[https://github.com/spudlyo/clipetty ][clipetty ]]* (if =+osc= )
+ [[https://github.com/7696122/evil-terminal-cursor-changer ][evil-terminal-cursor-changer ]]* (if =:editor evil= )
+ [[https://github.com/emacs-straight/xclip ][xclip ]]* (unless =+osc= )
2020-08-07 23:40:06 -04:00
* Prerequisites
This module has no hard prerequisites, but in order for its features to work you
2021-03-06 11:23:00 -05:00
need:
2020-08-07 23:40:06 -04:00
+ 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)
2021-03-06 11:23:00 -05:00
+ (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 [[http://www.culater.net/software/SIMBL/SIMBL.php ][SIMBL ]] and [[https://github.com/saitoha/mouseterm-plus/releases ][MouseTerm ]] Plus to work.
2020-08-07 23:40:06 -04:00
* Configuration
2020-08-07 23:58:56 -04:00
** True-color and italic support
Drop Emacs 26.x support
Emacs 27.x has been the stable version of Emacs for nearly a year, and
introduces a litany of bugfixes, performance, and quality-of-life
improvements that significantly reduce Doom's maintenance burden (like
XDG support, early-init.el, image manipulation without imagemagick, a
native JSON library, harfbuzz support, pdumper, and others).
With so many big changes on Doom's horizon, I like having one less (big)
thing to worry about.
Also reverts bb677cf7a (#5232) as it is no longer needed.
2021-07-06 01:54:32 -04:00
Emacs 26.3 users should consult [[https://github.com/syl20bnr/spacemacs/wiki/Terminal ][the spacemacs wiki ]] for details on achieving true
color support in terminal Emacs.
2020-08-08 04:32:59 -04:00
Drop Emacs 26.x support
Emacs 27.x has been the stable version of Emacs for nearly a year, and
introduces a litany of bugfixes, performance, and quality-of-life
improvements that significantly reduce Doom's maintenance burden (like
XDG support, early-init.el, image manipulation without imagemagick, a
native JSON library, harfbuzz support, pdumper, and others).
With so many big changes on Doom's horizon, I like having one less (big)
thing to worry about.
Also reverts bb677cf7a (#5232) as it is no longer needed.
2021-07-06 01:54:32 -04:00
Emacs 27.x users don't need todo anything, as true color support is [[https://github.com/emacs-mirror/emacs/commit/7f6153d9563cfe7753083996f59eacc9f4c694df][built into
27.1+ and newer]].
2020-08-07 23:40:06 -04:00
* Troubleshooting
# Common issues and their solution, or places to look for help.
