emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
doomemacs/modules/os/tty
History
Henrik Lissner 037b018cdd
feat: add .doommodule files 
These optional dotfiles indicate the root of a module or module
group (:lang), and will later contain module metadata. They will also
serve as an alternative to packages.el and doctor.el, and will aide the
parts of the v3.0 module API concerned with resolving the current module
from a path (`doom-module-from-path`), which currently rely too heavily
on parsing path strings.

For now, however, they're simply placeholders.
2024-09-14 20:47:39 -04:00
..
.doommodule feat: add .doommodule files 2024-09-14 20:47:39 -04:00
config.el fix: C-i in KKP supported terminals 2024-08-30 22:08:16 -04:00
packages.el feat(tty): add kitty keyboard protocol support 2024-08-23 17:48:33 -04:00
README.org feat(tty): add kitty keyboard protocol support 2024-08-23 17:48:33 -04:00

README.org

:os tty

Description   unfold

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.
  • Support for the Kitty keyboard protocol in supported terminals.

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

Hacks

No hacks documented for this module.

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

TODO Usage

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

TODO 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?

TODO Appendix

󱌣 This module has no appendix yet. Write one?