~ubuntu-branches/debian/sid/xfce4-clipman-plugin/sid

« back to all changes in this revision

Viewing changes to docs/manual/gl/xfce4-clipman-plugin.html

  • Committer: Bazaar Package Importer
  • Author(s): Yves-Alexis Perez, Evgeni Golov, Yves-Alexis Perez
  • Date: 2009-06-29 07:50:15 UTC
  • mfrom: (1.3.1 upstream) (7.1.1 sid)
  • Revision ID: james.westby@ubuntu.com-20090629075015-l9z65w1bezcg272x
Tags: 2:1.0.2-1
[ Evgeni Golov ]
* Fix Vcs-* fields, they were missing 'trunk' in the path.

[ Yves-Alexis Perez ]
* New upstream release.
* debian/control:
  - bump standards version to 3.8.2.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Manual de Clipman</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="Manual de Clipman"><link rel="next" href="#intro" title="Introduci�n"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" lang="gl"><div class="titlepage"><div><div><h2 class="title"><a name="xfce4-clipman-plugin"></a>Manual de Clipman</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">&lt;<a class="email" href="mailto:mmassonnet@xfce.org">mmassonnet@xfce.org</a>&gt;</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><p class="copyright">Copyright � 2009. Leandro Regueiro (leandro.regueiro@gmail.com)</p></div><div><p class="copyright">Copyright � podes atopar m�is informaci�n en http://trasno.net Se desexas colaborar connosco</p></div><div><div class="legalnotice"><a name="legalnotice"></a><p>
 
2
      This manual describes version 1.0.2 of Clipman.
 
3
    <br></br></span></div><div><p class="copyright">Copyright � 2009 Mike Massonnet</p></div><div><p class="copyright">Copyright � 2009. Leandro Regueiro (leandro.regueiro@gmail.com)</p></div><div><div class="legalnotice"><a name="legalnotice"></a><p>
4
4
        Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free
5
5
        Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no
6
6
        Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. The complete license text is
7
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>�ndice</b></p><dl><dt><span class="sect1"><a href="#intro">Introduci�n</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="gl"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="intro"></a>Introduci�n</h2></div></div></div><p>
 
8
      </p></div></div><div><p class="pubdate">April 2009</p></div></div><hr></div><div class="toc"><p><b>�ndice</b></p><dl><dt><span class="sect1"><a href="#intro">Introduci�n</a></span></dt><dd><dl><dt><span class="sect2"><a href="#anatomy-clipboard">Anatomy of a Clipboard</a></span></dt><dt><span class="sect2"><a href="#getting-started">Getting Started</a></span></dt><dt><span class="sect2"><a href="#popup-command">Popup Command</a></span></dt></dl></dd><dt><span class="sect1"><a href="#settings">Configuraci�n</a></span></dt><dd><dl><dt><span class="sect2"><a href="#general">Xeral</a></span></dt><dt><span class="sect2"><a href="#actions">Acci�ns</a></span></dt><dt><span class="sect2"><a href="#xfconf">Xfconf</a></span></dt></dl></dd><dt><span class="sect1"><a href="#action">Acci�n</a></span></dt><dd><dl><dt><span class="sect2"><a href="#regexes">Expresi�n regular</a></span></dt><dt><span class="sect2"><a href="#command">Comando</a></span></dt></dl></dd><dt><span class="sect1"><a href="#support">Support</a></span></dt><dt><span class="sect1"><a href="#about">Acerca de Clipman</a></span></dt></dl></div><div class="sect1" lang="gl"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="intro"></a>Introduci�n</h2></div></div></div><p>
9
9
      Clipman is a clipboard manager for Xfce. It keeps the clipboard contents around while it is usually lost
10
10
      when you close an application. It is able to handle text and images, and has a feature to execute actions on
11
11
      specific text selections by matching them against regular expressions.
12
 
    </p><p>
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 &#8220;Add new item&#8230;&#8221;.
16
12
    </p><div class="sect2" lang="gl"><div class="titlepage"><div><div><h3 class="title"><a name="anatomy-clipboard"></a>Anatomy of a Clipboard</h3></div></div></div><p>
17
13
        In X11 (all Unix platforms) there are by default two clipboards to exchange any data between the windows. A
