# The &klipper; Handbook

## Introduction

&klipper; is the &plasma; clipboard utility. It stores clipboard history, and allows you to link clipboard contents to application actions. Please report any problems or feature requests to KDEs bugzilla.

## Using &klipper;

### Basic Usage

You can use &klipper; in the systemtray either as &plasma; widget or classic application. Both share the same functionality but have a different &GUI; and show the last item of the history when hovering the &klipper; icon in the systemtray:

The &klipper; icon. The &klipper; icon

The &klipper; widget is hidden if the clipboard is empty.

To display the clipboard history, click on the &klipper; icon in the systemtray.

#### &klipper; Widget

The &klipper; Widget. The &klipper; Widget

Hover an entry with the mouse pointer and four icons appear which enable you to invoke an action, show the barcode, edit the content or remove the entry from the history. Use &ksnapshot; to capture the barcodes and save them.

You can search through the clipboard history by opening it (click on &klipper;) and typing your query. The results are updated as you type. To clear the clipboard history click on the icon at the right of the search field.

The Configure action in the context menu opens the settings dialog.

To disable the &klipper; widget, deselect it in the General page of the System Tray Settings (&Alt;D, S).

#### &klipper; Application

The &klipper; Application. The &klipper; Application

At the top of the available menu actions previous clipboard entries are shown. Selecting one of these copies it to the clipboard, from where it can be pasted into any &kde; or X application as usual.

You can search through the clipboard history by typing your query in the search field at the top. The results are updated as you type.

### Actions

&klipper; can perform actions on the contents of the clipboard, based on whether they match a particular regular expression. For example, any clipboard contents starting with http:// can be passed to Firefox or &konqueror; as &URL;s to open. In addition, if the contents matches a path, similar actions can be performed according to the file's type. ⪚, if the path to a PDF file is copied to the clipboard, the file can be viewed in &okular;.

To use this feature, just select a &URL; or path. If there is a matching regular expression in &klipper;'s list, a menu will appear showing you the programs for your selection. Use the mouse or cursor keys to select a program, and &klipper; will run this program, opening the address pointed to by the selection.

If you do not want to perform any actions on the clipboard contents, select Disable This Popup on the pop-up menu to return to what you were doing before. If you leave the menu, it will disappear, leaving you to continue your work. You can change the time that the menu remains for in the settings dialog, with the option Timeout for action popups under the General page. You can separately disable the file path part using the option Enable MIME-based actions under the Actions page.

Actions can be disabled completely by pressing the shortcut &Ctrl;&Alt;X.

Clipboard contents which match a regular expression can also be edited before performing an action on them. Select Edit contents... at the right of the clipboard entry, and you can change the clipboard contents in the dialog which appears, before clicking the OK button to run the appropriate action.

Pressing &Ctrl;&Alt;R shows the pop-up menu to repeat the last action which &klipper; performed.

### Clipboard/Selection Behavior

#### General

&klipper; can be used to set the behavior of the clipboard and selection in &plasma;.

The &X-Window; uses two separate clipboard buffers: the selection and the clipboard. Text is placed in the selection buffer by simply selecting it, and can be pasted with the middle mouse button. To place text in the clipboard buffer, select it and press &Ctrl;X or &Ctrl;C . Text from the clipboard buffer is pasted using &Ctrl;V or by selecting Paste in a context menu.

#### Changing Clipboard/Selection Behavior

In order to change clipboard/selection behavior, select Configure &klipper;... from the &klipper; context menu, and in the dialog box that appears, select the General page. Unchecking Synchronize contents of the clipboard and the selection makes the clipboard and selection function as completely separate buffers as described above. With this option set, the option Ignore selection will prevent &klipper; from including the contents of the selection in its clipboard history and from performing actions on the contents of the selection. Selecting Synchronize contents of the clipboard and the selection causes the clipboard and selection buffers to always be the same, meaning that text in the selection can be pasted with either the middle mouse button or the key combination &Ctrl;V , and similarly for text in the clipboard buffer.

## Configuring &klipper;

### General Options

Save clipboard contents on exit

- If this option is on, the clipboard history will be saved when &klipper; exits, allowing you to use it next time &klipper; starts.

Prevent empty clipboard

- If selected, the clipboard will never be empty: &klipper; will insert the most recent item from the clipboard history into the clipboard instead of allowing it to be empty.

Ignore images

