Mercurial > hg > forks > geeqie

diff web/help/GuidePluginsConfig.html @ 2658:b3f34f91ac4d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update web help file and other docs Update on-line help files Update man page Update README, HACKING, CODING docs Remove BUGS file - it does not seem to be useful
author Colin Clark <colin.clark@cclark.uk>
date Sat, 04 Nov 2017 11:29:31 +0000
parents
children 1656d2341e2f
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/web/help/GuidePluginsConfig.html	Sat Nov 04 11:29:31 2017 +0000
@@ -0,0 +1,716 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Plugins Configuration</title>
+<link rel="previous" href="GuideOptionsLayout.html" title="Window Layout">
+<link rel="next" href="GuideOptionsHidden.html" title="Legacy Configuration File Options">
+<link rel="top" href="GuideIndex.html" title="The Geeqie User Manual">
+<style type="text/css">
+
+html { height: 100%; }
+body {
+  margin: 0px; padding: 12px;
+  background-color: #f9f9f6;
+  min-height: 100%;
+  direction: ltr;
+}
+div, p, pre, blockquote { margin: 0; padding: 0; }
+p img { vertical-align: middle; }
+sub { font-size: 0.83em; }
+sub sub { font-size: 1em; }
+sup { font-size: 0.83em; }
+sup sup { font-size: 1em; }
+table { border-collapse: collapse; }
+table.table-pgwide { width: 100%; }
+td { vertical-align: top; }
+td { padding: 0.2em 0.83em 0.2em 0.83em; }
+th { padding: 0 0.83em 0 0.83em; }
+tr.tr-shade {
+  background-color: #f9f9f6;
+}
+td.td-colsep { border-right: solid 1px; }
+td.td-rowsep { border-bottom: solid 1px; }
+thead { border-top: solid 2px; border-bottom: solid 2px; }
+tfoot { border-top: solid 2px; border-bottom: solid 2px; }
+div.body {
+  padding: 1em;
+  max-width: 60em;
+  background-color: #ffffff;
+  border: solid 1px #e0e0df;
+}
+div.body-sidebar {
+  margin-right: 13em;
+}
+div.division div.division { margin-top: 1.72em; }
+div.division div.division div.division { margin-top: 1.44em; }
+div.header {
+  margin: 0;
+  color: #3f3f3f;
+  border-bottom: solid 1px #e0e0df;
+}
+h1, h2, h3, h4, h5, h6, h7 {
+  margin: 0; padding: 0;
+  color: #3f3f3f;
+}
+h1.title { font-size: 1.72em; }
+h2.title { font-size: 1.44em; }
+h3.title { font-size: 1.2em; }
+h4.title, h5.title, h6.title, h7.title { font-size: 1em; }
+.block { margin-top: 1em; }
+.block .block-first { margin-top: 0; }
+.block-indent {
+  margin-left left: 1.72em;
+  margin-: 1em;
+}
+.block-indent .block-indent { margin-left: 0em; margin-right: 0em; }
+td .block-indent  { margin-left: 0em; margin-right: 0em; }
+dd .block-indent  { margin-left: 0em; margin-right: 0em; }
+.block-verbatim { white-space: pre; }
+div.title {
+  margin-bottom: 0.2em;
+  font-weight: bold;
+  color: #3f3f3f;
+}
+div.title-formal { padding-left: 0.2em; padding-right: 0.2em; }
+div.title-formal .label { font-weight: normal; }
+a {
+  color: #1f609f;
+  text-decoration: none;
+}
+a:hover { text-decoration: underline; }
+a:visited { color: #9f1f6f; }
+ul, ol, dl { margin: 0; padding: 0; }
+li {
+  margin-top: 1em;
+  margin-left: 2.4em;
+  padding: 0;
+}
+li.li-first { margin-top: 0; }
+dt { margin: 1em 0 0 0; }
+dt.dt-first { margin: 0; }
+dd {
+  margin-left: 1.72em;
+  margin-top: 0.5em;
+}
+dl.dl-compact dt { margin-top: 0; }
+dl.dl-compact dd { margin-top: 0; margin-bottom: 0; }
+
+
+ul.linktrail {
+  display: block;
+  margin: 0.2em 0 0 0;
+  text-align: right;
+}
+li.linktrail { display: inline; margin: 0; padding: 0; }
+
+li.linktrail::before {
+  content: '  /  ';
+  color: #3f3f3f;
+}
+
+li.linktrail-first::before, li.linktrail-only::before { content: ''; }
+
+
+div.navbar {
+  padding: 0.5em 1em 0.5em 1em;
+  max-width: 60em;
+  background-color: #ffffff;
+  border: solid 1px #e0e0df;
+}
+div.navbar-top { margin-bottom: 1em; }
+div.navbar-bottom { margin-top: 1em; clear: both; }
+div.navbar img { border: 0; vertical-align: -0.4em; }
+table.navbar { width: 100%; margin: 0; border: none; }
+table.navbar td { padding: 0; border: none; }
+td.navbar-next {
+  text-align: right;
+}
+a.navbar-prev::before {
+  
+  content: '◀  ';
+  color: #3f3f3f;
+}
+a.navbar-next::after {
+  
+  content: '  ▶';
+  color: #3f3f3f;
+}
+
+
+div.sidebar {
+  float: right;
+  padding: 0; margin: 0; width: 12em;
+}
+div.sidenav {
+  padding: 0.5em 1em 0 1em;
+  background-color: #ffffff;
+  border: solid 1px #e0e0df;
+}
+div.sidenav div.autotoc {
+  background-color: #ffffff;
+  border: none; padding: 0; margin: 0;
+}
+div.sidenav div.autotoc div.autotoc { margin-top: 0.5em; }
+div.sidenav div.autotoc li { margin-bottom: 0.5em; }
+div.sidenav div.autotoc div.autotoc div.autotoc {
+  margin-left: 1em;
+  margin-top: 0;
+}
+div.sidenav div.autotoc div.autotoc div.autotoc li { margin-bottom: 0; }
+
+
+div.autotoc {
+  
+  display: table;
+  margin-top: 1em;
+  margin-left: 1.72em;
+  padding: 0.5em 1em 0.5em 1em;
+  background-color: #f0f9ff;
+  border: solid 1px #c0c9ff;
+}
+div.autotoc ul { margin: 0; padding: 0; }
+div.autotoc li { list-style-type: none; margin: 0; }
+div.autotoc div.autotoc-title { margin-bottom: 0.5em; }
+div.autotoc div.autotoc { border: none; padding: 0; margin-top: 0; margin-bottom: 0.5em; }
+div.autotoc div.autotoc div.autotoc { margin-bottom: 0; }
+
+
+span.bibliolabel {
+  color: #3f3f3f;
+}
+
+
+div.admonition {
+  padding: 0.5em 6px 0.5em 6px;
+  border: solid 1px #e0e0df;
+  background-color: #fffff0;
+}
+div.caution-inner, div.important-inner, div.note-inner, div.tip-inner, div.warning-inner {
+  padding-left: 60px;
+  background-position: left top;
+  background-repeat: no-repeat;
+  min-height: 48px;
+}
+div.caution-inner { background-image: url("admon-caution.png"); }
+div.important-inner { background-image: url("admon-important.png"); }
+div.note-inner { background-image: url("admon-note.png"); }
+div.note-bug div.note-inner { background-image: url("admon-bug.png"); }
+div.tip-inner { background-image: url("admon-tip.png"); }
+div.warning-inner { background-image: url("admon-warning.png"); }
+div.blockquote {
+  
+  background-image: url('watermark-blockquote-201C.png');
+  background-repeat: no-repeat;
+  background-position: top left;
+  padding: 0.5em;
+  padding-left: 4em;
+}
+div.attribution {
+  margin-top: 0.5em;
+  color: #3f3f3f;
+}
+div.attribution::before {
+  
+  content: '― ';
+}
+div.epigraph {
+  text-align: right;
+  margin-left: 20%;
+  margin-right: 0;
+  color: #3f3f3f;
+}
+div.figure, div.informalfigure {
+  
+  display: table;
+  padding: 0.5em;
+  background-color: #f9f9f6;
+  border: solid 1px #e0e0df;
+}
+div.figure-inner, div.informalfigure-inner {
+  padding: 0.5em;
+  background-color: #ffffff;
+  border: solid 1px #e0e0df;
+}
+div.caption { margin-top: 0.5em; }
+div.programlisting {
+  padding: 0.5em;
+  
+  background-color: #f9f9f6;
+  border: solid 1px #e0e0df;
+}
+div.screen {
+  padding: 0.5em;
+  
+  background-color: #f9f9f6;
+  border: solid 1px #e0e0df;
+}
+div.screen .prompt {
+  color: #3f3f3f;
+}
+div.screen .userinput {
+  font-weight: bold;
+  color: #3f3f3f;
+}
+div.programlisting .userinput {
+  font-weight: bold;
+  color: #3f3f3f;
+}
+pre.linenumbering {
+  color: #3f3f3f;
+  margin: 0;
+  padding-right: 1em;
+  float: left;
+  text-align: right;
+}
+
+
+
+dl.index dt { margin-top: 0; }
+dl.index dd { margin-top: 0; margin-bottom: 0; }
+dl.indexdiv dt { margin-top: 0; }
+dl.indexdiv dd { margin-top: 0; margin-bottom: 0; }
+dl.setindex dt { margin-top: 0; }
+dl.setindex dd { margin-top: 0; margin-bottom: 0; }
+div.list div.title-formal span.title {
+  border-bottom: solid 1px #e0e0df;
+}
+div.simplelist {
+  margin-left: 1.72em;
+}
+div.simplelist table { margin-left: 0; border: none; }
+div.simplelist td {
+  padding: 0.5em;
+  border-left: solid 1px #e0e0df;
+}
+div.simplelist td.td-first {
+  padding-left: 0;
+  border-left: 0;
+}
+div.synopsis {
+  padding: 0.5em;
+  
+  background-color: #f9f9f6;
+  border-top: solid 2px #c0c9ff;
+  border-bottom: solid 2px #c0c9ff;
+}
+div.synopsis div.synopsis {
+  padding: 0;
+  border: none;
+}
+div.synopsis div.block { margin-top: 0.2em; }
+div.synopsis div.block-first { margin-top: 0; }
+div.cmdsynopsis { font-family: monospace; }
+
+span.accel { text-decoration: underline; }
+span.acronym { font-family: sans-serif; }
+span.application { font-style: italic; }
+span.classname, span.exceptionname, span.interfacename { font-family: monospace; }
+span.code {
+  font-family: monospace;
+  border: solid 1px #e0e0df;
+  padding-left: 0.2em;
+  padding-right: 0.2em;
+}
+pre span.code { border: none; padding: 0; }
+span.command {
+  font-family: monospace;
+  border: solid 1px #e0e0df;
+  padding-left: 0.2em;
+  padding-right: 0.2em;
+}
+pre span.command { border: none; padding: 0; }
+span.computeroutput { font-family: monospace; }
+
+span.constant { font-family: monospace; }
+span.database { font-family: monospace; }
+span.email { font-family: monospace; }
+span.emphasis { font-style: italic; }
+span.emphasis-bold { font-style: normal; font-weight: bold; }
+span.envar { font-family: monospace; }
+
+span.filename { font-family: monospace; }
+span.firstterm { font-style: italic; }
+span.foreignphrase { font-style: italic; }
+span.function { font-family: monospace; }
+
+dt.glossterm span.glossterm { font-style: normal; }
+
+
+span.glossterm { font-style: italic; }
+
+span.guibutton, span.guilabel, span.guimenu, span.guimenuitem, span.guisubmenu, span.interface {
+  font-weight: bold;
+  color: #3f3f3f;
+}
+span.keycap {
+  font-weight: bold;
+  color: #3f3f3f;
+}
+span.lineannotation { font-style: italic; }
+span.literal { font-family: monospace; }
+span.markup  { font-family: monospace; }
+span.medialabel { font-style: italic; }
+span.methodname { font-family: monospace; }
+span.ooclass, span.ooexception, span.oointerface { font-family: monospace; }
+span.option { font-family: monospace; }
+span.parameter { font-family: monospace; }
+span.paramdef span.parameter { font-style: italic; }
+span.prompt { font-family: monospace; }
+span.property { font-family: monospace; }
+span.replaceable  { font-style: italic; }
+span.returnvalue { font-family: monospace; }
+span.sgmltag { font-family: monospace; }
+span.structfield, span.structname { font-family: monospace; }
+span.symbol { font-family: monospace; }
+span.systemitem { font-family: monospace; }
+span.token { font-family: monospace; }
+span.type { font-family: monospace; }
+span.uri { font-family: monospace; }
+span.userinput { font-family: monospace; }
+span.varname { font-family: monospace; }
+span.wordasword { font-style: italic; }
+
+
+
+div.footnotes { font-style: italic; font-size: 0.8em; }
+div.footnote { margin-top: 1.44em; }
+span.footnote-number { display: inline; padding-right: 0.83em; }
+span.footnote-number + p { display: inline; }
+a.footnote { text-decoration: none; font-size: 0.8em; }
+a.footnote-ref { text-decoration: none; }
+
+span.co {
+  margin-left: 0.2em; margin-right: 0.2em;
+  padding-left: 0.4em; padding-right: 0.4em;
+  border: solid 1px #000000;
+  -moz-border-radius: 8px;
+  background-color: #000000;
+  color: #FFFFFF;
+  font-size: 8px;
+}
+span.co:hover {
+  border-color: #333333;
+  background-color: #333333;
+  color: #FFFFFF;
+}
+span.co a { text-decoration: none; }
+span.co a:hover { text-decoration: none; }
+
+dt.question { margin-left: 0em; }
+dt.question div.label { float: left; }
+dd + dt.question { margin-top: 1em; }
+dd.answer {
+  margin-top: 1em;
+  margin-left: 2em;
+  margin-right: 1em;
+}
+dd.answer div.label { float: left; }
+</style>
+</head>
+<body>
+<div class="navbar navbar-top"><table class="navbar"><tr>
+<td class="navbar-prev"><a class="navbar-prev" href="GuideOptionsLayout.html" title="Window Layout">Window Layout</a></td>
+<td class="navbar-next"><a class="navbar-next" href="GuideOptionsHidden.html" title="Legacy Configuration File Options">Legacy Configuration File Options</a></td>
+</tr></table></div>
+<div class="sidebar"><div class="sidenav"><div class="autotoc"><ul>
+<li><a href="GuideIndex-info.html" title="About This Document">About This Document</a></li>
+<li>
+<a class="xref" href="GuideIndex.html" title="The Geeqie User Manual">The Geeqie User Manual</a><div class="autotoc"><ul>
+<li><a class="xref" href="GuideIntroduction.html" title="Introduction">Introduction</a></li>
+<li><a class="xref" href="GuideMainWindow.html" title="Main Window">Main Window</a></li>
+<li><a class="xref" href="GuideSidebars.html" title="Sidebars">Sidebars</a></li>
+<li><a class="xref" href="GuideOtherWindows.html" title="Stand-alone Windows">Stand-alone Windows</a></li>
+<li><a class="xref" href="GuideImageSearch.html" title="Search and Select">Search and Select</a></li>
+<li><a class="xref" href="GuideImageManagementPlugins.html" title="Plugins">Plugins</a></li>
+<li><a class="xref" href="GuideImageManagement.html" title="File Management">File Management</a></li>
+<li><a class="xref" href="GuideColorManagement.html" title="Color Management">Color Management</a></li>
+<li><a class="xref" href="GuideImagePresentation.html" title="Image Presentation">Image Presentation</a></li>
+<li><a class="xref" href="GuidePrinting.html" title="Printing">Printing</a></li>
+<li><a class="xref" href="GuideOptionsMain.html" title="Preferences">Preferences</a></li>
+<li>
+<a class="xref" href="GuideOptionsAdditional.html" title="Additional Preferences">Additional Preferences</a><div class="autotoc"><ul>
+<li><a class="xref" href="GuideOptionsLayout.html" title="Window Layout">Window Layout</a></li>
+<li>Plugins Configuration</li>
+<li><a class="xref" href="GuideOptionsHidden.html" title="Legacy Configuration File Options">Legacy Configuration File Options</a></li>
+</ul></div>
+</li>
+<li><a class="xref" href="GuideReference.html" title="Reference">Reference</a></li>
+<li><a class="xref" href="GuideFaq.html" title="Frequently Asked Questions">Frequently Asked Questions</a></li>
+<li><a class="xref" href="GuideLicence.html" title="Licence">Licence</a></li>
+<li><a class="xref" href="GuideCredits.html" title="Credits">Credits</a></li>
+<li><a class="xref" href="GuideGnuFdl.html" title="GNU Free Documentation License">GNU Free Documentation License</a></li>
+</ul></div>
+</li>
+</ul></div></div></div>
+<div class="body body-sidebar"><div class="division section">
+<a name="GuidePluginsConfig"></a><div class="header"><h1 class="section title"><span class="title"><a name="titleGuidePluginsConfig"></a>Plugins Configuration</span></h1></div>
+<ul class="linktrail">
+<li class="linktrail linktrail-first"><a class="linktrail" href="GuideIndex.html" title="The Geeqie User Manual">The Geeqie User Manual</a></li>
+<li class="linktrail linktrail-last"><a class="linktrail" href="GuideOptionsAdditional.html" title="Additional Preferences">Additional Preferences</a></li>
+</ul>
+<p class="para block block-first"></p>
+<div class="autotoc"><ul>
+<li>
+<span class="label">12.2.1. </span><a class="xref" href="GuidePluginsConfig.html#PluginsConfigurationDialog" title="Plugins Configuration Dialog">Plugins Configuration Dialog</a>
+</li>
+<li>
+<span class="label">12.2.2. </span><a class="xref" href="GuidePluginsConfig.html#Addingnewplugin" title="Adding new plugin">Adding new plugin</a>
+</li>
+<li>
+<span class="label">12.2.3. </span><a class="xref" href="GuidePluginsConfig.html#Modifyinganexistingplugin" title="Modifying an existing plugin">Modifying an existing plugin</a>
+</li>
+<li>
+<span class="label">12.2.4. </span><a class="xref" href="GuidePluginsConfig.html#Deletingaplugin" title="Deleting a plugin">Deleting a plugin</a>
+</li>
+<li>
+<span class="label">12.2.5. </span><a class="xref" href="GuidePluginsConfig.html#Specialplugins" title="Special plugins">Special plugins</a>
+</li>
+<li>
+<span class="label">12.2.6. </span><a class="xref" href="GuidePluginsConfig.html#Geeqieextensions" title="Geeqie desktop file keys">Geeqie desktop file keys</a>
+</li>
+</ul></div>
+<div class="division section">
+<a name="PluginsConfigurationDialog"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">12.2.1. </span>Plugins Configuration Dialog</span></h2></div>
+<p class="para block block-first">
+      This dialog allows user to add new plugins or modify the system ones. It is available in the menu
+      <span class="menuchoice"><span class="guimenu">Edit</span> ▸ <span class="guimenuitem">Configure Plugins</span></span>
+      .
+    </p>
+<p class="para block">
+      The Plugins dialog shows list of all relevant plugins i.e. all installed desktop files that are designated either:
+      <div class="block list itemizedlist"><ul class="itemizedlist" compact>
+<li class="li-first">
+          <span class="literal" dir="ltr">Categories=Graphics</span>
+        </li>
+<li>
+          <span class="literal" dir="ltr">Categories=X-Geeqie</span>
+        </li>
+</ul></div>
+      <p class="para block"></p>
+      The list has the following columns:
+    </p>
+<div class="block list variablelist"><dl class="variablelist">
+<dt class="term dt-first">
+          <span class="guilabel">Name</span>
+        </dt>
+<dd>
+          <p class="para block block-first">Plugin name as specified in desktop file, and is the name displayed in menus.</p>
+        </dd>
+<dt class="term">
+          <span class="guilabel">Hidden</span>
+        </dt>
+<dd>
+          A plugin can be
+          <span class="emphasis">Hidden</span>
+          for one of these reasons:
+          <div class="block list itemizedlist"><ul class="itemizedlist">
+<li class="li-first">
+              the desktop file contains
+              <span class="literal" dir="ltr">Hidden=TRUE</span>
+              or
+              <span class="literal" dir="ltr">NoDisplay=TRUE</span>
+            </li>
+<li>
+              <span class="literal" dir="ltr">TryExec</span>
+              binary was not found
+            </li>
+<li>
+              <span class="literal" dir="ltr">MimeType</span>
+              list does not contain images
+            </li>
+<li>
+              <span class="literal" dir="ltr">MimeType</span>
+              list is empty and
+              <span class="literal" dir="ltr">Categories</span>
+              does not contain
+              <span class="literal" dir="ltr">X-Geeqie</span>
+            </li>
+</ul></div>
+        </dd>
+</dl></div>
+<div class="block list variablelist"><dl class="variablelist">
+<dt class="term dt-first">
+          <span class="guilabel">Desktop file</span>
+        </dt>
+<dd>
+          Name of the desktop file, used as an identifier in
+          <a class="link" href="GuideOptionsKeyboard.html" title="Keyboard Options">Keyboard Options</a>
+          .
+        </dd>
+<dt class="term">
+          <span class="guilabel">Path</span>
+        </dt>
+<dd>Full path to the desktop file. Desktop files in user directories override the system ones with the same name.</dd>
+</dl></div>
+</div>
+<div class="division section">
+<a name="Addingnewplugin"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">12.2.2. </span>Adding new plugin</span></h2></div>
+<p class="para block block-first">
+      <span class="code" dir="ltr">
+        <span class="guibutton">
+          <span class="guiicon">
+            <span class="inlinegraphic"><img src="document-new.png"></span>
+          </span>
+          New
+        </span>
+      </span>
+      opens a text editor with a desktop file template. You must amend the line
+      <div dir="ltr" class=" block programlisting block-indent"><pre class="programlisting">Exec=command %f</pre></div>
+      to contain the command you wish to execute. If it is more than a single command, you must create a script file and call that. If the location of the script file is not in your $PATH environment variable, you must include the full pathname.
+    </p>
+<p class="para block"></p>
+</div>
+<div class="division section">
+<a name="Modifyinganexistingplugin"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">12.2.3. </span>Modifying an existing plugin</span></h2></div>
+<p class="para block block-first">
+      <span class="code" dir="ltr">
+        <span class="guibutton">
+          <span class="guiicon">
+            <span class="inlinegraphic"><img src="gtk-edit.png"></span>
+          </span>
+          Edit
+        </span>
+      </span>
+      opens a text editor with existing desktop file. For desktop files that are not writable by user, it allows saving to a Geeqie specific directory, where it overrides the system file (but only for Geeqie).
+    </p>
+</div>
+<div class="division section">
+<a name="Deletingaplugin"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">12.2.4. </span>Deleting a plugin</span></h2></div>
+<p class="para block block-first">
+      <span class="code" dir="ltr">
+        <span class="guibutton">
+          <span class="guiicon">
+            <span class="inlinegraphic"><img src="edit-delete.png"></span>
+          </span>
+          Delete
+        </span>
+      </span>
+      can delete user writable desktop files. System desktop files can't be deleted directly, but it is possible to edit them and set
+      <span class="literal" dir="ltr">Hidden=TRUE</span>
+      , see above.
+    </p>
+</div>
+<div class="division section">
+<a name="Specialplugins"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">12.2.5. </span>Special plugins</span></h2></div>
+<p class="para block block-first">A desktop file with one of the following names has a special function. It will replace the corresponding internal command.</p>
+<p class="para block">
+      <div dir="ltr" class=" block programlisting block-indent block-first"><pre class="programlisting">        geeqie-copy-command.desktop
+        geeqie-move-command.desktop
+        geeqie-rename-command.desktop
+        geeqie-delete-command.desktop
+        geeqie-folder-command.desktop
+      </pre></div>
+    </p>
+<p class="para block">This can be used for example for a custom trash command or for manipulation of files under version control.</p>
+</div>
+<div class="division section">
+<a name="Geeqieextensions"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">12.2.6. </span>Geeqie desktop file keys</span></h2></div>
+<p class="para block block-first">
+      A desktop file for use only by Geeqie should have the following entries:
+      <div dir="ltr" class=" block programlisting block-indent block-first"><pre class="programlisting">        Categories=X-Geeqie;
+        OnlyShowIn=X-Geeqie;
+      </pre></div>
+    </p>
+<p class="para block">
+      A menu path where the plugin will appear, instead of in the default
+      <span class="menuchoice"><span class="guimenu">Plugins</span></span>
+      , can be set by including:
+      <div dir="ltr" class=" block programlisting block-indent"><pre class="programlisting">X-Geeqie-Menu-Path=&lt;FileMenuPath&gt;</pre></div>
+    </p>
+<p class="para block">
+      Possible vales for
+      <span class="emphasis">FileMenuPath</span>
+      are:
+      <div dir="ltr" class=" block programlisting block-indent"><pre class="programlisting">        FileMenu
+        FileMenu/OpenSection
+        FileMenu/SearchSection
+        FileMenu/PrintSection
+        FileMenu/FileOpsSection
+        FileMenu/QuitSection
+        GoMenu
+        SelectMenu
+        SelectMenu/SelectSection
+        SelectMenu/ClipboardSection
+        SelectMenu/MarksSection
+        EditMenu/EditMenu
+        EditMenu/EditSection
+        EditMenu/OrientationMenu
+        EditMenu/RatingMenu
+        EditMenu/PropertiesSection
+        EditMenu/PreferencesSection
+        PluginsMenu
+        ViewMenu
+        ViewMenu/WindowSection
+        ViewMenu/FileDirMenu
+        ViewMenu/FileDirMenu/FolderSection
+        ViewMenu/FileDirMenu/ListSection
+        ViewMenu/DirSection
+        ViewMenu/ZoomMenu
+        ViewMenu/ZoomMenu/ConnectZoomMenu
+        ViewMenu/SplitMenu
+        ViewMenu/StereoMenu
+        ViewMenu/ColorMenu
+        ViewMenu/OverlayMenu
+        ViewMenu/ViewSection
+        ViewMenu/ToolsSection
+        ViewMenu/SlideShowSection
+        HelpMenu
+        HelpMenu/HelpSection
+      </pre></div>
+    </p>
+<p class="para block">
+      If you want a plugin to use a user-definable path, the following entry must be made in the desktop file:
+      <div dir="ltr" class=" block programlisting block-indent block-first"><pre class="programlisting">X-Geeqie-Filter=true</pre></div>
+    </p>
+<p class="para block">
+      Desktop files containing this entry will be displayed in the Folder action list of the
+      <a class="link" href="GuideSidebarsSortManager.html#CopyMoveandLink" title="Copy, Move, Link and Desktop actions">Sort Manager Sidebar</a>
+      . The path of the bookmark clicked will be used by the desktop file.
+      <p class="para block"></p>
+      If the desktop file is called from the menu, when the plugin is executed you are presented with a dialogue which enables a path to be selected. The path selected, appended by the filename currently being processed, is made available to the shell script either as an environment variable or via a call to geeqie --remote. The following code demonstrates the use of both methods:
+      <div dir="ltr" class=" block programlisting block-indent"><pre class="programlisting">        for file in "$@"
+        do
+        destination=$(geeqie --remote --get-destination:"$file")
+        
+        echo "$destination"
+        echo $GEEQIE_DESTINATION
+        done
+      </pre></div>
+    </p>
+<p class="para block">
+      If you want to run a plugin in full-screen mode and wish full-screen to be maintained, include the following entry in the desktop file:
+      <div dir="ltr" class=" block programlisting block-indent block-first"><pre class="programlisting">X-Geeqie-Keep-Fullscreen=true</pre></div>
+    </p>
+<p class="para block">
+      Any terminal output from the plugin command can be displayed with the following command:
+      <div dir="ltr" class=" block programlisting block-indent block-first"><pre class="programlisting">X-Geeqie-Verbose=true</pre></div>
+    </p>
+<p class="para block">
+      The plugin can be restricted to run on only certain file types, for example:
+      <div dir="ltr" class=" block programlisting block-indent block-first"><pre class="programlisting">X-Geeqie-File-Extensions=.jpg; .cr2</pre></div>
+      The entries are case insensitive.
+    </p>
+<p class="para block">
+      <div dir="ltr" class=" block programlisting block-indent block-first"><pre class="programlisting">X-Geeqie-Keep-Verbose-Multi=</pre></div>
+      TBD
+    </p>
+<p class="para block">
+      The key or key combination to execute this function can be set with:
+      <div dir="ltr" class=" block programlisting block-indent block-first"><pre class="programlisting">X-Geeqie-Hotkey=</pre></div>
+      Key combinations are of the form:
+
+      <div dir="ltr" class=" block programlisting block-indent"><pre class="programlisting">X-Geeqie-Hotkey=&lt;control&gt;y</pre></div>
+      <div class="admonition block note block-indent"><div class="note-inner">
+        This value may conflict with a setting in
+        <a class="link" href="GuideOptionsKeyboard.html" title="Keyboard Options">Keyboard Options</a>
+      </div></div>
+    </p>
+</div>
+</div></div>
+<div class="navbar navbar-bottom"><table class="navbar"><tr>
+<td class="navbar-prev"><a class="navbar-prev" href="GuideOptionsLayout.html" title="Window Layout">Window Layout</a></td>
+<td class="navbar-next"><a class="navbar-next" href="GuideOptionsHidden.html" title="Legacy Configuration File Options">Legacy Configuration File Options</a></td>
+</tr></table></div>
+</body>
+</html>