README.html

   1 <pre><code>  ###################################################################
   2   ##                          Geeqie x.x                           ##
   3   ##                                                               ##
   4   ##              Copyright (C) 2008 - 2017 The Geeqie Team        ##
   5   ##              Copyright (C) 1999 - 2006 John Ellis.            ##
   6   ##                                                               ##
   7   ##                      Use at your own risk!                    ##
   8   ##                                                               ##
   9   ##  This software released under the GNU General Public License. ##
  10   ##       Please read the COPYING file for more information.      ##
  11   ###################################################################
  12 </code></pre>
  13
  14 <p>This is Geeqie, a successor of GQview.</p>
  15
  16 <p><a href="https://travis-ci.org/BestImageViewer/geeqie"><img src="https://api.travis-ci.org/BestImageViewer/geeqie.svg?branch=master" alt="Build Status" title="" /></a></p>
  17
  18 <p>Geeqie has been forked from GQview project, because it was not possible to
  19 contact the GQview author and only maintainer.</p>
  20
  21 <p>The Geeqie project will continue the development forward and maintain the existing code.</p>
  22
  23 <p>Geeqie is currently considered stable.</p>
  24
  25 <p>Please send any questions, problems or suggestions to the <a href="mailto:geeqie-devel@lists.sourceforge.net">mailing list</a> or
  26 open an issue on <a href="https://github.com/BestImageViewer/geeqie/issues">Geeqie at GitHub</a>.</p>
  27
  28 <p>Subscribe to the mailing list <a href="https://lists.sourceforge.net/lists/listinfo/geeqie-devel">here</a>.</p>
  29
  30 <p>The project website is <a href="http://www.geeqie.org/">http://www.geeqie.org/</a> and you will find the latest sources in the
  31 <a href="http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git">Geeqie repository</a>.</p>
  32
  33 <h1>README contents:</h1>
  34
  35 <ul>
  36 <li>Description / Features</li>
  37 <li>Downloading</li>
  38 <li>Installation</li>
  39 <li>Notes and changes for this release</li>
  40 <li>Requirements</li>
  41 </ul>
  42
  43 <h2>Description / Features</h2>
  44
  45 <p>Geeqie is a graphics file viewer. Basic features:</p>
  46
  47 <ul>
  48 <li><p>Single click image viewing / navigation.</p></li>
  49 <li><p>Zoom functions.</p></li>
  50 <li><p>Thumbnails, with optional caching and .xvpics support.</p></li>
  51 <li><p>Multiple file selection for move, copy, delete, rename, drag and drop.</p></li>
  52 <li><p>Thumbnail preview of the destination for move, copy and rename functions.</p></li>
  53 <li><p>On-the-fly renaming for move and copy functions, with formatted and auto-rename features.</p></li>
  54 <li><p>File grouping (an image having jpeg, RAW and xmp files will appear as a single entity).</p></li>
  55 <li><p>Selectable exif auto-rotation of images.</p></li>
  56 <li><p>Single click file copy or move to pre-defined folders - with undo feature.</p></li>
  57 <li><p>Drag and drop.</p></li>
  58 <li><p>Collections.</p></li>
  59 <li><p>support for stereoscopic images</p>
  60
  61 <ul>
  62 <li>input: side-by-side (JPS) and MPO format</li>
  63 <li>output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)</li>
  64 </ul></li>
  65 <li><p>Viewing raster and vector images, in the following formats:
  66 3FR, ANI, APM, ARW, BMP, CR2, CRW, CUR, DCR, DNG, ERF, GIF, ICNS, ICO, JPE/JPEG/JPG, JP2/JPC/JPX/J2K/JPF, JPS, K25, KDC, MEF, MPO, MOS, MRW, NEF, ORF, PCX, PEF, PBM/PGM/PNM/PPM, PNG, PTX, QIF/QTIF (QuickTime Image Format), R3D, RAF, RAS (Sun raster), RAW, SR2, SRF, SVG/SVGZ, TGA/TARGA, TIF/TIFF, WBMP, WMF, X3F, XBM, XPM. Animated GIFs are supported.</p></li>
  67 <li><p>Images can be displayed singly in normal or fullscreen mode; static or slideshow mode; in sets of two or four per page for comparison; or as thumbnails of various sizes. Synchronised zoom when multi images are displayed.</p></li>
  68 <li><p>Pan(orama) view displays image thumbnails in calendar, grid, folder and other layouts.</p></li>
  69 <li><p>All available metadata and Exif/IPTC/XMP data can be displayed, as well as colour histograms and assigned tags, keywords and comments.</p></li>
  70 <li><p>Selectable image overlay display box - can contain any text or meta-data.</p></li>
  71 <li><p>Panels can be docked or floating.</p></li>
  72 <li><p>Tags, both predefined and custom, can be assigned to images, and stored either as image metadata (where the file format allows), sidecar files, or in directory metadata files. Keywords and comments can also be assigned.</p></li>
  73 <li><p>Basic editing in the form of lossless 90/180-degree rotation and flipping is supported; external programs such as GIMP, Inkscape, and custom scripts using ImageMagick can be linked to allow further processing.</p></li>
  74 <li><p>Advanced searching is available using criteria such as filename, file size, age, image dimensions, similarity to a specified image, or by keywords or comments. If images have GPS coordinates embedded, you may also search for images within a radius of a geographical point.</p></li>
  75 <li><p>Geeqie supports applying the colour profile embedded in an image along with the system monitor profile (or a user-specified monitor profile).</p></li>
  76 <li><p>Geeqie sessions can be remotely controlled from external software, so it can be used as an image-viewer component of a bigger application.</p></li>
  77 <li><p>Geeqie includes a 'find duplicates' tool which can compare images using a variety of criteria (filename, file size, visual similarity, dimensions, image content), either within a single folder or between two folders. Finding duplicates ignoring the rotation of images is also supported.</p></li>
  78 <li><p>Images may be given a rating value (also known as a "star rating").</p></li>
  79 <li><p>Maps from <a href="http://www.openstreetmap.org">OpenStreetMap</a> may be displayed in a side panel. If an image has GPS coordinates embedded, its position will be displayed on the map - if Image Direction is encoded, that will be displayed also. If an image does not have embedded GPS coordinates, it may be dragged-and-dropped onto the map to encode its position.</p></li>
  80 </ul>
  81
  82 <h2>Downloading</h2>
  83
  84 <p>Geeqie is available as a package with some distributions.</p>
  85
  86 <p>The source tar of the latest formal release may be downloaded: <a href="http://geeqie.org/geeqie-1.3.tar.xz">http://geeqie.org/geeqie-1.3.tar.xz</a></p>
  87
  88 <p>However Geeqie is stable, and you may download the latest version (if you have installed git) from here:</p>
  89
  90 <p>Either: <code>git clone git://www.geeqie.org/geeqie.git</code></p>
  91
  92 <p>Or: <code>git clone http://www.geeqie.org/git/geeqie.git</code></p>
  93
  94 <h2>Installation</h2>
  95
  96 <p>Update secondary help documents (optional -  requires use of git):
  97         <code>./gen_changelog.sh ; markdown README.md &gt; README.html</code></p>
  98
  99 <p>List compile options: <code>./autogen.sh --help</code></p>
 100
 101 <p>Common options:
 102 <code>./autogen.sh --disable-gtk3</code>,</p>
 103
 104 <p>Compilation: <code>./autogen.sh [options]; make -j&lt;no. of cpu cores&gt;</code></p>
 105
 106 <p>Install: <code>[sudo] make install</code></p>
 107
 108 <p>Removal: <code>[sudo] make uninstall</code></p>
 109
 110 <h4>Note:</h4>
 111
 112 <p>The zip files at GitHub contain only the sources - they cannot, by themselves, be used to install Geeqie.</p>
 113
 114 <p>It is recommended to always use <code>git clone  git://www.geeqie.org/geeqie.git</code> to download Geeqie. After installing Geeqie you may delete the folder you have cloned Geeqie into.</p>
 115
 116 <p>However if you leave the folder intact, whenever new features or patches are available, execute:</p>
 117
 118 <p><code>git pull; sudo make uninstall; sudo make distclean; ./autogen.sh; make -j&lt;no. of cpu cores&gt;; sudo make install</code></p>
 119
 120 <p>Only the changed sources are downloaded, which makes this a quick operation.</p>
 121
 122 <p>Your configuration file, history file and desktop files are not affected by this process.</p>
 123
 124 <h2>Notes and changes for the latest release</h2>
 125
 126 <p>See the NEWS file in the installation folder, or <a href="https://github.com/BestImageViewer/geeqie/blob/master/NEWS">Geeqie News at GitHub</a></p>
 127
 128 <p>And either the ChangeLog file or <a href="https://github.com/BestImageViewer/geeqie/blob/master/ChangeLog">Geeqie ChangeLog at GitHub</a></p>
 129
 130 <h2>Requirements</h2>
 131
 132 <h3>Required libraries:</h3>
 133
 134 <pre><code>GTK+ 3.00
 135     www.gtk.org
 136     enabled by default
 137     disable with configure option: --disable-gtk3
 138 or
 139 GTK+ 2.20
 140     disabled by default when GTK+3 libraries are found.
 141     enable with configure option: --disable-gtk3
 142     optional items map display and GPU acceleration are not available
 143     with GTK2
 144
 145     Note: GTK+3 is still somehow experimental. It is needed for some
 146     features but we have several complains about the GTK+3 usability.
 147
 148     So if you need a stable version, you are advised to compile it
 149     with GTK+2. If you want to play with the cool new features, use
 150     GTK+3.
 151 </code></pre>
 152
 153 <h3>Optional libraries:</h3>
 154
 155 <pre><code>lcms2 2.0
 156 or
 157 lcms 1.14
 158     www.littlecms.com
 159     for color management support
 160     enabled by default
 161     disable with configure option: --disable-lcms
 162
 163 exiv2 0.11
 164     www.exiv2.org
 165     for enhanced exif support
 166     enabled by default
 167     disable with configure option: --disable-exiv2
 168
 169 lirc
 170     www.lirc.org
 171     for remote control support
 172     enabled by default
 173     disable with configure option: --disable-lirc
 174
 175 libchamplain-gtk 0.12
 176 libchamplain 0.12
 177 libclutter 1.0
 178     wiki.gnome.org/Projects/libchamplain
 179     for map display
 180     enabled by default
 181     disable with configure option: --disable-map
 182
 183 libclutter 1.0
 184     www.clutter-project.org
 185     for GPU acceleration (a check-box on Preferences/Image must also be ticked)
 186     enabled by default
 187     disable with configure option: --disable-gpu-accel
 188     explicitly disabling will also disable the map feature
 189
 190 lua 5.1
 191     www.lua.org
 192     support for lua scripting
 193     enabled by default
 194     disable with configure option: --disable-lua
 195
 196 awk
 197     when running Geeqie, to use the geo-decode function
 198
 199 markdown
 200     when compiling Geeqie, to create this file in html format
 201 </code></pre>
 202
 203 <h3>Code hackers:</h3>
 204
 205 <p>If you plan on making any major changes to the code that will be offered for
 206 inclusion to the main source, please contact us first - so that we can avoid
 207 duplication of effort.
 208                                                          The Geeqie Team</p>
 209
 210 <h3>Known bugs:</h3>
 211
 212 <p>See the Geeqie Bug Tracker at <a href="https://github.com/BestImageViewer/geeqie/issues">https://github.com/BestImageViewer/geeqie/issues</a></p>