1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Clipman Manual</title><link rel="stylesheet" href="../xfce.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><link rel="home" href="#xfce4-clipman-plugin" title="Clipman Manual"><link rel="next" href="#intro" title="Introduction"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="xfce4-clipman-plugin"></a>Clipman Manual</h2></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Mike</span> <span class="surname">Massonnet</span></h3><div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:mmassonnet@xfce.org">mmassonnet@xfce.org</a>></code></p></div></div></div></div></div><div><span xmlns="http://www.w3.org/TR/xhtml1/transitional" class="releaseinfo">
2
This manual describes version 1.0.0 of Clipman.
3
<br></br></span></div><div><p class="copyright">Copyright � 2009 Mike Massonnet</p></div><div><div class="legalnotice"><a name="legalnotice"></a><p>
4
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free
5
Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no
6
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. The complete license text is
7
available from the <a class="ulink" href="http://www.fsf.org/" target="_top">Free Software Foundation</a>.
8
</p></div></div><div><p class="pubdate">April 2009</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#intro">Introduction</a></span></dt><dd><dl><dt><span class="sect2"><a href="#anatomy-clipboard">Anatomy of a Clipboard</a></span></dt></dl></dd><dt><span class="sect1"><a href="#usage">Usage</a></span></dt><dt><span class="sect1"><a href="#settings">Settings</a></span></dt><dd><dl><dt><span class="sect2"><a href="#history">History</a></span></dt><dt><span class="sect2"><a href="#actions">Actions</a></span></dt><dt><span class="sect2"><a href="#xfconf">Xfconf</a></span></dt></dl></dd><dt><span class="sect1"><a href="#action">Action</a></span></dt><dd><dl><dt><span class="sect2"><a href="#regexes">Regular Expression</a></span></dt><dt><span class="sect2"><a href="#command">Command</a></span></dt></dl></dd><dt><span class="sect1"><a href="#support">Support</a></span></dt><dt><span class="sect1"><a href="#about">About Clipman</a></span></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="intro"></a>Introduction</h2></div></div></div><p>
9
Clipman is a clipboard manager for Xfce. It keeps the clipboard contents around while it is usually lost
10
when you close an application. It is able to handle text and images, and has a feature to execute actions on
11
specific text selections by matching them against regular expressions.
13
There are two ways to run Clipman. You can select Clipman in the applications menu under the category
14
Utility or type <span class="command"><strong>xfce4-clipman-plugin</strong></span> on the command line, or you can add it into your panel. To
15
add a new item in the panel right click the panel and select “Add new item…”.
16
</p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="anatomy-clipboard"></a>Anatomy of a Clipboard</h3></div></div></div><p>
17
In X11 (all Unix platforms) there are by default two clipboards to exchange any data between the windows. A
18
default clipboard which is modified by manual copies (for instance when you select a file and press the copy
19
button), and there is a primary clipboard which is modified by selections (for instance when you select text in
22
Clipman handles only the default clipboard, but optionnaly it can also notice the selections. When it is
23
handling the selections, the default clipboard will always be synced with it and contain the same data.
24
</p></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="usage"></a>Usage</h2></div></div></div><p>
25
Clipman is used to keep in history a list of clipboard contents and to restore them. The history is
26
displayed in a menu by clicking on the main icon. Within the menu it is possible to select an item to restore it,
27
to clear the history and to activate or deactivate the clipboard manager.
28
</p><div class="screenshot"><div class="mediaobject"><img src="images/clipman-menu.png" alt="Menu displaying the history"></div></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="settings"></a>Settings</h2></div></div></div><p>
29
The settings dialog is available under the “Properties” item in the right click context menu on the main icon. It
30
allows to tweak the history and to edit actions.
31
</p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="history"></a>History</h3></div></div></div><p>
32
The following table describes the available options for the history:
33
</p><div class="table"><a name="id2930971"></a><p class="title"><b>Table�1.�History options in the Settings dialog</b></p><div class="table-contents"><table xmlns="http://www.w3.org/TR/xhtml1/transitional" bgcolor="#F8F9FD" cellspacing="0" cellpadding="4" summary="History options in the Settings dialog" border="1"><colgroup><col xmlns=""><col xmlns=""></colgroup><thead xmlns=""><tr><th align="left">Options</th><th align="left">Description</th></tr></thead><tbody xmlns=""><tr><td align="left">Save on quit</td><td align="left">Keeps the history at every new session</td></tr><tr><td align="left">Add selections</td><td align="left">Adds the selections to the history</td></tr><tr><td align="left">Store an image</td><td align="left">Allows to store one image in the history</td></tr><tr><td align="left">Size of the history</td><td align="left">Sets the number of items to keep in history</td></tr></tbody></table></div></div><br class="table-break"><div class="screenshot"><div class="mediaobject"><img src="images/clipman-settings-general.png" alt="Settings dialog with the General tab"></div></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="actions"></a>Actions</h3></div></div></div><p>
34
An action is a pair of an action name and a regular expression. Each action can have one or more commands. The
35
support of actions is optional and can be enabled or disabled through the “Enable actions” option.
37
To add an action click the Add icon, to edit an action select the action and click the Edit icon or double click
38
the action, and to remove an action select an action and click the Delete icon. By adding or editing an action a
41
To learn more about actions go to <a class="xref" href="#action" title="Action">the section called “Action”</a>.
42
</p><div class="screenshot"><div class="mediaobject"><img src="images/clipman-settings-actions.png" alt="Settings dialog with the Actions tab"></div></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfconf"></a>Xfconf</h3></div></div></div><p>
43
Clipman uses Xfconf to store its settings in the <code class="constant">xfce4-panel</code> channel. That allows you
44
to change the settings with the tool <span class="command"><strong>xfconf-query</strong></span>. The following table lists all the
45
properties with their possible values:
46
</p><div class="table"><a name="id2930547"></a><p class="title"><b>Table�2.�Xfconf Properties</b></p><div class="table-contents"><table xmlns="http://www.w3.org/TR/xhtml1/transitional" bgcolor="#F8F9FD" cellspacing="0" cellpadding="4" summary="Xfconf Properties" border="1"><colgroup><col xmlns=""><col xmlns=""><col xmlns=""><col xmlns=""></colgroup><thead xmlns=""><tr><th align="left">Property</th><th align="left">Type</th><th align="left">Default</th><th align="left">Values</th></tr></thead><tbody xmlns=""><tr><td align="left">/plugins/clipman/settings/add-primary-clipboard</td><td align="left">bool</td><td align="left">false</td><td align="left">true to add selections</td></tr><tr><td align="left">/plugins/clipman/settings/enable-actions</td><td align="left">bool</td><td align="left">false</td><td align="left">true to enable actions</td></tr><tr><td align="left">/plugins/clipman/settings/max-images-in-history</td><td align="left">uint</td><td align="left">0</td><td align="left">0-5 number of images in history</td></tr><tr><td align="left">/plugins/clipman/settings/max-texts-in-history</td><td align="left">uint</td><td align="left">10</td><td align="left">5-100 number of texts in history</td></tr><tr><td align="left">/plugins/clipman/settings/save-on-quit</td><td align="left">bool</td><td align="left">true</td><td align="left">true to restore the history at every new session</td></tr></tbody></table></div></div><br class="table-break"><p>
47
To change a setting type the command-line:
48
</p><code class="literal">xfconf-query -c xfce4-panel -p <property> -s <value></code></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="action"></a>Action</h2></div></div></div><p>
49
An action has a human readable name that describes the pattern it is going to match. The matches are made against
50
text from the selections and the pattern is a regular expression. An action must have at least one command which
51
also has a human readable name. The matched text can be reused in the command.
52
</p><div class="screenshot"><div class="mediaobject"><img src="images/clipman-action-dialog.png" alt="Action edit dialog"></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="regexes"></a>Regular Expression</h3></div></div></div><p>
53
Basic special characters: "<span class="bold"><strong><code class="code">.?+*(|)[]\</code></strong></span>".
54
</p><div class="itemizedlist"><ul type="disc"><li>
55
”<span class="bold"><strong><code class="code">.</code></strong></span>”: represents a single character.
57
”<span class="bold"><strong><code class="code">?+*</code></strong></span>”: respectively means zero or one character, one or more
58
characters, and zero or more characters.
60
”<span class="bold"><strong><code class="code">(|)</code></strong></span>”: used for grouping and substitution, the vertical bar is
61
used as an OR operation.
63
”<span class="bold"><strong><code class="code">[^]</code></strong></span>”: used to match a character from a set of characters and
64
special characters, the circumflex is used at the start as a negation.
66
”<span class="bold"><strong><code class="code">\</code></strong></span>”: escapes a special character.
68
Basic alphanumeric character class: "<span class="bold"><strong><code class="code">A-Za-z0-9</code></strong></span>". Character classes
69
are used within square brackets to represent a set of characters.
70
</p><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="regexes-examples"></a>Examples</h4></div></div></div><div class="itemizedlist"><ul type="disc"><li>
71
"<span class="bold"><strong><code class="code">bug ?#?[0-9]+</code></strong></span>": text "<span class="emphasis"><em>bug </em></span>", zero or one
72
space, zero or one sharp character, and one or more numbers.
74
"<span class="bold"><strong><code class="code">(http|ftp).+\.(jpg|png|gif)</code></strong></span>": text
75
"<span class="emphasis"><em>http</em></span>" or "<span class="emphasis"><em>ftp</em></span>", one or more character, a point, and the text
76
"<span class="emphasis"><em>jpg</em></span>", "<span class="emphasis"><em>png</em></span>" or "<span class="emphasis"><em>gif</em></span>".
78
"<span class="bold"><strong><code class="code">http://.{120}[^ ]+</code></strong></span>": text "<span class="emphasis"><em>http://</em></span>", 120
79
characters, and one or more characters except a space.
80
</li></ul></div></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="regexes-external-ressource"></a>External Ressource</h4></div></div></div><p>
81
Have a look at the <a class="ulink" href="http://en.wikipedia.org/wiki/Regular_expression" target="_top">Wikipedia
82
article</a> about regular expressions.
83
</p></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="command"></a>Command</h3></div></div></div><p>
84
A command can reuse one or more substitutions from the regular expression. The substitutions are represented by
85
”<span class="bold"><strong><code class="code">\<number></code></strong></span>” where <number> corresponds to the
86
sub-pattern within parentheses or 0 for the complete text.
88
For example, from the simple pattern ”<span class="bold"><strong><code class="code">bug #(123)</code></strong></span>” it is possible
89
to use ”<span class="bold"><strong><code class="code">\0</code></strong></span>” for the text “bug #123” and ”<span class="bold"><strong><code class="code">\1</code></strong></span>” for the text “123”. For the command ”<code class="code">exo-open
90
http://host/\1</code>”, the real executed command would be ”<code class="code">exo-open http://host/123</code>”.
91
</p></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="support"></a>Support</h2></div></div></div><p>
92
To report a bug or a feature request use the bug tracking system at <a class="ulink" href="http://bugzilla.xfce.org/" target="_top">http://bugzilla.xfce.org/</a>. If you have questions about the use of this software,
93
please ask on the <a class="ulink" href="http://foo-projects.org/mailman/listinfo/xfce" target="_top">Xfce mailing list</a>
94
or point your IRC client to <span class="bold"><strong>irc.freenode.net</strong></span>, join the channel <span class="bold"><strong>#xfce</strong></span> and ask for help.
95
</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="about"></a>About Clipman</h2></div></div></div><p>
96
Clipman was written by Eduard Roccatello and then maintained by Nick Schermer. Nowadays it is written by
97
Mike Massonnet (<code class="email"><<a class="email" href="mailto:mmassonnet@xfce.org">mmassonnet@xfce.org</a>></code>). Visit the <a class="ulink" href="http://goodies.xfce.org/projects/panel-plugins/xfce4-clipman-plugin" target="_top">Clipman Web
100
This documentation was written by Mike Massonnet (<code class="email"><<a class="email" href="mailto:mmassonnet@xfce.org">mmassonnet@xfce.org</a>></code>). Please send all your comments and
101
suggestions regarding this manual to <code class="email"><<a class="email" href="mailto:mmassonnet@xfce.org">mmassonnet@xfce.org</a>></code>.
104
This software is distributed under the terms of the <em class="citetitle">GNU General Public License</em> as published
105
by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
107
You should have received a copy of the <em class="citetitle">GNU General Public License</em> along with this program;
108
if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA.
109
</p></div></div></body></html>
added
removed
docs/manual/C/xfce4-clipman-plugin.html
