fish-shell/doc_src/cmds/fish_clipboard_paste.rst
Johannes Altmanninger c921c124ef docs: use canonical key names in :kbd: tags
This seems a bit better because it's what bind uses.  To makes sure that
something like :kbd:`ctrl-x` looks good in HTML, remove the border from the
kbd style.  Else both "ctrl" and "x" get small boxes which looks weird.
2024-04-20 15:36:29 +02:00

39 lines
1.2 KiB
ReStructuredText

.. _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:`ctrl-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.