- When an area of the screen is selected with mouse or keyboard, this is called the selection. If this option is selected, only text selections are stored in the history, while images and other selections are not.

Ignore selection

- Sets the clipboard mode. This option will prevent &klipper; from including the contents of the selection in its clipboard history and from performing actions on the contents of the selection. See clipboard-modes.

Text selection only

- When an area of the screen is selected with mouse or keyboard, this is called the selection. If this option is selected, only text selections are stored in the history, while images and other selections are not. See clipboard-modes.

Synchronize contents of the clipboard and the selection

- Sets the clipboard mode. When an area of the screen is selected with mouse or keyboard, this is called the selection. If this option is selected, the selection and the clipboard is kept the same, so that anything in the selection is immediately available for pasting elsewhere using any method, including the traditional middle mouse button. Otherwise, the selection is recorded in the clipboard history, but the selection can only be pasted using the middle mouse button. Also see the Ignore selection option. See clipboard-modes.

Timeout for action popups

- Set the time that a popup menu will remain for if you do nothing with it.

Clipboard history size

- Sets the number of items that are stored in the clipboard history.

### Actions Options

Replay actions on an item selected from history

- If this is switched on, selecting an item from the history causes &klipper; to display the actions pop-up on that item, if appropriate.

Remove white space when executing actions

- If selected, any white space (spaces, tabs, &etc;) at the beginning and end of the clipboard contents will be removed before passing the clipboard contents to an application. This is useful, for example, if the clipboard contains a &URL; with spaces which, if opened by a web browser, would cause an error.

Enable MIME-based actions

- If selected, in addition to the actions you defined a list of applications for the detected MIME type will appear in the popup menu.

Editing Expressions/Actions

- On the Actions page, double-click the regular expression or action that you want to edit or select it and press the Edit Action button. A dialog will appear in which the expression text can be edited as you wish.

Adding Expressions/Actions

- Click the Add Action... button to add a regular expression for &klipper; to match. &klipper; uses &Qt;'s `QRegExp`, which understands most regular expressions as you would use in grep or egrep for instance.

  You can add a description of the regular expression type (⪚ HTTP URL) by left clicking in the Description column.

  You can find detailed information about the use of `QRegExp` regular expressions at http://doc.qt.io/qt-5/qregexp.html#details. Note that &klipper; does not support the wildcard mode mentioned on this page.

  Edit the regular expression as described above. To add a command to execute, click Add Command and edit the command in an in-place text editing box. Double-clicking on a command allows you to edit it.

  Note that %s in the command line is replaced with the clipboard contents, ⪚ if your command definition is ``kwrite` %s` and your clipboard contents are `/home/phil/textfile`, the command ``kwrite` `/home/phil/textfile`` will be run. To include %s in the command line, escape it with a backslash, as so: `\%s`.

Advanced

- Brings up the Disable Actions for windows of type WM_CLASS dialog.

  Some programs, such as &konqueror;, use the clipboard internally. If you get unwanted &klipper; pop-ups all the time when using a certain application, do the following:

  1. Open the application.

  2. From a terminal, run ``xprop` | `grep` `WM_CLASS`` and then click on the window of the application you are running.

  3. The first string after the equals sign is the one to enter.

  Once the WM_CLASS is added, no more actions will be generated for windows of that application.

### Shortcuts Options

The shortcuts page allows you to change the keyboard shortcuts which are used to access &klipper; functions. You can change the shortcut to one of three things:

None

- The selected action cannot be accessed directly from the keyboard

Default

- The selected action uses &klipper;'s default key. These are the shortcuts referred to in this manual.

Custom

- The selected action is assigned to the keys you choose.

  To choose a custom key for the action you have selected, click on Custom and then None. Now type the desired key combination on your keyboard, as in any &kde; application.

If you define a shortcut for Open Klipper at Mouse Position pressing this shortcut will open the &klipper; popup menu at the position of the mouse cursor, instead of their default position (in the &plasma; Panel). Useful if you use the mouse more than the keyboard.

## Credits and License

&klipper;

Program copyright 1998 &Andrew.Stanley-Jones; asj@cban.com

Program copyright 1998-2000 &Carsten.Pfeiffer; &Carsten.Pfeiffer.mail;

Currently maintained by Esben Mose Hansen. See http://mosehansen.dk/about for contact details.

Documentation copyright 2000-2003, 2005 &Philip.Rodrigues; &Philip.Rodrigues.mail;

&underFDL; &underGPL;
&documentation.index;