Xfce Wiki

Sub domains
 

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
panel-plugins:xfce4-clipman-plugin:start [2020/08/16 16:31] – created kevinbowenpanel-plugins:xfce4-clipman-plugin:start [2024/12/09 07:15] (current) – [Search The History] kevinbowen
Line 7: Line 7:
   * **[[#Settings|Settings]]**   * **[[#Settings|Settings]]**
   * **[[#Action Settings|Action Settings]]**   * **[[#Action Settings|Action Settings]]**
-  * **[[#Tweaks Dialog|Tweaks Dialog]]** +  * **[[#History Settings|History Settings]]** 
-  * **[[#About Clipman|About Clipman]]**+  * **[[#Latest Release|Latest Release]]**
   * **[[#Source Code Repository|Source Code Repository]]**   * **[[#Source Code Repository|Source Code Repository]]**
   * **[[#Reporting Bugs|Reporting Bugs]]**   * **[[#Reporting Bugs|Reporting Bugs]]**
Line 21: Line 21:
 In X11 (all Unix platforms) there are by default two clipboards to exchange any data between the windows. A default clipboard which is modified by manual copies (for instance when you select a file and press the copy button), and there is a primary clipboard which is modified by selections (for instance when you select text in a field). In X11 (all Unix platforms) there are by default two clipboards to exchange any data between the windows. A default clipboard which is modified by manual copies (for instance when you select a file and press the copy button), and there is a primary clipboard which is modified by selections (for instance when you select text in a field).
  
-//**Clipman**// handles only the default clipboard, but optionally it can also notice the selections. When it is handling the selections, the default clipboard will always be synced with it and contain the same data. By this meaning you can paste with the keyboard what you select on screen.+//**Clipman**// manages both clipboards, either separately or synchronously, and may or may not add selections to its history.
  
 ---- ----
Line 28: Line 28:
 //**Clipman**// is used to keep in history a list of clipboard contents and to restore them. The history is displayed in a menu by clicking on the main icon. Within the menu it is possible to restore a text and to clear the history. //**Clipman**// is used to keep in history a list of clipboard contents and to restore them. The history is displayed in a menu by clicking on the main icon. Within the menu it is possible to restore a text and to clear the history.
  
-<figure "Clipman menu"> +<figure "Clipboard Manager: Dropdown Menu"> 
-{{:extra:clipman:clipman-menu.png?nolink&|}} +{{:panel-plugins:clipman:clipman-menu.png?|Clipboard Manager: Dropdown Menu}}
- +
-Shows the menu that popups when clicking the Clipman icon in the Xfce Panel or the notification area+
 </figure> </figure>
 +Shows the menu that popups when clicking the Clipman icon in the Xfce Panel or the notification area
  
 There are two ways to run //**Clipman**//. You can select //**Clipman**// in the applications menu under the category //Utility// or type ''xfce4-clipman'' on the command-line, or you can add it into your panel. To add a new item in the panel right click the panel and select //Add new item…//. There are two ways to run //**Clipman**//. You can select //**Clipman**// in the applications menu under the category //Utility// or type ''xfce4-clipman'' on the command-line, or you can add it into your panel. To add a new item in the panel right click the panel and select //Add new item…//.
  
 //**Clipman**// provides the command-line tool ''xfce4-popup-clipman''. When called it popups the main menu. The command is practical for the //**Application Shortcuts**// available at {gui>Xfce Menu>Settings>Keyboard}. //**Clipman**// provides the command-line tool ''xfce4-popup-clipman''. When called it popups the main menu. The command is practical for the //**Application Shortcuts**// available at {gui>Xfce Menu>Settings>Keyboard}.
 +
 +----
  
 ===== Search The History ===== ===== Search The History =====
  
-If you want to search the history of your clipboard you can use the command-line tool ''xfce4-clipman-history'' which+If you want to search the history of your clipboard, you can click on "Show full history…" in the menu or use the command-line tool ''xfce4-clipman-history'' which
   * shows the complete history   * shows the complete history
   * supports (fuzzy) type-ahead search   * supports (fuzzy) type-ahead search
Line 46: Line 47:
   * allows the user to switch from paste-on-activate to regular copying by holding down the Ctrl key   * allows the user to switch from paste-on-activate to regular copying by holding down the Ctrl key
  
 +<figure "Clipboard Manager: History Window">
 +{{:panel-plugins:clipman:clipman-history.png|Clipboard Manager: History Window}}
 +</figure>
 +
 +Clipman history dialog, shown by running ''xfce4-clipman-history'' or by clicking on the menu entry
  
 ---- ----
 ===== Settings ===== ===== Settings =====
  
-The settings dialog is available under the //Properties// item in the right click context menu on the main icon. It allows to tweak the history and to edit actions.+The settings dialog is available under the "Clipman settings…" item in the right click context menu on the main icon. It allows to tweak the history and to edit actions.
  
-==== General Settings ====+==== Behavior Settings ====
  
-The following table describes the available options in the //General// tab of the //Settings dialog//.+The following table describes the available options in the //Behavior// tab of the //Settings dialog//.
  
 ^ Option ^ Description ^ ^ Option ^ Description ^
-| Sync selections | Sync the primary clipboard with the default clipboard in a way that it is possible to paste what gets selected | +| Sync mouse selections | Sync the primary clipboard with the default clipboard in a way that it is possible to paste what gets selected | 
-| Save on quit | Keeps the history at every new session | +| Persist mouse selections | Make primary clipboard persist until next selection if current selection is lost (e.g. by left-clicking in a text area) | 
-| Store last copied image | Allows to store one image in the history | +| QR-Code support | Show the QR-Code of the currently selected clipboard entry | 
-| Ignore selections | Prevents the primary clipboard from being inserted in the history | +| Paste instantly | Automatically paste a selected item from the history | 
-| Reverse order | Reverse order of the history shown in the menu | +| Position menu at pointer | Only for the xfce4-popup-clipman command | 
-| Size of the history | Sets the number of items to keep in history | +| Maximum items | Number of menu items |
- +
-<figure "Clipman Settings (General)"> +
-{{:panel-plugins:clipman:clipman-settings-general.png?nolink&|}}+
  
-Settings dialog with the General tab+<figure "Clipboard Manager: Settings Behavior Tab"> 
 +{{:panel-plugins:clipman:clipman-settings-behavior.png|Clipboard Manager: Settings Behavior Tab}}
 </figure> </figure>
  
 [[|Back to Top]] [[|Back to Top]]
 ---- ----
-===== Action Settings =====+==== Action Settings ====
  
-An action is a pair of a name and a regular expression. Each action can have one or more commands. The support of actions is optional and can be enabled or disabled through the {gui>Enable actions} option.+An action is a pair of a name and a regular expression. Each action can have one or more commands. The support of actions is optional and can be enabled or disabled through the {gui>Enable automatic actions} option.
  
 To add an action click the {gui>Add} icon, to edit an action select the action and click the {gui>Edit} icon or double click the action, and to remove an action select an action and click the {gui>Delete} icon. By adding or editing an action a new dialog is opened. To add an action click the {gui>Add} icon, to edit an action select the action and click the {gui>Edit} icon or double click the action, and to remove an action select an action and click the {gui>Delete} icon. By adding or editing an action a new dialog is opened.
Line 80: Line 84:
 To learn more about actions go to [[#action_dialog|section Action Dialog]]. To learn more about actions go to [[#action_dialog|section Action Dialog]].
  
-<figure "Clipman Settings (Actions)"> +<figure "Clipboard Manager: Settings Actions Tab"> 
-{{:panel-plugins:clipman:clipman-settings-actions.png?nolink&|}} +{{:panel-plugins:clipman:clipman-settings-actions.png|Clipboard Manager: Settings Actions Tab}}
- +
-Settings dialog with the Actions tab+
 </figure> </figure>
  
-==== Action Dialog ====+=== Action Dialog ===
  
 An action has a human readable name that describes the pattern it is going to match. An action must have at least one command which also has a human readable name. The matched text can be reused in the command. An action has a human readable name that describes the pattern it is going to match. An action must have at least one command which also has a human readable name. The matched text can be reused in the command.
  
-The actions are always matched against text selections unless specified otherwise. When the box {gui>Activate only on manual copy} is checked, the action will be matched from the default clipboard (e.g. with {key>Ctrl+C}).+The actions are always matched against text selections unless specified otherwise. When the box {gui>Activate only on manual copy instead of selection} is checked, the action will be matched from the default clipboard (e.g. with {key>Ctrl+C}).
  
-<figure "Action Dialog"> +<figure "Clipboard Manager: Edit Action Dialog Window"> 
-{{:panel-plugins:clipman:clipman-action-dialog.png?nolink&|}}+{{:panel-plugins:clipman:clipman-action-dialog.png|Clipboard Manager: Edit Action Dialog Window}} 
 +</figure>
  
 Settings dialog showing the Action Dialog when creating or editing an action Settings dialog showing the Action Dialog when creating or editing an action
-</figure>+
  
 == Regular Expression == == Regular Expression ==
Line 129: Line 132:
 [[|Back to Top]] [[|Back to Top]]
 ---- ----
-===== Tweaks Dialog ===== 
  
-<figure "Tweaks Dialog"> +==== History Settings ====
-{{:panel-plugins:clipman:clipman-settings-tweaks.png?nolink&|}}+
  
-Settings dialog showing the Tweaks dialog+<figure "Clipboard Manager: Settings History Tab"> 
 +{{:panel-plugins:clipman:clipman-settings-history.png|Clipboard Manager: Settings History Tab}}
 </figure> </figure>
 +
 +^ Option ^ Description ^
 +| Remember history | Enable history |
 +| Remember last copied image | Allows to store one image in the history |
 +| Reorder history items | Push last copied text to the top of the history |
 +| Reverse history order | Reverse order of the history shown in the menu |
 +| Ignore mouse selections | Prevents the primary clipboard from being inserted in the history |
 +| Size of the history | Sets the number of items to keep in history (different from the number of menu items) |
 +
 +----
 ==== Xfconf ==== ==== Xfconf ====
  
Line 157: Line 169:
  
   xfconf-query -c xfce4-panel -p /plugins/clipman/property -s value   xfconf-query -c xfce4-panel -p /plugins/clipman/property -s value
 +
 +To list all settings type this command (the table above may be out of date):
 +
 +  xfconf-query -c xfce4-panel -lv | grep /plugins/clipman
  
 [[|Back to Top]] [[|Back to Top]]
 ---- ----
  
-===== About Clipman =====+===== Latest Release =====
  
-//**Clipman**// was written by Eduard Roccatello and then maintained by Nick Schermer, and nowadays it is written by Mike Massonnet. Visit the [[http://goodies.xfce.org/projects/panel-plugins/xfce4-clipman-plugin|Clipman Website]].+{{rss>https://archive.xfce.org/feeds/project/xfce4-clipman-plugin 1 date 2h}}
  
-This documentation was written by Mike Massonnet (mmassonnet@xfce.com). Please send all your comments and suggestions regarding this manual.+[[https://gitlab.xfce.org/panel-plugins/xfce4-clipman-plugin/-/blob/master/NEWS|Read the CHANGELOG]]
  
-This software is distributed under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.+  * **[[https://archive.xfce.org/src/panel-plugins/xfce4-clipman-plugin/|Download current release]]** (older versions of this component are also available here)
  
-You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA.+[[|Back to Top]]
  
 ---- ----
Line 179: Line 195:
  
 ===== Reporting Bugs ===== ===== Reporting Bugs =====
-If you are experiencing a bug in ''xfce4-clipman-plugin'', your way of helping things getting fixed is to report a bug about it in [[https://gitlab.xfce.org/explore/groups?sort=name_desc|Xfce GitLab]]. Please note that to do this you will need to have / create an account. +  * **[[:panel-plugins:xfce4-clipman-plugin:bugs|Reporting Bugs]]** -- List of currently open bugs and instructions on how to submit new bug reports
- +
- +
-<note important>Before reporting a new bug, please try your best to check if it has already been reported (see the latest reports below). [[https://gitlab.xfce.org/panel-plugins/xfce4-clipman-plugin/-/issues?scope=all&state=all|Click here for a full list of bug reports]].</note> +
- +
- +
-===== Report a new bug ===== +
- +
-If your bug has not been reported before, please [[https://gitlab.xfce.org/panel-plugins/xfce4-clipman-plugin/-/issues/new|submit a new bug report]]. +
- +
-When writing your bug report, try to be as descriptive as possible, but avoid verbosity; Mozilla has a nice guide on [[https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines|how to write a bug report]]. +
- +
-For more information, see [[https://docs.xfce.org/contribute/bugs/start|Bug Reporting and Fixing]]. +
- +
-**[[https://gitlab.xfce.org/panel-plugins/xfce4-clipman-plugin/-/issues/new|File a new bug or enhancement request]]** +
- +
----- +
- +
- +
-==== Open Bugs ==== +
-Here's a list (updated daily) of open bug reports with the date that bug was reported in parenthesis.+
  
-{{rss>https://gitlab.xfce.org/panel-plugins/xfce4-clipman-plugin/-/issues.atom?state=opened 20 1d date}} 
  
 [[|Back To Top]] [[|Back To Top]]
 ---- ----
-[[ :xfce:xfce4-panel:start:|Return to Main Xfce4-panel page]]+[[ :xfce:xfce4-panel:start:|Return to xfce4-panel Main Documentation Page]]