Skip to content

Commit

Permalink
Keybinding documentation reference
Browse files Browse the repository at this point in the history
Brief justification and lots of links to software and guides,
explicit xbindkeys example.
  • Loading branch information
WillForan authored and tecosaur committed Feb 9, 2022
1 parent daa774c commit 2259388
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.org
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

0 comments on commit 2259388

Please sign in to comment.