Henrik Lissner 88844e9cec docs: simplify internal docs links

Fewer links means less confusion.

- Merge doom-issue and doom-commit links into doom-ref (for auto-linking
  Issue/PR/commit references).
- Merge doom-module-source and doom-docs-source links into doom-source.
- Rename doom-report-issue to doom-report.
- Use '!' as the icon for module issues link.
- Remove doom-repo (replaced with "doom:*" in :lang org module).
- Add doomdir and emacsdir links to :lang org module.

2021-11-21 20:04:28 +01:00

3.4 KiB

Raw Blame History

:os tty

Description
- Maintainers
- Module flags
- Packages
- Hacks
- Changelog
Installation
Usage
Configuration
- True-color and italic support
Troubleshooting
Frequently asked questions
Appendix

← Back to module index ! Issues ↖ Github ± Suggest edits ? Help

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.

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

clipetty if +osc
evil-terminal-cursor-changer if :editor evil
xclip unless +osc

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

3.4 KiB Raw Blame History