doc/docbook/GuideReferenceStandardPlugins.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <section id="GuideReferenceStandardPlugins">
   3   <title id="titleGuideReferenceStandardPlugins">Standard Plugins</title>
   4   <para>The following plugins are supplied as standard with Geeqie.</para>
   5   <section id="Symlink">
   6     <title>Symlink</title>
   7     <para>Creates a symbolic link on the selected files. If a file has sidecars, they will also be symlinked.</para>
   8     <para>
   9       This item is displayed in the
  10       <emphasis role="strong">File</emphasis>
  11       menu.
  12     </para>
  13   </section>
  14   <section id="Applytheorientationtoimagecontent">
  15     <title>Apply the orientation to image content</title>
  16     <para>This command affects only jpeg, tiff and png files. The image file on disk is rotated to the orientation as specified by its Exif Orientation tag.</para>
  17     <warning>
  18       <para>External commands exiftran, exiv2 and mogrify, are used to implement this command.</para>
  19     </warning>
  20     <para>
  21       This item is displayed in the
  22       <emphasis role="strong">Edit/Orientation</emphasis>
  23       menu.
  24     </para>
  25   </section>
  26   <section id="Cameraimport">
  27     <title>Camera import</title>
  28     <para>Imports images from an attached camera to the current folder. If a file with the same name already exists it will not be overwritten, and the new image will not be downloaded.</para>
  29     <para>File names on digital cameras are not necessarily unique. In some cases the same file name can exist in more than one sub-folder on the camera. As existing images will not be overwritten, subsequent files of the same name will not be downloaded. In this case a dialog will be shown to warn you of this.</para>
  30     <para>
  31       You may use the gphoto2 option
  32       <code>--filename</code>
  33       option to ensure that all filenames are unique when downloading. Refer to the
  34       <ulink url="http://www.gphoto.org/doc/manual/ref-gphoto2-cli.html">gphoto2 documentation.</ulink>
  35     </para>
  36     <para>
  37       This item is displayed in the
  38       <emphasis role="strong">Plugins</emphasis>
  39       menu.
  40     </para>
  41   </section>
  42   <section id="Exportjpeg">
  43     <title>Export jpeg</title>
  44     <para>
  45       Extracts an embedded jpeg from a raw image to a file in the
  46       <code>/tmp</code>
  47       folder. If you wish to to keep this image, it must be copied or moved.
  48       <para />
  49       If
  50       <code>jpgicc</code>
  51       is installed, the image will be colour-corrected for the currently selected rendering intent.
  52     </para>
  53     <para>
  54       This item is displayed in the
  55       <emphasis role="strong">Plugins</emphasis>
  56       menu.
  57     </para>
  58   </section>
  59   <section id="Imagecrop">
  60     <title>Image crop</title>
  61     <para>
  62       If rectangle coordinates have been set by
  63       <emphasis role="strong">Edit/Draw Rectangle</emphasis>
  64       , a cropped image will be stored in the
  65       <code>/tmp</code>
  66       folder. If you wish to to keep this image, it must be copied or moved.
  67     </para>
  68     <para>
  69       This item is displayed in the
  70       <emphasis role="strong">Plugins</emphasis>
  71       menu.
  72     </para>
  73   </section>
  74   <section id="Randomimage">
  75     <title>Random image</title>
  76     <para>Selects and displays a random image from a list of all images in Collections and the currently displayed folder.</para>
  77     <para>
  78       This item is displayed in the
  79       <emphasis role="strong">Plugins</emphasis>
  80       menu.
  81     </para>
  82   </section>
  83   <section id="Tetheredphotography">
  84     <title>Tethered photography</title>
  85     <para>
  86       If a camera is connected to the computer via USB, photos taken are immediately downloaded to the current folder and displayed on the computer.
  87       <para />
  88       If a file already exists with the same name, it is not overwritten but the download will not take place.
  89       <para />
  90       Auto-rename can be achieved with the --filename option of gphoto2.
  91       <para />
  92       In file
  93       <code>$HOME/.config/gphoto2/settings</code>
  94       , set the option:
  95       <code>gphoto2=filename=&lt;see the gphoto2 manual&gt;</code>
  96     </para>
  97     <para>
  98       This item is displayed in the
  99       <emphasis role="strong">Plugins</emphasis>
 100       menu.
 101     </para>
 102   </section>
 103   <section id="downsize">
 104     <title>Resize image</title>
 105     <para>Reduce the size of an image.</para>
 106     <table frame="all">
 107       <tgroup cols="2" rowsep="1" colsep="1">
 108         <thead>
 109           <row>
 110             <entry>Option</entry>
 111             <entry>Meaning</entry>
 112           </row>
 113         </thead>
 114         <tbody>
 115           <row>
 116             <entry>Required size kB</entry>
 117             <entry>desired output file size in kilobytes</entry>
 118           </row>
 119           <row>
 120             <entry>Tolerance %</entry>
 121             <entry>tolerance or allowed size of result greater than desired size expressed as percent of desired</entry>
 122           </row>
 123           <row>
 124             <entry>Max. iterations</entry>
 125             <entry>maximum number of iterations to stop</entry>
 126           </row>
 127           <row>
 128             <entry>Copy if unchanged</entry>
 129             <entry>
 130               copy to output when not downsizing and no image
 131               format change
 132             </entry>
 133           </row>
 134           <row>
 135             <entry>Strip metadata</entry>
 136             <entry>strip all meta data</entry>
 137           </row>
 138           <row>
 139             <entry>Show computation</entry>
 140             <entry>show the values of each iteration</entry>
 141           </row>
 142           <row>
 143             <entry>Open output file in Geeqie</entry>
 144             <entry>on successful conversion set Geeqie focus to the file</entry>
 145           </row>
 146         </tbody>
 147       </tgroup>
 148     </table>
 149     <para>
 150       This plugin uses the Downsize script. The original may be found
 151       <ulink url="http://www.fmwconcepts.com/imagemagick/downsize/index.php">here.</ulink>
 152       It is subject to the following copyright:
 153     </para>
 154     <programlisting>
 155       Copyright © Fred Weinhaus
 156
 157       My scripts are available free of charge for non-commercial (non-profit) use, ONLY.
 158
 159       For use of my scripts in commercial (for-profit) environments or non-free applications,
 160       please contact me (Fred Weinhaus) for licensing arrangements. My email address is fmw at
 161       alink dot net.
 162
 163       If you:
 164       1) redistribute,
 165       2) incorporate any of these scripts into other free applications or
 166       3) reprogram them in another scripting language, then you must contact me for permission,
 167       especially if the result might be used in a commercial or for-profit environment.
 168
 169       Usage, whether stated or not in the script, is restricted to the above licensing
 170       arrangements. It is also subject, in a subordinate manner, to the ImageMagick license, which
 171       can be found at: http://www.imagemagick.org/script/license.php
 172     </programlisting>
 173     <para />
 174   </section>
 175 </section>