From 96cc8e2a9799da0070fef19bfb6b4c062932d5d7 Mon Sep 17 00:00:00 2001 From: Yuri Chornoivan Date: Thu, 5 May 2022 11:20:39 +0300 Subject: [PATCH] Sync klipper docs with the current interface --- doc/klipper/index.docbook | 170 ++++++++++++++++++-------------------- 1 file changed, 80 insertions(+), 90 deletions(-) diff --git a/doc/klipper/index.docbook b/doc/klipper/index.docbook index c80ae4a6e..2f62a96f4 100644 --- a/doc/klipper/index.docbook +++ b/doc/klipper/index.docbook @@ -30,8 +30,8 @@ &FDLNotice; -2021-04-17 -Plasma 5.20 +2022-05-05 +Plasma 5.25 &klipper; is the &plasma; clipboard cut & paste utility. @@ -136,10 +136,10 @@ contents, select Disable This Popup on the pop-up men 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 +dialog, with the option Show action popup menu under the General page. You can separately disable the -file path part using the option Enable MIME-based actions under -the Actions page. +file path part using the option Include MIME actions under +the Action Menu page. Actions can be disabled completely by pressing the shortcut &Ctrl;&Alt;X. @@ -187,13 +187,12 @@ in a context menu. In order to change clipboard/selection behavior, select Configure Clipboard... 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 +General page. Unchecking Selection and Clipboard 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 +Ignore 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 +Selection and Clipboard 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 @@ -221,85 +220,70 @@ selected, the clipboard functions in the &UNIX; mode; if not, the - -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. - +Selection and Clipboard +When text or an area of the screen is highlighted with the mouse or +keyboard, this is the selection. It can be pasted using +the middle mouse button.If the selection is explicitly copied +using a Copy or Cut action, it +is saved to the clipboard. It can be pasted using a +Paste action.When turned on this option +keeps the selection and the clipboard the same, so that any selection is +immediately available to paste by any means. If it is turned off, the +selection may still be saved in the clipboard history (subject to the +options below), but it can only be pasted using the middle mouse button. - -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. +Clipboard history +Toggles clipboard history. - -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 . - - - +Number of entries +Sets the number of items that are stored +in the clipboard history. + -Text selection only +Text selection 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. +called the selection. This option determines wWhether text selections are +saved in the clipboard history. It is possible to choose between Always save +in history and Only when explicitly copied. The +Always save in history option is not available if +selection/clipboard synchronisation is turned off ‐ in this +case the selection is never automatically saved in the clipboard history. See . -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 . +Non-text selection +This option determines whether non-text selections (such as images) are +saved in the clipboard history. It is possible to choose between Always save +in history, Only when explicitly copied, and +Never save in history. The Always save in +history option is not available if selection/clipboard synchronisation +is turned off ‐ in this case the selection is never automatically saved in the +clipboard history. See . - -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 + +Action Menu + + +Show action popup menu +Set the time that a popup menu will remain for if you do +nothing with it. + + Replay actions on an item selected from history @@ -309,6 +293,28 @@ appropriate. +Exclude Windows +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: + + +Open the application. +From a terminal, run xprop +| grep WM_CLASS +and then click on the window of the application you are +running. +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. + + + Remove white space when executing actions If selected, any white space (spaces, tabs, &etc;) at the @@ -320,12 +326,18 @@ 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. +Include MIME actions +If selected, include applications that can accept its +&MIME; type of a file name or URL selected in the popup menu. + + + + +Actions Configuration + Editing Expressions/Actions On the Actions page, double-click @@ -362,28 +374,6 @@ the command kwrite 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: - - -Open the application. -From a terminal, run xprop -| grep WM_CLASS -and then click on the window of the application you are -running. -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. - -