doomemacs/modules/app/everywhere
Henrik Lissner 9e3d99277e
docs(everywhere): update CLI command
6c0b7e1 introduced a new convention for CLIs defined by Doom's modules:
to namespace them under `doom +MODULE ...`. What was once 'doom
everywhere' is now 'doom +everywhere', so the docs needed correcting.

Ref: 6c0b7e1530
2022-09-07 02:34:57 +02:00
..
cli.el fix(everywhere): update cli command 2022-06-22 01:27:03 +02:00
config.el fix(everywhere): inhibit local-vars hooks 2022-04-22 23:36:05 +02:00
doctor.el New module, :app everywhere 2021-02-08 09:22:25 +08:00
packages.el bump: :app 2022-06-17 20:28:07 +02:00
README.org docs(everywhere): update CLI command 2022-09-07 02:34:57 +02:00

:app everywhere

Description   unfold

This module adds system-wide popup Emacs windows for quick edits.

Module flags

This module has no flags.

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 requires:

  • On Linux: (these should be available through your OS package manager)

    • xclip
    • xdotool
    • xprop
    • xwininfo
  • On MacOS: that Emacs is allowed to "control your computer" under System Preferences > Accessibility.

Usage

To use this, invoke the emacs-everywhere executable. This can be done in two ways:

  • $ emacsclient --eval "(emacs-everywhere)"
  • $ doom +everywhere

It is recommended that you add a keybinding for this.

From here, you can edit away to your hearts content in the created frame, then return to the original window and paste the content with C-c C-c or SPC q f. To exit without pasting, use C-c C-k.

Configuration

emacs-everywhere likes to guess if you triggered it from an application which supports markdown. Configure emacs-everywhere-markdown-windows and emacs-everywhere-markdown-apps to improve how accurate this is on your system.

By default, when markdown is detected, markdown-mode is used. It is possible to instead use pandoc to convert the content to Org (and export to markdown when closing the frame) by setting emacs-everywhere-major-mode-function to #'org-mode.

Most other behavior is implemented as hooks on emacs-everywhere-init-hooks.

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?