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 GQview author and the only maintainer. Geeqie projects goal is to move
  20 the development forward and also integrate the existing patches.</p>
  21
  22 <p>Geeqie is currently considered stable. Please report any crash or odd behavior
  23 to the <a href="https://lists.sourceforge.net/lists/listinfo/geeqie-devel">mailing list</a>
  24 and/or to <a href="https://github.com/BestImageViewer/geeqie/issues">Github</a></p>
  25
  26 <p>For more info see: <a href="http://www.geeqie.org/">http://www.geeqie.org/</a></p>
  27
  28 <p>Please send any question or suggestions to <a href="&#109;&#97;&#x69;&#x6C;&#x74;&#111;:&#103;&#101;&#101;&#x71;&#105;&#101;&#x2D;&#x64;&#x65;&#118;&#101;&#x6C;&#64;&#108;&#x69;&#115;&#116;&#115;&#46;&#x73;&#x6F;&#117;r&#x63;&#101;&#x66;&#x6F;&#114;&#103;&#101;&#x2E;&#110;&#101;&#116;">&#103;&#101;&#101;&#x71;&#105;&#101;&#x2D;&#x64;&#x65;&#118;&#101;&#x6C;&#64;&#108;&#x69;&#115;&#116;&#115;&#46;&#x73;&#x6F;&#117;r&#x63;&#101;&#x66;&#x6F;&#114;&#103;&#101;&#x2E;&#110;&#101;&#116;</a> or
  29 open an issue on <a href="https://github.com/BestImageViewer/geeqie/issues">https://github.com/BestImageViewer/geeqie/issues</a></p>
  30
  31 <h1>README contents:</h1>
  32
  33 <ul>
  34 <li>Requirements</li>
  35 <li>Notes and changes for this release</li>
  36 <li>Downloading</li>
  37 <li>Installation</li>
  38 <li>Description / Features</li>
  39 </ul>
  40
  41 <h2>Requirements</h2>
  42
  43 <h3>Required libraries:</h3>
  44
  45 <pre><code>GTK+ 3.00
  46     www.gtk.org
  47     enabled by default
  48     disable with configure option: --disable-gtk3
  49 or
  50 GTK+ 2.20
  51     disabled by default when GTK+3 libraries are found.
  52     enable with configure option: --disable-gtk3
  53     optional items map display and GPU acceleration are not available
  54     with GTK2
  55
  56     Note: GTK+3 is still somehow experimental. It is needed for some
  57     features but we have several complains about the GTK+3 usability.
  58
  59     So if you need a stable version, you are advised to compile it
  60     with GTK+2. If you want to play with the cool new features, use
  61     GTK+3.
  62 </code></pre>
  63
  64 <h3>Optional libraries:</h3>
  65
  66 <pre><code>lcms2 2.0
  67 or
  68 lcms 1.14
  69     www.littlecms.com
  70     for color management support
  71     enabled by default
  72     disable with configure option: --disable-lcms
  73
  74 exiv2 0.11
  75     www.exiv2.org
  76     for enhanced exif support
  77     enabled by default
  78     disable with configure option: --disable-exiv2
  79
  80 lirc
  81     www.lirc.org
  82     for remote control support
  83     enabled by default
  84     disable with configure option: --disable-lirc
  85
  86 libchamplain-gtk 0.12
  87 libchamplain 0.12
  88 libclutter 1.0
  89     wiki.gnome.org/Projects/libchamplain
  90     for map display
  91     disabled by default
  92     enable with configure option: --enable-map
  93     enabling will also enable GPU acceleration
  94
  95 libclutter 1.0
  96     www.clutter-project.org
  97     for GPU acceleration (a check-box on Preferences/Image must also be ticked)
  98     disabled by default
  99     enable with configure option: --enable-gpu-accel
 100     explicitly disabling will also disable the map feature
 101
 102 lua 5.1
 103     www.lua.org
 104     support for lua scripting
 105     enabled by default
 106     disable with configure option: --disable-lua
 107
 108 awk
 109     when running Geeqie, to use the geo-decode function
 110
 111 markdown
 112     when compiling Geeqie, to create this file in html format
 113 </code></pre>
 114
 115 <h2>Notes and changes for this release            [section:release_notes]</h2>
 116
 117 <p>See NEWS file.</p>
 118
 119 <h3>Code hackers:</h3>
 120
 121 <p>If you plan on making any major changes to the code that will be offered for
 122 inclusion to the main source, please contact us first - so that we can avoid
 123 duplication of effort.
 124                                                          The Geeqie Team</p>
 125
 126 <h3>Known bugs:</h3>
 127
 128 <p>See the Geeqie Bug Tracker at <a href="https://github.com/BestImageViewer/geeqie/issues">https://github.com/BestImageViewer/geeqie/issues</a></p>
 129
 130 <h2>Downloading</h2>
 131
 132 <p>Geeqie is available as a package with some distributions.</p>
 133
 134 <p>The source tar of the latest release may be downloaded: <a href="http://geeqie.org/geeqie-1.3.tar.xz">http://geeqie.org/geeqie-1.3.tar.xz</a></p>
 135
 136 <p>To download the sources of the latest commits you must have installed git:</p>
 137
 138 <p>Either: <code>git clone git://www.geeqie.org/geeqie.git</code></p>
 139
 140 <p>Or: <code>git clone http://www.geeqie.org/git/geeqie.git</code></p>
 141
 142 <h2>Installation</h2>
 143
 144 <p>Update secondary help documents (optional -  requires use of git):
 145         <code>./gen_changelog.sh ; markdown README.md &gt; README.html</code></p>
 146
 147 <p>Show compile options: <code>./autogen.sh --help</code></p>
 148
 149 <p>Compilation: <code>./autogen.sh ; make</code></p>
 150
 151 <p>General install: <code>[sudo] make install</code></p>
 152
 153 <p>Removal: <code>[sudo] make uninstall</code></p>
 154
 155 <h2>Description / Features</h2>
 156
 157 <p>Geeqie is a graphics file viewer. Basic features:</p>
 158
 159 <ul>
 160 <li>Single click image viewing / navigation.</li>
 161 <li>Zoom functions.</li>
 162 <li>Thumbnails, with optional caching and .xvpics support.</li>
 163 <li>Multiple file selection for move, copy, delete, rename, drag and drop.</li>
 164 <li>Drag and drop.</li>
 165 <li>Slideshow.</li>
 166 <li>Full screen.</li>
 167 <li>Ability to open images in external editors (configurable).</li>
 168 <li>Collections.</li>
 169 <li>Comparison of images to find duplicates by name, size, date, dimensions, or image content similarity.
 170 <ul>
 171 <li>Rotation invariant detection</li>
 172 </ul></li>
 173 <li>EXIF support.</li>
 174 <li>support for stereoscopic images
 175 <ul>
 176 <li>input: side-by-side (JPS) and MPO format</li>
 177 <li>output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)</li>
 178 </ul></li>
 179 </ul>