Skip to content

Latest commit

 

History

History
80 lines (64 loc) · 3.11 KB

README.org

File metadata and controls

80 lines (64 loc) · 3.11 KB
Raw

:os tty

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.

Maintainers

This module has no dedicated maintainers. Become a maintainer?

Module flags

+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.

Packages

  • doom-package:clipetty if doom-module:+osc
  • doom-package:evil-terminal-cursor-changer if doom-module::editor evil
  • doom-package:xclip unless doom-module:+osc

Hacks

No hacks documented for this module.

Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

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 doom-module:+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.

Usage

🔨 This module has no usage documentation yet. Write some?

Configuration

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

True-color and italic support

Consult the spacemacs wiki for details on achieving true color support for terminal Emacs.

Troubleshooting

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

Frequently asked questions

This module has no FAQs yet. Ask one?

Appendix

🔨 This module has no appendix yet. Write one?