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