Mercurial > hg > forks > geeqie

comparison 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
comparison
equal deleted inserted replaced
2657:cc61621468a9 2658:b3f34f91ac4d
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>Plugins Configuration</title>
6 <link rel="previous" href="GuideOptionsLayout.html" title="Window Layout">
7 <link rel="next" href="GuideOptionsHidden.html" title="Legacy Configuration File Options">
8 <link rel="top" href="GuideIndex.html" title="The Geeqie User Manual">
9 <style type="text/css">
10
11 html { height: 100%; }
12 body {
13 margin: 0px; padding: 12px;
14 background-color: #f9f9f6;
15 min-height: 100%;
16 direction: ltr;
17 }
18 div, p, pre, blockquote { margin: 0; padding: 0; }
19 p img { vertical-align: middle; }
20 sub { font-size: 0.83em; }
21 sub sub { font-size: 1em; }
22 sup { font-size: 0.83em; }
23 sup sup { font-size: 1em; }
24 table { border-collapse: collapse; }
25 table.table-pgwide { width: 100%; }
26 td { vertical-align: top; }
27 td { padding: 0.2em 0.83em 0.2em 0.83em; }
28 th { padding: 0 0.83em 0 0.83em; }
29 tr.tr-shade {
30 background-color: #f9f9f6;
31 }
32 td.td-colsep { border-right: solid 1px; }
33 td.td-rowsep { border-bottom: solid 1px; }
34 thead { border-top: solid 2px; border-bottom: solid 2px; }
35 tfoot { border-top: solid 2px; border-bottom: solid 2px; }
36 div.body {
37 padding: 1em;
38 max-width: 60em;
39 background-color: #ffffff;
40 border: solid 1px #e0e0df;
41 }
42 div.body-sidebar {
43 margin-right: 13em;
44 }
45 div.division div.division { margin-top: 1.72em; }
46 div.division div.division div.division { margin-top: 1.44em; }
47 div.header {
48 margin: 0;
49 color: #3f3f3f;
50 border-bottom: solid 1px #e0e0df;
51 }
52 h1, h2, h3, h4, h5, h6, h7 {
53 margin: 0; padding: 0;
54 color: #3f3f3f;
55 }
56 h1.title { font-size: 1.72em; }
57 h2.title { font-size: 1.44em; }
58 h3.title { font-size: 1.2em; }
59 h4.title, h5.title, h6.title, h7.title { font-size: 1em; }
60 .block { margin-top: 1em; }
61 .block .block-first { margin-top: 0; }
62 .block-indent {
63 margin-left left: 1.72em;
64 margin-: 1em;
65 }
66 .block-indent .block-indent { margin-left: 0em; margin-right: 0em; }
67 td .block-indent { margin-left: 0em; margin-right: 0em; }
68 dd .block-indent { margin-left: 0em; margin-right: 0em; }
69 .block-verbatim { white-space: pre; }
70 div.title {
71 margin-bottom: 0.2em;
72 font-weight: bold;
73 color: #3f3f3f;
74 }
75 div.title-formal { padding-left: 0.2em; padding-right: 0.2em; }
76 div.title-formal .label { font-weight: normal; }
77 a {
78 color: #1f609f;
79 text-decoration: none;
80 }
81 a:hover { text-decoration: underline; }
82 a:visited { color: #9f1f6f; }
83 ul, ol, dl { margin: 0; padding: 0; }
84 li {
85 margin-top: 1em;
86 margin-left: 2.4em;
87 padding: 0;
88 }
89 li.li-first { margin-top: 0; }
90 dt { margin: 1em 0 0 0; }
91 dt.dt-first { margin: 0; }
92 dd {
93 margin-left: 1.72em;
94 margin-top: 0.5em;
95 }
96 dl.dl-compact dt { margin-top: 0; }
97 dl.dl-compact dd { margin-top: 0; margin-bottom: 0; }
98
99
100 ul.linktrail {
101 display: block;
102 margin: 0.2em 0 0 0;
103 text-align: right;
104 }
105 li.linktrail { display: inline; margin: 0; padding: 0; }
106
107 li.linktrail::before {
108 content: '  /  ';
109 color: #3f3f3f;
110 }
111
112 li.linktrail-first::before, li.linktrail-only::before { content: ''; }
113
114
115 div.navbar {
116 padding: 0.5em 1em 0.5em 1em;
117 max-width: 60em;
118 background-color: #ffffff;
119 border: solid 1px #e0e0df;
120 }
121 div.navbar-top { margin-bottom: 1em; }
122 div.navbar-bottom { margin-top: 1em; clear: both; }
123 div.navbar img { border: 0; vertical-align: -0.4em; }
124 table.navbar { width: 100%; margin: 0; border: none; }
125 table.navbar td { padding: 0; border: none; }
126 td.navbar-next {
127 text-align: right;
128 }
129 a.navbar-prev::before {
130
131 content: '◀  ';
132 color: #3f3f3f;
133 }
134 a.navbar-next::after {
135
136 content: '  ▶';
137 color: #3f3f3f;
138 }
139
140
141 div.sidebar {
142 float: right;
143 padding: 0; margin: 0; width: 12em;
144 }
145 div.sidenav {
146 padding: 0.5em 1em 0 1em;
147 background-color: #ffffff;
148 border: solid 1px #e0e0df;
149 }
150 div.sidenav div.autotoc {
151 background-color: #ffffff;
152 border: none; padding: 0; margin: 0;
153 }
154 div.sidenav div.autotoc div.autotoc { margin-top: 0.5em; }
155 div.sidenav div.autotoc li { margin-bottom: 0.5em; }
156 div.sidenav div.autotoc div.autotoc div.autotoc {
157 margin-left: 1em;
158 margin-top: 0;
159 }
160 div.sidenav div.autotoc div.autotoc div.autotoc li { margin-bottom: 0; }
161
162
163 div.autotoc {
164
165 display: table;
166 margin-top: 1em;
167 margin-left: 1.72em;
168 padding: 0.5em 1em 0.5em 1em;
169 background-color: #f0f9ff;
170 border: solid 1px #c0c9ff;
171 }
172 div.autotoc ul { margin: 0; padding: 0; }
173 div.autotoc li { list-style-type: none; margin: 0; }
174 div.autotoc div.autotoc-title { margin-bottom: 0.5em; }
175 div.autotoc div.autotoc { border: none; padding: 0; margin-top: 0; margin-bottom: 0.5em; }
176 div.autotoc div.autotoc div.autotoc { margin-bottom: 0; }
177
178
179 span.bibliolabel {
180 color: #3f3f3f;
181 }
182
183
184 div.admonition {
185 padding: 0.5em 6px 0.5em 6px;
186 border: solid 1px #e0e0df;
187 background-color: #fffff0;
188 }
189 div.caution-inner, div.important-inner, div.note-inner, div.tip-inner, div.warning-inner {
190 padding-left: 60px;
191 background-position: left top;
192 background-repeat: no-repeat;
193 min-height: 48px;
194 }
195 div.caution-inner { background-image: url("admon-caution.png"); }
196 div.important-inner { background-image: url("admon-important.png"); }
197 div.note-inner { background-image: url("admon-note.png"); }
198 div.note-bug div.note-inner { background-image: url("admon-bug.png"); }
199 div.tip-inner { background-image: url("admon-tip.png"); }
200 div.warning-inner { background-image: url("admon-warning.png"); }
201 div.blockquote {
202
203 background-image: url('watermark-blockquote-201C.png');
204 background-repeat: no-repeat;
205 background-position: top left;
206 padding: 0.5em;
207 padding-left: 4em;
208 }
209 div.attribution {
210 margin-top: 0.5em;
211 color: #3f3f3f;
212 }
213 div.attribution::before {
214
215 content: '― ';
216 }
217 div.epigraph {
218 text-align: right;
219 margin-left: 20%;
220 margin-right: 0;
221 color: #3f3f3f;
222 }
223 div.figure, div.informalfigure {
224
225 display: table;
226 padding: 0.5em;
227 background-color: #f9f9f6;
228 border: solid 1px #e0e0df;
229 }
230 div.figure-inner, div.informalfigure-inner {
231 padding: 0.5em;
232 background-color: #ffffff;
233 border: solid 1px #e0e0df;
234 }
235 div.caption { margin-top: 0.5em; }
236 div.programlisting {
237 padding: 0.5em;
238
239 background-color: #f9f9f6;
240 border: solid 1px #e0e0df;
241 }
242 div.screen {
243 padding: 0.5em;
244
245 background-color: #f9f9f6;
246 border: solid 1px #e0e0df;
247 }
248 div.screen .prompt {
249 color: #3f3f3f;
250 }
251 div.screen .userinput {
252 font-weight: bold;
253 color: #3f3f3f;
254 }
255 div.programlisting .userinput {
256 font-weight: bold;
257 color: #3f3f3f;
258 }
259 pre.linenumbering {
260 color: #3f3f3f;
261 margin: 0;
262 padding-right: 1em;
263 float: left;
264 text-align: right;
265 }
266
267
268
269 dl.index dt { margin-top: 0; }
270 dl.index dd { margin-top: 0; margin-bottom: 0; }
271 dl.indexdiv dt { margin-top: 0; }
272 dl.indexdiv dd { margin-top: 0; margin-bottom: 0; }
273 dl.setindex dt { margin-top: 0; }
274 dl.setindex dd { margin-top: 0; margin-bottom: 0; }
275 div.list div.title-formal span.title {
276 border-bottom: solid 1px #e0e0df;
277 }
278 div.simplelist {
279 margin-left: 1.72em;
280 }
281 div.simplelist table { margin-left: 0; border: none; }
282 div.simplelist td {
283 padding: 0.5em;
284 border-left: solid 1px #e0e0df;
285 }
286 div.simplelist td.td-first {
287 padding-left: 0;
288 border-left: 0;
289 }
290 div.synopsis {
291 padding: 0.5em;
292
293 background-color: #f9f9f6;
294 border-top: solid 2px #c0c9ff;
295 border-bottom: solid 2px #c0c9ff;
296 }
297 div.synopsis div.synopsis {
298 padding: 0;
299 border: none;
300 }
301 div.synopsis div.block { margin-top: 0.2em; }
302 div.synopsis div.block-first { margin-top: 0; }
303 div.cmdsynopsis { font-family: monospace; }
304
305 span.accel { text-decoration: underline; }
306 span.acronym { font-family: sans-serif; }
307 span.application { font-style: italic; }
308 span.classname, span.exceptionname, span.interfacename { font-family: monospace; }
309 span.code {
310 font-family: monospace;
311 border: solid 1px #e0e0df;
312 padding-left: 0.2em;
313 padding-right: 0.2em;
314 }
315 pre span.code { border: none; padding: 0; }
316 span.command {
317 font-family: monospace;
318 border: solid 1px #e0e0df;
319 padding-left: 0.2em;
320 padding-right: 0.2em;
321 }
322 pre span.command { border: none; padding: 0; }
323 span.computeroutput { font-family: monospace; }
324
325 span.constant { font-family: monospace; }
326 span.database { font-family: monospace; }
327 span.email { font-family: monospace; }
328 span.emphasis { font-style: italic; }
329 span.emphasis-bold { font-style: normal; font-weight: bold; }
330 span.envar { font-family: monospace; }
331
332 span.filename { font-family: monospace; }
333 span.firstterm { font-style: italic; }
334 span.foreignphrase { font-style: italic; }
335 span.function { font-family: monospace; }
336
337 dt.glossterm span.glossterm { font-style: normal; }
338
339
340 span.glossterm { font-style: italic; }
341
342 span.guibutton, span.guilabel, span.guimenu, span.guimenuitem, span.guisubmenu, span.interface {
343 font-weight: bold;
344 color: #3f3f3f;
345 }
346 span.keycap {
347 font-weight: bold;
348 color: #3f3f3f;
349 }
350 span.lineannotation { font-style: italic; }
351 span.literal { font-family: monospace; }
352 span.markup { font-family: monospace; }
353 span.medialabel { font-style: italic; }
354 span.methodname { font-family: monospace; }
355 span.ooclass, span.ooexception, span.oointerface { font-family: monospace; }
356 span.option { font-family: monospace; }
357 span.parameter { font-family: monospace; }
358 span.paramdef span.parameter { font-style: italic; }
359 span.prompt { font-family: monospace; }
360 span.property { font-family: monospace; }
361 span.replaceable { font-style: italic; }
362 span.returnvalue { font-family: monospace; }
363 span.sgmltag { font-family: monospace; }
364 span.structfield, span.structname { font-family: monospace; }
365 span.symbol { font-family: monospace; }
366 span.systemitem { font-family: monospace; }
367 span.token { font-family: monospace; }
368 span.type { font-family: monospace; }
369 span.uri { font-family: monospace; }
370 span.userinput { font-family: monospace; }
371 span.varname { font-family: monospace; }
372 span.wordasword { font-style: italic; }
373
374
375
376 div.footnotes { font-style: italic; font-size: 0.8em; }
377 div.footnote { margin-top: 1.44em; }
378 span.footnote-number { display: inline; padding-right: 0.83em; }
379 span.footnote-number + p { display: inline; }
380 a.footnote { text-decoration: none; font-size: 0.8em; }
381 a.footnote-ref { text-decoration: none; }
382
383 span.co {
384 margin-left: 0.2em; margin-right: 0.2em;
385 padding-left: 0.4em; padding-right: 0.4em;
386 border: solid 1px #000000;
387 -moz-border-radius: 8px;
388 background-color: #000000;
389 color: #FFFFFF;
390 font-size: 8px;
391 }
392 span.co:hover {
393 border-color: #333333;
394 background-color: #333333;
395 color: #FFFFFF;
396 }
397 span.co a { text-decoration: none; }
398 span.co a:hover { text-decoration: none; }
399
400 dt.question { margin-left: 0em; }
401 dt.question div.label { float: left; }
402 dd + dt.question { margin-top: 1em; }
403 dd.answer {
404 margin-top: 1em;
405 margin-left: 2em;
406 margin-right: 1em;
407 }
408 dd.answer div.label { float: left; }
409 </style>
410 </head>
411 <body>
412 <div class="navbar navbar-top"><table class="navbar"><tr>
413 <td class="navbar-prev"><a class="navbar-prev" href="GuideOptionsLayout.html" title="Window Layout">Window Layout</a></td>
414 <td class="navbar-next"><a class="navbar-next" href="GuideOptionsHidden.html" title="Legacy Configuration File Options">Legacy Configuration File Options</a></td>
415 </tr></table></div>
416 <div class="sidebar"><div class="sidenav"><div class="autotoc"><ul>
417 <li><a href="GuideIndex-info.html" title="About This Document">About This Document</a></li>
418 <li>
419 <a class="xref" href="GuideIndex.html" title="The Geeqie User Manual">The Geeqie User Manual</a><div class="autotoc"><ul>
420 <li><a class="xref" href="GuideIntroduction.html" title="Introduction">Introduction</a></li>
421 <li><a class="xref" href="GuideMainWindow.html" title="Main Window">Main Window</a></li>
422 <li><a class="xref" href="GuideSidebars.html" title="Sidebars">Sidebars</a></li>
423 <li><a class="xref" href="GuideOtherWindows.html" title="Stand-alone Windows">Stand-alone Windows</a></li>
424 <li><a class="xref" href="GuideImageSearch.html" title="Search and Select">Search and Select</a></li>
425 <li><a class="xref" href="GuideImageManagementPlugins.html" title="Plugins">Plugins</a></li>
426 <li><a class="xref" href="GuideImageManagement.html" title="File Management">File Management</a></li>
427 <li><a class="xref" href="GuideColorManagement.html" title="Color Management">Color Management</a></li>
428 <li><a class="xref" href="GuideImagePresentation.html" title="Image Presentation">Image Presentation</a></li>
429 <li><a class="xref" href="GuidePrinting.html" title="Printing">Printing</a></li>
430 <li><a class="xref" href="GuideOptionsMain.html" title="Preferences">Preferences</a></li>
431 <li>
432 <a class="xref" href="GuideOptionsAdditional.html" title="Additional Preferences">Additional Preferences</a><div class="autotoc"><ul>
433 <li><a class="xref" href="GuideOptionsLayout.html" title="Window Layout">Window Layout</a></li>
434 <li>Plugins Configuration</li>
435 <li><a class="xref" href="GuideOptionsHidden.html" title="Legacy Configuration File Options">Legacy Configuration File Options</a></li>
436 </ul></div>
437 </li>
438 <li><a class="xref" href="GuideReference.html" title="Reference">Reference</a></li>
439 <li><a class="xref" href="GuideFaq.html" title="Frequently Asked Questions">Frequently Asked Questions</a></li>
440 <li><a class="xref" href="GuideLicence.html" title="Licence">Licence</a></li>
441 <li><a class="xref" href="GuideCredits.html" title="Credits">Credits</a></li>
442 <li><a class="xref" href="GuideGnuFdl.html" title="GNU Free Documentation License">GNU Free Documentation License</a></li>
443 </ul></div>
444 </li>
445 </ul></div></div></div>
446 <div class="body body-sidebar"><div class="division section">
447 <a name="GuidePluginsConfig"></a><div class="header"><h1 class="section title"><span class="title"><a name="titleGuidePluginsConfig"></a>Plugins Configuration</span></h1></div>
448 <ul class="linktrail">
449 <li class="linktrail linktrail-first"><a class="linktrail" href="GuideIndex.html" title="The Geeqie User Manual">The Geeqie User Manual</a></li>
450 <li class="linktrail linktrail-last"><a class="linktrail" href="GuideOptionsAdditional.html" title="Additional Preferences">Additional Preferences</a></li>
451 </ul>
452 <p class="para block block-first"></p>
453 <div class="autotoc"><ul>
454 <li>
455 <span class="label">12.2.1. </span><a class="xref" href="GuidePluginsConfig.html#PluginsConfigurationDialog" title="Plugins Configuration Dialog">Plugins Configuration Dialog</a>
456 </li>
457 <li>
458 <span class="label">12.2.2. </span><a class="xref" href="GuidePluginsConfig.html#Addingnewplugin" title="Adding new plugin">Adding new plugin</a>
459 </li>
460 <li>
461 <span class="label">12.2.3. </span><a class="xref" href="GuidePluginsConfig.html#Modifyinganexistingplugin" title="Modifying an existing plugin">Modifying an existing plugin</a>
462 </li>
463 <li>
464 <span class="label">12.2.4. </span><a class="xref" href="GuidePluginsConfig.html#Deletingaplugin" title="Deleting a plugin">Deleting a plugin</a>
465 </li>
466 <li>
467 <span class="label">12.2.5. </span><a class="xref" href="GuidePluginsConfig.html#Specialplugins" title="Special plugins">Special plugins</a>
468 </li>
469 <li>
470 <span class="label">12.2.6. </span><a class="xref" href="GuidePluginsConfig.html#Geeqieextensions" title="Geeqie desktop file keys">Geeqie desktop file keys</a>
471 </li>
472 </ul></div>
473 <div class="division section">
474 <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>
475 <p class="para block block-first">
476 This dialog allows user to add new plugins or modify the system ones. It is available in the menu
477 <span class="menuchoice"><span class="guimenu">Edit</span> ▸ <span class="guimenuitem">Configure Plugins</span></span>
478 .
479 </p>
480 <p class="para block">
481 The Plugins dialog shows list of all relevant plugins i.e. all installed desktop files that are designated either:
482 <div class="block list itemizedlist"><ul class="itemizedlist" compact>
483 <li class="li-first">
484 <span class="literal" dir="ltr">Categories=Graphics</span>
485 </li>
486 <li>
487 <span class="literal" dir="ltr">Categories=X-Geeqie</span>
488 </li>
489 </ul></div>
490 <p class="para block"></p>
491 The list has the following columns:
492 </p>
493 <div class="block list variablelist"><dl class="variablelist">
494 <dt class="term dt-first">
495 <span class="guilabel">Name</span>
496 </dt>
497 <dd>
498 <p class="para block block-first">Plugin name as specified in desktop file, and is the name displayed in menus.</p>
499 </dd>
500 <dt class="term">
501 <span class="guilabel">Hidden</span>
502 </dt>
503 <dd>
504 A plugin can be
505 <span class="emphasis">Hidden</span>
506 for one of these reasons:
507 <div class="block list itemizedlist"><ul class="itemizedlist">
508 <li class="li-first">
509 the desktop file contains
510 <span class="literal" dir="ltr">Hidden=TRUE</span>
511 or
512 <span class="literal" dir="ltr">NoDisplay=TRUE</span>
513 </li>
514 <li>
515 <span class="literal" dir="ltr">TryExec</span>
516 binary was not found
517 </li>
518 <li>
519 <span class="literal" dir="ltr">MimeType</span>
520 list does not contain images
521 </li>
522 <li>
523 <span class="literal" dir="ltr">MimeType</span>
524 list is empty and
525 <span class="literal" dir="ltr">Categories</span>
526 does not contain
527 <span class="literal" dir="ltr">X-Geeqie</span>
528 </li>
529 </ul></div>
530 </dd>
531 </dl></div>
532 <div class="block list variablelist"><dl class="variablelist">
533 <dt class="term dt-first">
534 <span class="guilabel">Desktop file</span>
535 </dt>
536 <dd>
537 Name of the desktop file, used as an identifier in
538 <a class="link" href="GuideOptionsKeyboard.html" title="Keyboard Options">Keyboard Options</a>
539 .
540 </dd>
541 <dt class="term">
542 <span class="guilabel">Path</span>
543 </dt>
544 <dd>Full path to the desktop file. Desktop files in user directories override the system ones with the same name.</dd>
545 </dl></div>
546 </div>
547 <div class="division section">
548 <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>
549 <p class="para block block-first">
550 <span class="code" dir="ltr">
551 <span class="guibutton">
552 <span class="guiicon">
553 <span class="inlinegraphic"><img src="document-new.png"></span>
554 </span>
555 New
556 </span>
557 </span>
558 opens a text editor with a desktop file template. You must amend the line
559 <div dir="ltr" class=" block programlisting block-indent"><pre class="programlisting">Exec=command %f</pre></div>
560 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.
561 </p>
562 <p class="para block"></p>
563 </div>
564 <div class="division section">
565 <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>
566 <p class="para block block-first">
567 <span class="code" dir="ltr">
568 <span class="guibutton">
569 <span class="guiicon">
570 <span class="inlinegraphic"><img src="gtk-edit.png"></span>
571 </span>
572 Edit
573 </span>
574 </span>
575 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).
576 </p>
577 </div>
578 <div class="division section">
579 <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>
580 <p class="para block block-first">
581 <span class="code" dir="ltr">
582 <span class="guibutton">
583 <span class="guiicon">
584 <span class="inlinegraphic"><img src="edit-delete.png"></span>
585 </span>
586 Delete
587 </span>
588 </span>
589 can delete user writable desktop files. System desktop files can't be deleted directly, but it is possible to edit them and set
590 <span class="literal" dir="ltr">Hidden=TRUE</span>
591 , see above.
592 </p>
593 </div>
594 <div class="division section">
595 <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>
596 <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>
597 <p class="para block">
598 <div dir="ltr" class=" block programlisting block-indent block-first"><pre class="programlisting"> geeqie-copy-command.desktop
599 geeqie-move-command.desktop
600 geeqie-rename-command.desktop
601 geeqie-delete-command.desktop
602 geeqie-folder-command.desktop
603 </pre></div>
604 </p>
605 <p class="para block">This can be used for example for a custom trash command or for manipulation of files under version control.</p>
606 </div>
607 <div class="division section">
608 <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>
609 <p class="para block block-first">
610 A desktop file for use only by Geeqie should have the following entries:
611 <div dir="ltr" class=" block programlisting block-indent block-first"><pre class="programlisting"> Categories=X-Geeqie;
612 OnlyShowIn=X-Geeqie;
613 </pre></div>
614 </p>
615 <p class="para block">
616 A menu path where the plugin will appear, instead of in the default
617 <span class="menuchoice"><span class="guimenu">Plugins</span></span>
618 , can be set by including:
619 <div dir="ltr" class=" block programlisting block-indent"><pre class="programlisting">X-Geeqie-Menu-Path=&lt;FileMenuPath&gt;</pre></div>
620 </p>
621 <p class="para block">
622 Possible vales for
623 <span class="emphasis">FileMenuPath</span>
624 are:
625 <div dir="ltr" class=" block programlisting block-indent"><pre class="programlisting"> FileMenu
626 FileMenu/OpenSection
627 FileMenu/SearchSection
628 FileMenu/PrintSection
629 FileMenu/FileOpsSection
630 FileMenu/QuitSection
631 GoMenu
632 SelectMenu
633 SelectMenu/SelectSection
634 SelectMenu/ClipboardSection
635 SelectMenu/MarksSection
636 EditMenu/EditMenu
637 EditMenu/EditSection
638 EditMenu/OrientationMenu
639 EditMenu/RatingMenu
640 EditMenu/PropertiesSection
641 EditMenu/PreferencesSection
642 PluginsMenu
643 ViewMenu
644 ViewMenu/WindowSection
645 ViewMenu/FileDirMenu
646 ViewMenu/FileDirMenu/FolderSection
647 ViewMenu/FileDirMenu/ListSection
648 ViewMenu/DirSection
649 ViewMenu/ZoomMenu
650 ViewMenu/ZoomMenu/ConnectZoomMenu
651 ViewMenu/SplitMenu
652 ViewMenu/StereoMenu
653 ViewMenu/ColorMenu
654 ViewMenu/OverlayMenu
655 ViewMenu/ViewSection
656 ViewMenu/ToolsSection
657 ViewMenu/SlideShowSection
658 HelpMenu
659 HelpMenu/HelpSection
660 </pre></div>
661 </p>
662 <p class="para block">
663 If you want a plugin to use a user-definable path, the following entry must be made in the desktop file:
664 <div dir="ltr" class=" block programlisting block-indent block-first"><pre class="programlisting">X-Geeqie-Filter=true</pre></div>
665 </p>
666 <p class="para block">
667 Desktop files containing this entry will be displayed in the Folder action list of the
668 <a class="link" href="GuideSidebarsSortManager.html#CopyMoveandLink" title="Copy, Move, Link and Desktop actions">Sort Manager Sidebar</a>
669 . The path of the bookmark clicked will be used by the desktop file.
670 <p class="para block"></p>
671 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:
672 <div dir="ltr" class=" block programlisting block-indent"><pre class="programlisting"> for file in "$@"
673 do
674 destination=$(geeqie --remote --get-destination:"$file")
675
676 echo "$destination"
677 echo $GEEQIE_DESTINATION
678 done
679 </pre></div>
680 </p>
681 <p class="para block">
682 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:
683 <div dir="ltr" class=" block programlisting block-indent block-first"><pre class="programlisting">X-Geeqie-Keep-Fullscreen=true</pre></div>
684 </p>
685 <p class="para block">
686 Any terminal output from the plugin command can be displayed with the following command:
687 <div dir="ltr" class=" block programlisting block-indent block-first"><pre class="programlisting">X-Geeqie-Verbose=true</pre></div>
688 </p>
689 <p class="para block">
690 The plugin can be restricted to run on only certain file types, for example:
691 <div dir="ltr" class=" block programlisting block-indent block-first"><pre class="programlisting">X-Geeqie-File-Extensions=.jpg; .cr2</pre></div>
692 The entries are case insensitive.
693 </p>
694 <p class="para block">
695 <div dir="ltr" class=" block programlisting block-indent block-first"><pre class="programlisting">X-Geeqie-Keep-Verbose-Multi=</pre></div>
696 TBD
697 </p>
698 <p class="para block">
699 The key or key combination to execute this function can be set with:
700 <div dir="ltr" class=" block programlisting block-indent block-first"><pre class="programlisting">X-Geeqie-Hotkey=</pre></div>
701 Key combinations are of the form:
702
703 <div dir="ltr" class=" block programlisting block-indent"><pre class="programlisting">X-Geeqie-Hotkey=&lt;control&gt;y</pre></div>
704 <div class="admonition block note block-indent"><div class="note-inner">
705 This value may conflict with a setting in
706 <a class="link" href="GuideOptionsKeyboard.html" title="Keyboard Options">Keyboard Options</a>
707 </div></div>
708 </p>
709 </div>
710 </div></div>
711 <div class="navbar navbar-bottom"><table class="navbar"><tr>
712 <td class="navbar-prev"><a class="navbar-prev" href="GuideOptionsLayout.html" title="Window Layout">Window Layout</a></td>
713 <td class="navbar-next"><a class="navbar-next" href="GuideOptionsHidden.html" title="Legacy Configuration File Options">Legacy Configuration File Options</a></td>
714 </tr></table></div>
715 </body>
716 </html>