doomemacs/modules/app/everywhere/README.org

← [[doom-module-index:][Back to module index]]               ! [[doom-module-issues:::app everywhere][Issues]]  ↖ [[doom-source:modules/app/everywhere/][Github]]  ± [[doom-suggest-edit:][Suggest edits]]  ? [[doom-help-modules:][Help]]
--------------------------------------------------------------------------------
#+TITLE:    :app everywhere
#+SUBTITLE: *leave* Emacs!? You must be joking
#+CREATED:  February 07, 2021
#+SINCE:    21.12.0

* Description :unfold:
This module adds system-wide popup Emacs windows for quick edits.

** Maintainers
- [[doom-user:][@tecosaur]]

[[doom-contrib-maintainer:][Become a maintainer?]]

** Module flags
/This module has no flags./

** Packages
- [[doom-package:][emacs-everywhere]]

** Hacks
/No hacks documented for this module./

** TODO Changelog
# This section will be machine generated. Don't edit it by hand.
/This module does not have a changelog yet./

* Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][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 [[kbd:][C-c C-c]] or [[kbd:][SPC q f]]. To
exit without pasting, use [[kbd:][C-c C-k]].

* Configuration
[[doom-package:][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./ [[doom-report:][Report one?]]

* Frequently asked questions
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]

* TODO Appendix
#+begin_quote
 🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
#+end_quote