doc_src/cmds/fish_clipboard_copy.rst

.. _cmd-fish_clipboard_copy:

fish_clipboard_copy - copy text to the system's clipboard
==============================================================

Synopsis
--------

.. synopsis::

    fish_clipboard_copy

    foo | fish_clipboard_copy

Description
-----------

The ``fish_clipboard_copy`` function copies text to the system clipboard.

If stdin is not a terminal (see :doc:`isatty <isatty>`), it will read all input from there and copy it. If it is, it will use the current commandline, or the current selection if there is one.

It is bound to :kbd:`ctrl-x` by default.

``fish_clipboard_copy`` works by calling a system-specific backend. If it doesn't appear to work you may need to install yours.

Currently supported are:

- ``pbcopy``
- ``wl-copy`` using wayland
- ``xsel`` and ``xclip`` for X11
- ``clip.exe`` on Windows.
- The OSC 52 clipboard sequence, which your terminal might support

See also
--------

- :doc:`fish_clipboard_paste` which does the inverse.
Document fish_clipboard_copy/paste 2022-10-19 20:05:10 +02:00			`.. _cmd-fish_clipboard_copy:`

			`fish_clipboard_copy - copy text to the system's clipboard`
			`==============================================================`

			`Synopsis`
			`--------`

			`.. synopsis::`

			`fish_clipboard_copy`

			`foo \| fish_clipboard_copy`

			`Description`
			`-----------`

			The ``fish_clipboard_copy`` function copies text to the system clipboard.

			If stdin is not a terminal (see :doc:`isatty <isatty>`), it will read all input from there and copy it. If it is, it will use the current commandline, or the current selection if there is one.

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-13 20:30:07 +02:00			It is bound to :kbd:`ctrl-x` by default.
Document fish_clipboard_copy/paste 2022-10-19 20:05:10 +02:00
			``fish_clipboard_copy`` works by calling a system-specific backend. If it doesn't appear to work you may need to install yours.

			`Currently supported are:`

			- ``pbcopy``
			- ``wl-copy`` using wayland
			- ``xsel`` and ``xclip`` for X11
			- ``clip.exe`` on Windows.
docs: Document fish_clipboard_copy's OSC 52 support 2025-02-08 12:17:55 +01:00			`- The OSC 52 clipboard sequence, which your terminal might support`
Document fish_clipboard_copy/paste 2022-10-19 20:05:10 +02:00
			`See also`
			`--------`

			- :doc:`fish_clipboard_paste` which does the inverse.