spacemacs/layers/+tools/xclipboard/README.org

#+TITLE: xclipboard layer

* Table of Contents                     :TOC_4_gh:noexport:
- [[#description][Description]]
  - [[#requirements][Requirements]]
  - [[#features][Features:]]
- [[#key-bindings][Key bindings]]

* Description
=xclipboard= integration layer.

** Requirements
This layer depends on a few platform-specific command-line tools:
- on OSX, this layer calls =pbcopy=
- on Windows, this layer calls =clip.exe=
- on GNU/Linux systems, this layer relies on =xsel= to be available.

Note that =xsel= might not be installed by default on e.g. Ubuntu systems.

** Features:
- adds copy support to the X-clipboard from the terminal.
- adds paste support to the X-clipboard from the terminal.

* Key bindings

| Key binding | Description                                 |
|-------------+---------------------------------------------|
| ~SPC x p~   | Paste clipboard contents at cursor position |
| ~SPC x y~   | Copy selection to clipboard                 |
Add X clipboard support layer to terminal emacs. The X clipboard allows a user to copy and paste content between different X windows, e.g. copying text from Chrome into a Terminal. Copy/pasting with the X clipboard it well supported in GUI Emacs, but not so well in terminal Emacs (i.e `emacs -nw` or `emacsclient -t`) without resorting to using the mouse, since terminal Emacs has no awareness of X. There are several incomplete Elisp solutions out that work for the most part, but may not have cross-platform support, or may fail over SSH with X forwarding or within a `tmux` session. This layer adds support for OSX, Linux, Windows, and Cygwin using the relevant binary on each system. For example on Linux, it uses `xsel` or `xclip` to interface with the clipboard, depending which one is available. It also adds support for ssh'ing into a different OS with X forwarding via `ssh -Y hostname`, and copy/pasting to and from a remote terminal Emacs. It also supports an edge case of continuing to work in an Emacs instance running inside a `tmux` session which may have been started by a different ssh session, which relies on explicitly reseting the `$DISPLAY` environment variable before calling the relevant binary. Yank code inspired by https://github.com/tmux-plugins/tmux-yank. Fix #4662. Tried to add xclip support but removed it since it freezes. 2017-05-08 03:08:52 +00:00			`#+TITLE: xclipboard layer`

Reformat documentation 2018-09-19 03:54:47 +00:00			`* Table of Contents :TOC_4_gh:noexport:`
Move xclipboard to a local package 2018-05-11 04:19:21 +00:00			`- [[#description][Description]]`
documentation formatting: Tue Apr 23 22:20:06 UTC 2019 2019-04-23 22:20:06 +00:00			`- [[#requirements][Requirements]]`
Format documentation. 2018-05-19 16:43:48 +00:00			`- [[#features][Features:]]`
documentation formatting: Wed Dec 5 03:03:03 UTC 2018 2018-12-05 03:03:03 +00:00			`- [[#key-bindings][Key bindings]]`
Add X clipboard support layer to terminal emacs. The X clipboard allows a user to copy and paste content between different X windows, e.g. copying text from Chrome into a Terminal. Copy/pasting with the X clipboard it well supported in GUI Emacs, but not so well in terminal Emacs (i.e `emacs -nw` or `emacsclient -t`) without resorting to using the mouse, since terminal Emacs has no awareness of X. There are several incomplete Elisp solutions out that work for the most part, but may not have cross-platform support, or may fail over SSH with X forwarding or within a `tmux` session. This layer adds support for OSX, Linux, Windows, and Cygwin using the relevant binary on each system. For example on Linux, it uses `xsel` or `xclip` to interface with the clipboard, depending which one is available. It also adds support for ssh'ing into a different OS with X forwarding via `ssh -Y hostname`, and copy/pasting to and from a remote terminal Emacs. It also supports an edge case of continuing to work in an Emacs instance running inside a `tmux` session which may have been started by a different ssh session, which relies on explicitly reseting the `$DISPLAY` environment variable before calling the relevant binary. Yank code inspired by https://github.com/tmux-plugins/tmux-yank. Fix #4662. Tried to add xclip support but removed it since it freezes. 2017-05-08 03:08:52 +00:00
			`* Description`
Format documentation. 2018-05-19 16:43:48 +00:00			`=xclipboard= integration layer.`

[xclipboard] Update README.org A simple edit adding documentation about the various platform-specific programs this layers interacts with. 2018-11-21 15:30:54 +00:00			`** Requirements`
			`This layer depends on a few platform-specific command-line tools:`
			`- on OSX, this layer calls =pbcopy=`
			`- on Windows, this layer calls =clip.exe=`
			`- on GNU/Linux systems, this layer relies on =xsel= to be available.`

			`Note that =xsel= might not be installed by default on e.g. Ubuntu systems.`

Format documentation. 2018-05-19 16:43:48 +00:00			`** Features:`
Reformat documentation 2018-09-19 03:54:47 +00:00			`- adds copy support to the X-clipboard from the terminal.`
			`- adds paste support to the X-clipboard from the terminal.`
Add X clipboard support layer to terminal emacs. The X clipboard allows a user to copy and paste content between different X windows, e.g. copying text from Chrome into a Terminal. Copy/pasting with the X clipboard it well supported in GUI Emacs, but not so well in terminal Emacs (i.e `emacs -nw` or `emacsclient -t`) without resorting to using the mouse, since terminal Emacs has no awareness of X. There are several incomplete Elisp solutions out that work for the most part, but may not have cross-platform support, or may fail over SSH with X forwarding or within a `tmux` session. This layer adds support for OSX, Linux, Windows, and Cygwin using the relevant binary on each system. For example on Linux, it uses `xsel` or `xclip` to interface with the clipboard, depending which one is available. It also adds support for ssh'ing into a different OS with X forwarding via `ssh -Y hostname`, and copy/pasting to and from a remote terminal Emacs. It also supports an edge case of continuing to work in an Emacs instance running inside a `tmux` session which may have been started by a different ssh session, which relies on explicitly reseting the `$DISPLAY` environment variable before calling the relevant binary. Yank code inspired by https://github.com/tmux-plugins/tmux-yank. Fix #4662. Tried to add xclip support but removed it since it freezes. 2017-05-08 03:08:52 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018 2018-12-05 03:03:03 +00:00			`* Key bindings`
Add X clipboard support layer to terminal emacs. The X clipboard allows a user to copy and paste content between different X windows, e.g. copying text from Chrome into a Terminal. Copy/pasting with the X clipboard it well supported in GUI Emacs, but not so well in terminal Emacs (i.e `emacs -nw` or `emacsclient -t`) without resorting to using the mouse, since terminal Emacs has no awareness of X. There are several incomplete Elisp solutions out that work for the most part, but may not have cross-platform support, or may fail over SSH with X forwarding or within a `tmux` session. This layer adds support for OSX, Linux, Windows, and Cygwin using the relevant binary on each system. For example on Linux, it uses `xsel` or `xclip` to interface with the clipboard, depending which one is available. It also adds support for ssh'ing into a different OS with X forwarding via `ssh -Y hostname`, and copy/pasting to and from a remote terminal Emacs. It also supports an edge case of continuing to work in an Emacs instance running inside a `tmux` session which may have been started by a different ssh session, which relies on explicitly reseting the `$DISPLAY` environment variable before calling the relevant binary. Yank code inspired by https://github.com/tmux-plugins/tmux-yank. Fix #4662. Tried to add xclip support but removed it since it freezes. 2017-05-08 03:08:52 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018 2018-12-05 03:03:03 +00:00			`\| Key binding \| Description \|`
Add X clipboard support layer to terminal emacs. The X clipboard allows a user to copy and paste content between different X windows, e.g. copying text from Chrome into a Terminal. Copy/pasting with the X clipboard it well supported in GUI Emacs, but not so well in terminal Emacs (i.e `emacs -nw` or `emacsclient -t`) without resorting to using the mouse, since terminal Emacs has no awareness of X. There are several incomplete Elisp solutions out that work for the most part, but may not have cross-platform support, or may fail over SSH with X forwarding or within a `tmux` session. This layer adds support for OSX, Linux, Windows, and Cygwin using the relevant binary on each system. For example on Linux, it uses `xsel` or `xclip` to interface with the clipboard, depending which one is available. It also adds support for ssh'ing into a different OS with X forwarding via `ssh -Y hostname`, and copy/pasting to and from a remote terminal Emacs. It also supports an edge case of continuing to work in an Emacs instance running inside a `tmux` session which may have been started by a different ssh session, which relies on explicitly reseting the `$DISPLAY` environment variable before calling the relevant binary. Yank code inspired by https://github.com/tmux-plugins/tmux-yank. Fix #4662. Tried to add xclip support but removed it since it freezes. 2017-05-08 03:08:52 +00:00			`\|-------------+---------------------------------------------\|`
			`\| ~SPC x p~ \| Paste clipboard contents at cursor position \|`
Move xclipboard to a local package 2018-05-11 04:19:21 +00:00			`\| ~SPC x y~ \| Copy selection to clipboard \|`