diff options
| -rw-r--r-- | docs/features/clipboard.rst | 29 |
1 files changed, 26 insertions, 3 deletions
diff --git a/docs/features/clipboard.rst b/docs/features/clipboard.rst index 6df655f7..73e206c2 100644 --- a/docs/features/clipboard.rst +++ b/docs/features/clipboard.rst @@ -1,10 +1,33 @@ Clipboard Integration ===================== - - sent to the operating system paste buffer, by ending with a bare ``>``, as - in ``mycommand args >``. You can even append output to the current contents - of the paste buffer by ending your command with ``>>``. +Nearly every operating system has some notion of a short-term storage area +which can be accessed by any program. Usually this is called the clipboard, but +sometimes people refer to it as the paste buffer. +``cmd2`` integrates with the operating system clipboard using the `pyperclip +<https://github.com/asweigart/pyperclip>`_ module. Command output can be sent +to the clipboard by ending the command with a greater than symbol: + +.. code-block:: text + + mycommand args > + +Think of it as though you are redirecting output to an unnamed, ephemeral +place, you know, like the clipboard. You can also append output to the current +contents of the clipboard by ending the command with two greater than symbols: + +.. code-block:: text + + mycommand arg1 arg2 >> + + +Developers +---------- + +If you would like your ``cmd2`` based application to be able to use the +clipboard in additional or alternative ways, you can use the following methods +(which work uniformly on Windows, macOS, and Linux). .. automodule:: cmd2.clipboard :members: |