https://github.com/damiencassou/gpastel
Integrates the GPaste clipboard manager and Emacs' kill-ring
https://github.com/damiencassou/gpastel
clipboard emacs-package gpaste
Last synced: 4 days ago
JSON representation
Integrates the GPaste clipboard manager and Emacs' kill-ring
- Host: GitHub
- URL: https://github.com/damiencassou/gpastel
- Owner: DamienCassou
- License: gpl-3.0
- Created: 2018-04-17T04:10:49.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-30T07:13:54.000Z (over 1 year ago)
- Last Synced: 2025-01-30T06:24:48.333Z (5 months ago)
- Topics: clipboard, emacs-package, gpaste
- Language: Emacs Lisp
- Homepage:
- Size: 44.9 KB
- Stars: 13
- Watchers: 5
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.org
- Funding: .github/FUNDING.yml
- License: COPYING
Awesome Lists containing this project
README
* gpastel
#+BEGIN_HTML
#+END_HTML
** Summary
[[https://github.com/Keruspe/GPaste/][GPaste]] is a clipboard management system. The Emacs package gpastel
makes sure that every copied text in GPaste is also in the Emacs
~kill-ring~.
Emacs has built-in support for synchronizing the system clipboard with
the ~kill-ring~ (see the variables ~interprogram-paste-function~ and
~save-interprogram-paste-before-kill~). This support is not optimal
because it makes the ~kill-ring~ only contain the last text of
consecutive copied texts. In other words, a user cannot copy multiple
pieces of text from an external application without going back to
Emacs in between.
On the contrary, gpastel supports this scenario by hooking into the
GPaste clipboard manager. This means that the ~kill-ring~ will
always contain everything the user copies in external applications,
not just the last piece of text.
Additionally, when using [[https://github.com/ch11ng/exwm][EXWM]] (the Emacs X Window Manager), gpastel
makes it possible for the user to use the ~kill-ring~ from external
applications.
** Installing
Add the following to your initialization file:
#+BEGIN_SRC emacs-lisp
(add-to-list 'load-path "~/.emacs.d/lib/gpastel/")
#+END_SRC
You also have to tell gpastel to start listening for GPaste events. If
you are using EXWM, add ~gpastel-mode~ to
~exwm-init-hook~. Otherwise, just add this line to your initialization file:
#+BEGIN_SRC emacs-lisp
(gpastel-mode)
#+END_SRC
** Usage
There is nothing more to do than copying text the normal way. All
copied texts should appear in the Emacs ~kill-ring~ now.
*** For EXWM users
If you use EXWM and you want to access the ~kill-ring~ from any
application (instead of the less powerful system clipboard), I
recommend you either install and configure [[http://oremacs.com/swiper/][counsel]] or
[[https://github.com/browse-kill-ring/browse-kill-ring][browse-kill-ring]]. Then, you can add one of the following two
configuration snippets to your initialization file.
**** For EXWM+counsel users
Add the following to your initialization file:
#+BEGIN_SRC emacs-lisp
(exwm-input-set-key (kbd "M-y") #'my/exwm-counsel-yank-pop)
(defun my/exwm-counsel-yank-pop ()
"Same as `counsel-yank-pop' and paste into exwm buffer."
(interactive)
(let ((inhibit-read-only t)
;; Make sure we send selected yank-pop candidate to
;; clipboard:
(yank-pop-change-selection t))
(call-interactively #'counsel-yank-pop))
(when (derived-mode-p 'exwm-mode)
;; https://github.com/ch11ng/exwm/issues/413#issuecomment-386858496
(exwm-input--set-focus (exwm--buffer->id (window-buffer (selected-window))))
(exwm-input--fake-key ?\C-v)))
#+END_SRC
**** For EXWM+browse-kill-ring users
[[https://github.com/kriyative][Ram Krishnan]] gives us the following piece of code for browse-kill-ring users:
#+BEGIN_SRC emacs-lisp
(define-advice browse-kill-ring-insert-and-highlight
(:around (old-function str) exwm-paste)
"Paste the selection appropriately in exwm mode buffers."
(if (not (derived-mode-p 'exwm-mode))
(funcall old-function str)
(kill-new str)
(exwm-input--fake-key ?\C-v)))
#+END_SRC
** License
See [[file:COPYING][COPYING]]. Copyright (c) 2018-2023 Damien Cassou.
#+BEGIN_HTML
#+END_HTML