1 ###################################################################
4 ## Copyright (C) 2008 - 2017 The Geeqie Team ##
5 ## Copyright (C) 1999 - 2006 John Ellis. ##
7 ## Use at your own risk! ##
9 ## This software released under the GNU General Public License. ##
10 ## Please read the COPYING file for more information. ##
11 ###################################################################
13 This is Geeqie, a successor of GQview.
15 [![Build Status](https://api.travis-ci.org/BestImageViewer/geeqie.svg?branch=master)](https://travis-ci.org/BestImageViewer/geeqie)
17 Geeqie has been forked from GQview project, because it was not possible to
18 contact the GQview author and only maintainer.
20 The Geeqie project will continue the development forward and maintain the existing code.
22 Geeqie is currently considered stable.
24 Please send any questions, problems or suggestions to the [mailing list](mailto:geeqie-devel@lists.sourceforge.net) or
25 open an issue on [Geeqie at GitHub](https://github.com/BestImageViewer/geeqie/issues).
27 Subscribe to the mailing list [here](https://lists.sourceforge.net/lists/listinfo/geeqie-devel).
29 The project website is <http://www.geeqie.org/> and you will find the latest sources in the
30 [Geeqie repository](http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git).
34 * Description / Features
37 * Notes and changes for this release
41 ## Description / Features
43 Geeqie is a graphics file viewer. Basic features:
46 * Single click image viewing / navigation.
50 * Thumbnails, with optional caching and .xvpics support.
52 * Multiple file selection for move, copy, delete, rename, drag and drop.
54 * Thumbnail preview of the destination for move, copy and rename functions.
56 * On-the-fly renaming for move and copy functions, with formatted and auto-rename features.
58 * File grouping (an image having jpeg, RAW and xmp files will appear as a single entity).
60 * Selectable exif auto-rotation of images.
63 * Single click file copy or move to pre-defined folders - with undo feature.
68 * support for stereoscopic images
69 * input: side-by-side (JPS) and MPO format
70 * output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)
72 * Viewing raster and vector images, in the following formats:
73 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.
75 * 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.
77 * Pan(orama) view displays image thumbnails in calendar, grid, folder and other layouts.
78 * All available metadata and Exif/IPTC/XMP data can be displayed, as well as colour histograms and assigned tags, keywords and comments.
80 * Selectable image overlay display box - can contain any text or meta-data.
82 * Panels can be docked or floating.
84 * 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.
86 * 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.
88 * 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.
90 * Geeqie supports applying the colour profile embedded in an image along with the system monitor profile (or a user-specified monitor profile).
92 * Geeqie sessions can be remotely controlled from external software, so it can be used as an image-viewer component of a bigger application.
94 * 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.
95 * Images may be given a rating value (also known as a "star rating").
97 * Maps from [OpenStreetMap](http://www.openstreetmap.org) 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.
101 Geeqie is available as a package with some distributions.
103 The source tar of the latest formal release may be downloaded: <http://geeqie.org/geeqie-1.3.tar.xz>
105 However Geeqie is stable, and you may download the latest version (if you have installed git) from here:
107 Either: `git clone git://www.geeqie.org/geeqie.git`
109 Or: `git clone http://www.geeqie.org/git/geeqie.git`
114 Update secondary help documents (optional - requires use of git):
115 `./gen_changelog.sh ; markdown README.md > README.html`
117 List compile options: `./autogen.sh --help`
120 `./autogen.sh --disable-gtk3`,
122 Compilation: `./autogen.sh [options]; make`
124 Install: `[sudo] make install`
126 Removal: `[sudo] make uninstall`
129 ## Notes and changes for the latest release
131 See the NEWS file in the installation folder, or [Geeqie News at GitHub](https://github.com/BestImageViewer/geeqie/blob/master/NEWS)
133 And either the ChangeLog file or [Geeqie ChangeLog at GitHub](https://github.com/BestImageViewer/geeqie/blob/master/ChangeLog)
138 ### Required libraries:
142 disable with configure option: --disable-gtk3
145 disabled by default when GTK+3 libraries are found.
146 enable with configure option: --disable-gtk3
147 optional items map display and GPU acceleration are not available
150 Note: GTK+3 is still somehow experimental. It is needed for some
151 features but we have several complains about the GTK+3 usability.
153 So if you need a stable version, you are advised to compile it
154 with GTK+2. If you want to play with the cool new features, use
157 ### Optional libraries:
162 for color management support
164 disable with configure option: --disable-lcms
168 for enhanced exif support
170 disable with configure option: --disable-exiv2
174 for remote control support
176 disable with configure option: --disable-lirc
178 libchamplain-gtk 0.12
181 wiki.gnome.org/Projects/libchamplain
184 disable with configure option: --disable-map
187 www.clutter-project.org
188 for GPU acceleration (a check-box on Preferences/Image must also be ticked)
190 disable with configure option: --disable-gpu-accel
191 explicitly disabling will also disable the map feature
195 support for lua scripting
197 disable with configure option: --disable-lua
200 when running Geeqie, to use the geo-decode function
203 when compiling Geeqie, to create this file in html format
208 If you plan on making any major changes to the code that will be offered for
209 inclusion to the main source, please contact us first - so that we can avoid
210 duplication of effort.
215 See the Geeqie Bug Tracker at <https://github.com/BestImageViewer/geeqie/issues>