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 For questions, problems or suggestions, please open an issue on [Geeqie at GitHub](https://github.com/BestImageViewer/geeqie/issues).
26 The project website is <http://www.geeqie.org/> and you will find the latest sources in the
27 [Geeqie repository](http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git).
31 * Description / Features
34 * Notes and changes for this release
38 ## Description / Features
40 Geeqie is a graphics file viewer. Basic features:
43 * Single click image viewing / navigation.
47 * Thumbnails, with optional caching and .xvpics support.
49 * Multiple file selection for move, copy, delete, rename, drag and drop.
51 * Thumbnail preview of the destination for move, copy and rename functions.
53 * On-the-fly renaming for move and copy functions, with formatted and auto-rename features.
55 * File grouping (an image having jpeg, RAW and xmp files will appear as a single entity).
57 * Selectable exif auto-rotation of images.
60 * Single click file copy or move to pre-defined folders - with undo feature.
65 * support for stereoscopic images
66 * input: side-by-side (JPS) and MPO format
67 * output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)
69 * Viewing raster and vector images, in the following formats:
70 3FR, ANI, APM, ARW, BMP, CR2, CRW, CUR, DNG, ERF, GIF, ICNS, ICO, JPE/JPEG/JPG, JPS, KDC, MEF, MPO, MOS, MRW, NEF, ORF, PEF, PTX, PBM/PGM/PNM/PPM, PNG, QIF/QTIF (QuickTime Image Format), RAF, RAW, RW2, SR2, SRF, SVG/SVGZ, TGA/TARGA, TIF/TIFF, WMF, XBM, XPM. Animated GIFs are supported.
72 * 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.
74 * Pan(orama) view displays image thumbnails in calendar, grid, folder and other layouts.
75 * All available metadata and Exif/IPTC/XMP data can be displayed, as well as colour histograms and assigned tags, keywords and comments.
77 * Selectable image overlay display box - can contain any text or meta-data.
79 * Panels can be docked or floating.
81 * 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.
83 * 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.
85 * 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.
87 * Geeqie supports applying the colour profile embedded in an image along with the system monitor profile (or a user-specified monitor profile).
89 * Geeqie sessions can be remotely controlled from external software, so it can be used as an image-viewer component of a bigger application.
91 * 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.
92 * Images may be given a rating value (also known as a "star rating").
94 * 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.
98 Geeqie is available as a package with some distributions.
100 The source tar of the latest formal release may be downloaded: <http://geeqie.org/geeqie-1.3.tar.xz>
102 However Geeqie is stable, and you may download the latest version (if you have installed git) from here:
104 Either: `git clone git://www.geeqie.org/geeqie.git`
106 Or: `git clone http://www.geeqie.org/git/geeqie.git`
111 Update secondary help documents (optional - requires use of git):
112 `./gen_changelog.sh ; markdown README.md > README.html`
114 List compile options: `./autogen.sh --help`
117 `./autogen.sh --disable-gtk3`,
119 Compilation: `./autogen.sh [options]; make -j<no. of cpu cores> `
121 Install: `[sudo] make install`
123 Removal: `[sudo] make uninstall`
126 The zip files at GitHub contain only the sources - they cannot, by themselves, be used to install Geeqie.
128 It is recommended to always use `git clone git://www.geeqie.org/geeqie.git` to download Geeqie. After installing Geeqie you may delete the folder you have cloned Geeqie into.
130 However if you leave the folder intact, whenever new features or patches are available, execute:
132 `git pull; sudo make uninstall; sudo make distclean; ./autogen.sh; make -j<no. of cpu cores>; sudo make install`
134 Only the changed sources are downloaded, which makes this a quick operation.
136 Your configuration file, history file and desktop files are not affected by this process.
140 ## Notes and changes for the latest release
142 See the NEWS file in the installation folder, or [Geeqie News at GitHub](https://github.com/BestImageViewer/geeqie/blob/master/NEWS)
144 And either the ChangeLog file or [Geeqie ChangeLog at GitHub](https://github.com/BestImageViewer/geeqie/blob/master/ChangeLog)
149 ### Required libraries:
153 disable with configure option: --disable-gtk3
156 disabled by default when GTK+3 libraries are found.
157 enable with configure option: --disable-gtk3
158 optional items map display and GPU acceleration are not available
161 Note: GTK+3 is still somehow experimental. It is needed for some
162 features but we have several complains about the GTK+3 usability.
164 So if you need a stable version, you are advised to compile it
165 with GTK+2. If you want to play with the cool new features, use
168 ### Optional libraries:
173 for color management support
175 disable with configure option: --disable-lcms
179 for enhanced exif support
181 disable with configure option: --disable-exiv2
185 for remote control support
187 disable with configure option: --disable-lirc
189 libchamplain-gtk 0.12
192 wiki.gnome.org/Projects/libchamplain
195 disable with configure option: --disable-map
198 www.clutter-project.org
199 for GPU acceleration (a check-box on Preferences/Image must also be ticked)
201 disable with configure option: --disable-gpu-accel
202 explicitly disabling will also disable the map feature
206 support for lua scripting
208 disable with configure option: --disable-lua
211 when running Geeqie, to use the geo-decode function
214 when compiling Geeqie, to create this file in html format
219 If you plan on making any major changes to the code that will be offered for
220 inclusion to the main source, please contact us first - so that we can avoid
221 duplication of effort.
226 See the Geeqie Bug Tracker at <https://github.com/BestImageViewer/geeqie/issues>