1 ###################################################################
4 ## Copyright (C) 2008 - 2018 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@freelists.org) or
25 open an issue on [Geeqie at GitHub](https://github.com/BestImageViewer/geeqie/issues).
27 Subscribe to the mailing list [here](https://www.freelists.org/list/geeqie).
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, 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.
75 * Preview and thumbnails of video clips can be displayed. Clips can be run via a defined external program.
77 * 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.
79 * Pan(orama) view displays image thumbnails in calendar, grid, folder and other layouts.
80 * All available metadata and Exif/IPTC/XMP data can be displayed, as well as colour histograms and assigned tags, keywords and comments.
82 * Selectable image overlay display box - can contain any text or meta-data.
84 * Panels can be docked or floating.
86 * 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.
88 * 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.
90 * 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.
92 * Geeqie supports applying the colour profile embedded in an image along with the system monitor profile (or a user-specified monitor profile).
94 * Geeqie sessions can be remotely controlled from external software, so it can be used as an image-viewer component of a bigger application.
96 * 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.
97 * Images may be given a rating value (also known as a "star rating").
99 * 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.
103 Geeqie is available as a package with some distributions.
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`
111 For Ubuntu and other Debian-based systems, [this script](http://www.geeqie.org/web/geeqie-install-debian.sh) will download Geeqie sources, all dependencies, and compile and install Geeqie. You may also select which optional libraries to install.
115 List compile options: `./autogen.sh --help`
118 `./autogen.sh --disable-gtk3`,
120 Compilation: `./autogen.sh [options]; make -j<no. of cpu cores> `
122 Install: `[sudo] make install`
124 Removal: `[sudo] make uninstall`
127 The zip and gzip files at geeqie.org and GitHub contain only the sources - they cannot, by themselves, be used to install Geeqie.
129 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.
131 However if you leave the folder intact, whenever new features or patches are available, execute:
133 `git pull; sudo make uninstall; sudo make maintainer-clean; ./autogen.sh; make -j<no. of cpu cores>; sudo make install`
135 Only the changed sources are downloaded, which makes this a quick operation.
137 Your configuration file, history file and desktop files are not affected by this process.
141 ## Notes and changes for the latest release
143 See the NEWS file in the installation folder, or [Geeqie News at GitHub](https://github.com/BestImageViewer/geeqie/blob/master/NEWS)
145 And either the ChangeLog file or [Geeqie ChangeLog](http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git;a=shortlog)
150 ### Required libraries:
154 disable with configure option: --disable-gtk3
157 disabled by default when GTK+3 libraries are found.
158 enable with configure option: --disable-gtk3
159 optional items map display and GPU acceleration are not available
162 Note: GTK+3 is still somehow experimental. It is needed for some
163 features but we have several complains about the GTK+3 usability.
165 So if you need a stable version, you are advised to compile it
166 with GTK+2. If you want to play with the cool new features, use
169 ### Optional libraries:
174 for color management support
176 disable with configure option: --disable-lcms
180 for enhanced exif support
182 disable with configure option: --disable-exiv2
186 for remote control support
188 disable with configure option: --disable-lirc
190 libchamplain-gtk 0.12
193 wiki.gnome.org/Projects/libchamplain
196 disable with configure option: --disable-map
199 www.clutter-project.org
200 for GPU acceleration (a check-box on Preferences/Image must also be ticked)
202 disable with configure option: --disable-gpu-accel
203 explicitly disabling will also disable the map feature
207 support for lua scripting
209 disable with configure option: --disable-lua
212 for displaying .svg images
215 for displaying .wmf images
217 (see also "Additional pixbuf loaders" in the References section of the Help file)
220 when running Geeqie, to use the geo-decode function
223 when compiling Geeqie, to create this file in html format
225 libffmpegthumbnailer 2.1.0
226 https://github.com/dirkvdb/ffmpegthumbnailer
227 for thumbnailing camera video clips
228 disable with configure option: --disable-ffmpegthumbnailer
230 libpoppler-glib-dev 0.62
231 for displaying pdf files
232 disable with configure option: --disable-pdf
235 For displaying timezone and UTC/DST time offset
237 https://github.com/BertoldVdb/ZoneDetect/raw/master/database/timezone21.bin
238 and copy to the location of the Geeqie ancilliary files, which is usually:
239 /usr/local/lib/geeqie/
243 If you plan on making any major changes to the code that will be offered for
244 inclusion to the main source, please contact us first - so that we can avoid
245 duplication of effort.
250 See the Geeqie Bug Tracker at <https://github.com/BestImageViewer/geeqie/issues>