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:clipman:start [2013/03/22 08:58] – created mikepanel-plugins:clipman:start [2023/07/31 21:03] (current) – Update from https://docs.xfce.org/panel-plugins/xfce4-clipman-plugin/start gael
Line 1: Line 1:
-====== Clipman ======+~~NOTOC~~ 
 +{{ :panel-plugins:xfce4-clipman-plugin.png?nolink|}} 
 +====== Clipman - xfce4-clipman-plugin ======
  
-This manual describes //**Clipman**// version 1.2.0. +  * **[[#Getting Started|Getting Started]]** 
- +  * **[[#Search The History|Search The History]]** 
-Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. The complete license text is available from the [[http://www.fsf.org/|Free Software Foundation]].+  * **[[#Settings|Settings]]** 
 +  * **[[#Action Settings|Action Settings]]** 
 +  * **[[#History Settings|History Settings]]** 
 +  * **[[#About Clipman|About Clipman]]** 
 +  * **[[#Latest Release|Latest Release]]** 
 +  * **[[#Source Code Repository|Source Code Repository]]** 
 +  * **[[#Reporting Bugs|Reporting Bugs]]**
  
 +----
 ===== Introduction ===== ===== Introduction =====
  
Line 13: Line 22:
 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 optionnaly 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.
  
-==== Getting Started ====+---- 
 +===== Getting Started =====
  
 //**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 "Clipman menu">
-{{:extra:clipman:clipman-menu.png?nolink&|}}+{{:panel-plugins:clipman:clipman-menu.png?nolink&|}}
  
 Shows the menu that popups when clicking the Clipman icon in the Xfce Panel or the notification area Shows the menu that popups when clicking the Clipman icon in the Xfce Panel or the notification area
Line 29: Line 39:
 //**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 =====
 +
 +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
 +  * supports (fuzzy) type-ahead search
 +  * supports paste-on-activate (i.e. pastes the selected text directly into the previously active window on hitting "return")
 +  * allows the user to switch from paste-on-activate to regular copying by holding down the Ctrl key
 +
 +<figure "Clipman menu">
 +{{:panel-plugins:clipman:clipman-history.png?nolink&|}}
 +
 +Clipman history dialog, shown by running xfce4-clipman-history or by clicking on the menu entry
 +</figure>
 +
 +
 +----
 ===== 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)"> +<figure "Clipman Settings (Behavior)"> 
-{{:extra:clipman:clipman-settings-general.png?nolink&|}}+{{:panel-plugins:clipman:clipman-settings-behavior.png?nolink&|}}
  
-Settings dialog with the General tab+Settings dialog with the Behavior tab
 </figure> </figure>
 +
 +[[|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 59: Line 90:
  
 <figure "Clipman Settings (Actions)"> <figure "Clipman Settings (Actions)">
-{{:extra:clipman:clipman-settings-actions.png?nolink&|}}+{{:panel-plugins:clipman:clipman-settings-actions.png?nolink&|}}
  
 Settings dialog with the Actions tab Settings dialog with the Actions tab
Line 68: Line 99:
 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 "Action Dialog">
-{{:extra:clipman:clipman-action-dialog.png?nolink&|}}+{{:panel-plugins:clipman:clipman-action-dialog.png?nolink&|}}
  
 Settings dialog showing the Action Dialog when creating or editing an action Settings dialog showing the Action Dialog when creating or editing an action
Line 104: Line 135:
 For example, from the simple pattern "''bug #(123)''" it is possible to use "''\0''" for the text "''bug #123''" and "''\1''" for the text "''123''". With the command "''<nowiki>exo-open http://host/\1</nowiki>''", the real executed command would be "''<nowiki>exo-open http://host/123</nowiki>''". For example, from the simple pattern "''bug #(123)''" it is possible to use "''\0''" for the text "''bug #123''" and "''\1''" for the text "''123''". With the command "''<nowiki>exo-open http://host/\1</nowiki>''", the real executed command would be "''<nowiki>exo-open http://host/123</nowiki>''".
  
 +
 +[[|Back to Top]]
 +----
 +
 +==== History Settings ====
 +
 +<figure "Clipman Settings (History)">
 +{{:panel-plugins:clipman:clipman-settings-history.png?nolink&|}}
 +
 +Settings dialog showing the History tab
 +</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 126: Line 178:
   xfconf-query -c xfce4-panel -p /plugins/clipman/property -s value   xfconf-query -c xfce4-panel -p /plugins/clipman/property -s value
  
-===== Support =====+To list all settings type this command (the table above may be out of date):
  
-To report a bug or a feature request use the bug tracking system at [[http://bugzilla.xfce.org/|bugzilla.xfce.org]]. If you have questions about the use of this software, please ask on the [[https://mail.xfce.org/mailman/listinfo/xfce|Xfce mailing list]], or point your IRC client to ''irc.freenode.net'' and join the channel ''#xfce'' and ask for help.+  xfconf-query -c xfce4-panel -lv | grep /plugins/clipman 
 + 
 +[[|Back to Top]] 
 +----
  
 ===== About Clipman ===== ===== About Clipman =====
  
-//**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]]. +//**Clipman**// was written by Eduard Roccatello and then maintained by Nick Schermer and rewritten by Mike Massonnet. Nowadays it is maintained by the Xfce development team.
- +
-This documentation was written by Mike Massonnet (mmassonnet@xfce.com). Please send all your comments and suggestions regarding this manual.+
  
 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. 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.
Line 140: Line 193:
 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. 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.
  
 +----
 +
 +===== Latest Release =====
 +
 +{{rss>https://archive.xfce.org/feeds/project/xfce4-clipman-plugin 1 date 2h}}
 +
 +[[https://gitlab.xfce.org/panel-plugins/xfce4-clipman-plugin/-/blob/master/NEWS|Read the CHANGELOG]]
 +
 +  * **[[https://archive.xfce.org/src/panel-plugins/xfce4-clipman-plugin/|Download current release]]** (link also contains older versions)
 +
 +[[|Back to Top]]
 +
 +----
 +
 +===== Source code repository =====
 +[[https://gitlab.xfce.org/panel-plugins/xfce4-clipman-plugin]]
 +
 +----
 +
 +===== Reporting Bugs =====
 +  * **[[:panel-plugins:xfce4-clipman-plugin:bugs|Reporting Bugs]]** -- Open bug reports and how to report new bugs
 +
 +
 +[[|Back To Top]]
 +----
 +[[ :xfce:xfce4-panel:start:|Return to Main Xfce4-panel page]]