mirror of
https://github.com/fish-shell/fish-shell.git
synced 2026-05-03 11:51:15 -03:00
Document fish_clipboard_copy/paste
This commit is contained in:
38
doc_src/cmds/fish_clipboard_paste.rst
Normal file
38
doc_src/cmds/fish_clipboard_paste.rst
Normal file
@@ -0,0 +1,38 @@
|
||||
.. _cmd-fish_clipboard_paste:
|
||||
|
||||
fish_clipboard_paste - get text from the system's clipboard
|
||||
==============================================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
.. synopsis::
|
||||
|
||||
fish_clipboard_paste
|
||||
|
||||
fish_clipboard_paste | foo
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
The ``fish_clipboard_paste`` function copies text from the system clipboard.
|
||||
|
||||
If its stdout is not a terminal (see :doc:`isatty <isatty>`), it will output everything there, as-is, without any additional newlines. If it is, it will put the text in the commandline instead.
|
||||
|
||||
If it outputs to the commandline, it will automatically escape the output if the cursor is currently inside single-quotes so it is suitable for single-quotes (meaning it escapes ``'`` and ``\\``).
|
||||
|
||||
It is bound to :kbd:`Control`\ +\ :kbd:`V` by default.
|
||||
|
||||
``fish_clipboard_paste`` works by calling a system-specific backend. If it doesn't appear to work you may need to install yours.
|
||||
|
||||
Currently supported are:
|
||||
|
||||
- ``pbpaste``
|
||||
- ``wl-paste`` using wayland
|
||||
- ``xsel`` and ``xclip`` for X11
|
||||
- ``powershell.exe`` on Windows (this backend has encoding limitations and uses windows line endings that ``fish_clipboard_paste`` undoes)
|
||||
|
||||
See also
|
||||
--------
|
||||
|
||||
- :doc:`fish_clipboard_copy` which does the inverse.
|
||||
Reference in New Issue
Block a user