2a3cb90266d536069f0547aa7b5e1f3c91f3b453
[geeqie.git] / doc / docbook / GuideImageManagementPlugins.xml
1 <?xml version="1.0" encoding="utf-8"?>\r
2 <chapter id="GuideImageManagementPlugins">\r
3   <title>Plugins</title>\r
4   <para>Geeqie provides the facility to execute external commands - any external command may be called via this facility.</para>\r
5   <para>Actions may be performed on a single file, or on a set of selected files.</para>\r
6   <para>Plugins can do anything from running simple operations like symlink to activating fully featured programs like Gimp. Nor does the action have to be performed on files - you may, for instance, configure a plugin to download images from your digital camera.</para>\r
7   <para>\r
8     To perform these actions, Geeqie uses standard\r
9     <link linkend="GuideReferenceStandards">desktop</link>\r
10     files.\r
11   </para>\r
12   <para>\r
13     It is not necessary to understand the details of desktop file specifications because the\r
14     <link linkend="GuidePluginsConfig" endterm="titleGuidePluginsConfig" />\r
15     dialogue presents you with an easy-to-use template. This dialogue is accessed via\r
16     <menuchoice>\r
17       <guimenu>Edit</guimenu>\r
18       <guimenuitem>Configure Plugins</guimenuitem>\r
19     </menuchoice>\r
20     .\r
21   </para>\r
22   <para>\r
23     Plugins will appear in the menu\r
24     <menuchoice>\r
25       <guimenu>Plugins</guimenu>\r
26     </menuchoice>\r
27     , unless specified otherwise in the desktop file.\r
28   </para>\r
29   <para />\r
30   <para>Commands that are set to display their output in a window will show a dialogue when the command is executed.</para>\r
31   <para>The Result dialogue will display the command's text output. If the plugin command will result in multiple runs of the same command for each file, you can use the Stop button to stop Geeqie from executing the command for remaining files.</para>\r
32   <para>\r
33     Once all commands have completed, or if the Stop button was pressed and the pending command has completed, you can use the Close button, or press\r
34     <code>Escape</code>\r
35     , to close the Result dialogue. The Result dialogue can not be closed while a command is still running.\r
36   </para>\r
37 </chapter>\r