From 22593886c40b1f3a5a16a794eb68b5f9aae1a389 Mon Sep 17 00:00:00 2001 From: Will Foran Date: Thu, 3 Feb 2022 19:42:23 -0500 Subject: [PATCH] Keybinding documentation reference Brief justification and lots of links to software and guides, explicit xbindkeys example. --- README.org | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.org b/README.org index 904b479..6d67ab9 100644 --- a/README.org +++ b/README.org @@ -28,7 +28,7 @@ On Linux, ensure you have the following dependencies satisfied: =xclip=, =xdotoo * Usage Invoke the Emacs Everywhere executable^{†}. -I recommend doing this by binding a shortcut to: +I recommend doing this by [[*Binding a Shortcut][binding a shortcut]] to: #+begin_src shell emacsclient --eval "(emacs-everywhere)" #+end_src @@ -52,3 +52,19 @@ C-k= still copies the content to the clipboard, but never pastes. ^{*†*} This requires the Emacs daemon to be running, but that's super easy. Just call =emacs --daemon= and you're sorted! + +* Binding a Shortcut + +Emacs-everywhere needs a way to launch when a not-emacs application has focus. The easiest way to do this is to have a global keybinding/keyboard shortcut dedicated to launching (same as above): ~emacsclient --eval "(emacs-everywhere)"~ + +On linux/bsd, use your desktop environment, windows manager, or a dedicated processes (like sxhkd, xbindkeys). The [[https://help.ubuntu.com/stable/ubuntu-help/keyboard-shortcuts-set.html.en][ubuntu]] and [[https://wiki.archlinux.org/title/Keyboard_shortcuts#Customization][archlinux]] guides are informative. + +On MacOS, options include [[http://www.hammerspoon.org/][hammerspoon]], [[https://www.alfredapp.com/help/workflows/triggers/hotkey/][alfred]], [[https://apps.apple.com/us/app/thor-launcher/id1120999687?mt=12][thor]], or [[https://github.com/pqrs-org/Karabiner-Elements/issues/134#issuecomment-439658876][karabiner]]. (Untested, see [[https://github.com/tecosaur/emacs-everywhere/issues/1#issuecomment-781329521][the relevant issue]]) + +** Example + + For =xbindkeys=, ~~/.xbindkeysrc~ would include the entry + #+begin_src shell + "emacsclient --eval '(emacs-everywhere)'" + Alt + Mod4 + e + #+end_src