18
14
        default clipboard which is modified by manual copies (for instance when you select a file and press the copy
21
17
      </p><p>
22
18
        Clipman handles only the default clipboard, but optionnaly it can also notice the selections.  When it is
23
19
        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="gl"><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="gl"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="settings"></a>Settings</h2></div></div></div><p>
 
20
      </p></div><div class="sect2" lang="gl"><div class="titlepage"><div><div><h3 class="title"><a name="getting-started"></a>Getting Started</h3></div></div></div><p>
 
21
        Clipman is used to keep in history a list of clipboard contents and to restore them. The history is
 
22
        displayed in a menu by clicking on the main icon. Within the menu it is possible to select an item to restore it,
 
23
        to clear the history and to activate or deactivate the clipboard manager.
 
24
      </p><div class="figure"><a name="id2883785"></a><p class="title"><b>Figura�1.�Men� de Clipman</b></p><div class="figure-contents"><div class="mediaobject"><img src="images/clipman-menu.png" alt="Menu displaying the history"></div></div></div><br class="figure-break"><p>
 
25
        There are two ways to run Clipman. You can select Clipman in the applications menu under the category
 
26
        Utility or type <strong class="application"><code>xfce4-clipman-plugin</code></strong> on the command-line, or you can add it into your
 
27
        panel. To add a new item in the panel right click the panel and select &#8220;Add new item&#8230;&#8221;.
 
28
      </p></div><div class="sect2" lang="gl"><div class="titlepage"><div><div><h3 class="title"><a name="popup-command"></a>Popup Command</h3></div></div></div><p>
 
29
        Clipman provides the command-line tool <strong class="application"><code>xfce4-popup-clipman</code></strong>. When called it
 
30
        popups the main menu. The command is practical for the <span class="bold"><strong>Application Shortcuts</strong></span>
 
31
        available at 
 
32
        <span class="guimenu"><strong>Xfce Menu</strong></span>+<span class="guimenu"><strong>Settings</strong></span>+<span class="guimenu"><strong>Keyboard</strong></span>.
 
33
      </p></div></div><div class="sect1" lang="gl"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="settings"></a>Configuraci�n</h2></div></div></div><p>
29
34
      The settings dialog is available under the &#8220;Properties&#8221; item in the right click context menu on the main icon. It
30
35
      allows to tweak the history and to edit actions.
31
 
    </p><div class="sect2" lang="gl"><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="id2515444"></a><p class="title"><b>T�boaT�boa�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">Opci�ns</th><th align="left">Descrici�n</th></tr></thead><tbody xmlns=""><tr><td align="left">Gardar ao sa�r</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="gl"><div class="titlepage"><div><div><h3 class="title"><a name="actions"></a>Actions</h3></div></div></div><p>
 
36
    </p><div class="sect2" lang="gl"><div class="titlepage"><div><div><h3 class="title"><a name="general"></a>Xeral</h3></div></div></div><p>
 
37
        The following table describes the available options:
 
38
      </p><div class="table"><a name="id2844985"></a><p class="title"><b>T�boaT�boa�1.�General 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="General options in the Settings dialog" border="1"><colgroup><col xmlns=""><col xmlns=""></colgroup><thead xmlns=""><tr><th align="left">Opci�ns</th><th align="left">Descrici�n</th></tr></thead><tbody xmlns=""><tr><td align="left">Add selections</td><td align="left">Sync the primary clipboard with the default clipboard in a way that it is possible to paste what gets
 
39
        selected</td></tr><tr><td align="left">Exclude from history</td><td align="left">Prevents the primary clipboard from being inserted in the history</td></tr><tr><td align="left">Gardar ao sa�r</td><td align="left">Keeps the history at every new session</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">Tama�o do historial</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="figure"><a name="id2845070"></a><p class="title"><b>Figura�2.�Configuraci�n de Clipman</b></p><div class="figure-contents"><div class="mediaobject"><img src="images/clipman-settings-general.png" alt="Settings dialog with the General tab"></div></div></div><br class="figure-break"></div><div class="sect2" lang="gl"><div class="titlepage"><div><div><h3 class="title"><a name="actions"></a>Acci�ns</h3></div></div></div><p>
34
40
        An action is a pair of an action name and a regular expression. Each action can have one or more commands. The
35
41
        support of actions is optional and can be enabled or disabled through the &#8220;Enable actions&#8221; option.
36
42
      </p><p>
38
44
        the action, and to remove an action select an action and click the Delete icon. By adding or editing an action a
39
45
        new dialog is opened.
40
46
      </p><p>
41
 
        To learn more about actions go to <a class="xref" href="#action" title="Action">��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="gl"><div class="titlepage"><div><div><h3 class="title"><a name="xfconf"></a>Xfconf</h3></div></div></div><p>
 
47
        To learn more about actions go to <a class="xref" href="#action" title="Acci�n">��Acci�n��</a>.
 
48
      </p><div class="figure"><a name="id2845138"></a><p class="title"><b>Figura�3.�Configuraci�n de Clipman</b></p><div class="figure-contents"><div class="mediaobject"><img src="images/clipman-settings-actions.png" alt="Settings dialog with the Actions tab"></div></div></div><br class="figure-break"></div><div class="sect2" lang="gl"><div class="titlepage"><div><div><h3 class="title"><a name="xfconf"></a>Xfconf</h3></div></div></div><p>
43
49
        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
 
50
        to change the settings with the tool <strong class="application"><code>xfconf-query</code></strong>. The following table lists all the
45
51
        properties with their possible values:
46
 
      </p><div class="table"><a name="id2515020"></a><p class="title"><b>T�boaT�boa�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">Propiedade</th><th align="left">Tipo</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>
 
52
      </p><div class="table"><a name="id2846236"></a><p class="title"><b>T�boaT�boa�2.�Propiedades de Xfconf</b></p><div class="table-contents"><table xmlns="http://www.w3.org/TR/xhtml1/transitional" bgcolor="#F8F9FD" cellspacing="0" cellpadding="4" summary="Propiedades de Xfconf" border="1"><colgroup><col xmlns=""><col xmlns=""><col xmlns=""><col xmlns=""></colgroup><thead xmlns=""><tr><th align="left">Propiedade</th><th align="left">Tipo</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 sync the primary clipboard with the default clipboard</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/history-ignore-primary-clipboard</td><td align="left">bool</td><td align="left">false</td><td align="left">true to exclude the primary clipboard from the history</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
53
        To change a setting type the command-line:
48
 
      </p><code class="literal">xfconf-query -c xfce4-panel -p &lt;property&gt; -s &lt;value&gt;</code></div></div><div class="sect1" lang="gl"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="action"></a>Action</h2></div></div></div><p>
 
54
      </p><code class="literal">xfconf-query -c xfce4-panel -p &lt;property&gt; -s &lt;value&gt;</code></div></div><div class="sect1" lang="gl"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="action"></a>Acci�n</h2></div></div></div><p>
49
55
      An action has a human readable name that describes the pattern it is going to match. The matches are made against
50
56
      text from the selections and the pattern is a regular expression. An action must have at least one command which
51
57
      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="gl"><div class="titlepage"><div><div><h3 class="title"><a name="regexes"></a>Regular Expression</h3></div></div></div><p>
 
58
    </p><div class="figure"><a name="id2844487"></a><p class="title"><b>Figura�4.�Action Dialog</b></p><div class="figure-contents"><div class="mediaobject"><img src="images/clipman-action-dialog.png" alt="Action edit dialog"></div></div></div><br class="figure-break"><div class="sect2" lang="gl"><div class="titlepage"><div><div><h3 class="title"><a name="regexes"></a>Expresi�n regular</h3></div></div></div><p>
53
59
        Basic special characters: "<span class="bold"><strong><code class="code">.?+*(|)[]\</code></strong></span>".
54
60
      </p><div class="itemizedlist"><ul type="disc"><li>
55
61
          &#8221;<span class="bold"><strong><code class="code">.</code></strong></span>&#8221;: represents a single character.
80
86
          </li></ul></div></div><div class="sect3" lang="gl"><div class="titlepage"><div><div><h4 class="title"><a name="regexes-external-ressource"></a>External Ressource</h4></div></div></div><p>
81
87
          Have a look at the <a class="ulink" href="http://en.wikipedia.org/wiki/Regular_expression" target="_top">Wikipedia
82
88
          article</a> about regular expressions.
83
 
        </p></div></div><div class="sect2" lang="gl"><div class="titlepage"><div><div><h3 class="title"><a name="command"></a>Command</h3></div></div></div><p>
 
89
        </p></div></div><div class="sect2" lang="gl"><div class="titlepage"><div><div><h3 class="title"><a name="command"></a>Comando</h3></div></div></div><p>
84
90
        A command can reuse one or more substitutions from the regular expression. The substitutions are represented by
85
91
        &#8221;<span class="bold"><strong><code class="code">\&lt;number&gt;</code></strong></span>&#8221; where &lt;number&gt; corresponds to the
86
92
        sub-pattern within parentheses or 0 for the complete text.
92
98
      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
99
      please ask on the <a class="ulink" href="http://foo-projects.org/mailman/listinfo/xfce" target="_top">Xfce mailing list</a>
94
100
      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="gl"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="about"></a>About Clipman</h2></div></div></div><p>
 
101
    </p></div><div class="sect1" lang="gl"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="about"></a>Acerca de Clipman</h2></div></div></div><p>
96
102
      Clipman was written by Eduard Roccatello and then maintained by Nick Schermer. Nowadays it is written by
97
103
      Mike Massonnet (<code class="email">&lt;<a class="email" href="mailto:mmassonnet@xfce.org">mmassonnet@xfce.org</a>&gt;</code>). Visit the <a class="ulink" href="http://goodies.xfce.org/projects/panel-plugins/xfce4-clipman-plugin" target="_top">Clipman Web
98
104
      site</a>.
103
109
    </p><p>
104
110
      This software is distributed under the terms of the <em class="citetitle">GNU General Public License</em> as published
105
111
      by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
106
 
    </p><p>
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>
 
112
    </p><p>Debeu recibir unha copia da Licenza P�blica Xeral de GNU xunta con este programa; en caso contrario, escriba � Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA </p></div></div></body></html>