5 The repository at GitHub is not the main repository, and is likely to be out-of-date.
6 If you wish to clone the source code, please use the repository at [geeqie.org](http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git).
7 Details are given in the [Downloading](#downloading) section below.
11 ###################################################################
14 ## Copyright (C) 2008 - 2018 The Geeqie Team ##
15 ## Copyright (C) 1999 - 2006 John Ellis. ##
17 ## Use at your own risk! ##
19 ## This software released under the GNU General Public License. ##
20 ## Please read the COPYING file for more information. ##
21 ###################################################################
23 This is Geeqie, a successor of GQview.
25 [![Build Status](https://api.travis-ci.org/BestImageViewer/geeqie.svg?branch=master)](https://travis-ci.org/BestImageViewer/geeqie)
27 Geeqie has been forked from GQview project, because it was not possible to
28 contact the GQview author and only maintainer.
30 The Geeqie project will continue the development forward and maintain the existing code.
32 Geeqie is currently considered stable.
34 Please send any questions, problems or suggestions to the [mailing list](mailto:geeqie@freelists.org) or
35 open an issue on [Geeqie at GitHub](https://github.com/BestImageViewer/geeqie/issues).
37 Subscribe to the mailing list [here](https://www.freelists.org/list/geeqie).
39 The project website is <http://www.geeqie.org/> and you will find the latest sources in the
40 [Geeqie repository](http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git).
44 * Description / Features
47 * Notes and changes for this release
51 ## Description / Features
53 Geeqie is a graphics file viewer. Basic features:
56 * Single click image viewing / navigation.
60 * Thumbnails, with optional caching and .xvpics support.
62 * Multiple file selection for move, copy, delete, rename, drag and drop.
64 * Thumbnail preview of the destination for move, copy and rename functions.
66 * On-the-fly renaming for move and copy functions, with formatted and auto-rename features.
68 * File grouping (an image having jpeg, RAW and xmp files will appear as a single entity).
70 * Selectable exif auto-rotation of images.
73 * Single click file copy or move to pre-defined folders - with undo feature.
78 * support for stereoscopic images
79 * input: side-by-side (JPS) and MPO format
80 * output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)
82 * Viewing raster and vector images, in the following formats:
83 3FR, ANI, APM, ARW, BMP, CR2, CRW, CUR, DNG, ERF, GIF, HEIC, 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, HEIF, WEBP, DjVu, PSD, JP2. Animated GIFs are supported.
85 * Preview and thumbnails of video clips can be displayed. Clips can be run via a defined external program.
87 * 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.
89 * Pan(orama) view displays image thumbnails in calendar, grid, folder and other layouts.
90 * All available metadata and Exif/IPTC/XMP data can be displayed, as well as colour histograms and assigned tags, keywords and comments.
92 * Selectable image overlay display box - can contain any text or meta-data.
94 * Panels can be docked or floating.
96 * 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.
98 * 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.
100 * 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.
102 * Geeqie supports applying the colour profile embedded in an image along with the system monitor profile (or a user-specified monitor profile).
104 * Geeqie sessions can be remotely controlled from external software, so it can be used as an image-viewer component of a bigger application.
106 * 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.
107 * Images may be given a rating value (also known as a "star rating").
109 * 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.
111 # <a name="downloading"></a>
114 Geeqie is available as a package with some distributions, however Geeqie is stable and you may compile the latest version from sources.
116 There are two scripts which will download and compile the sources for you.
118 The first script will install Geeqie to a defined location, and will run under any system. However, it is left to you to make sure dependencies are fulfilled.
119 To get the script, from the command line type:<br/><br/>
120 `wget https://raw.githubusercontent.com/pixlsus/Scripts/master/build-geeqie`
122 The second script will run only on Debian-based system, but will fulfil all dependencies and also give you the opportunity to include additional pixbuf loaders and other useful programs.
123 To get the script, from the command line type:<br/><br/>
124 `wget https://raw.githubusercontent.com/BestImageViewer/geeqie/master/web/geeqie-install-debian.sh`
127 If you wish to compile the sources yourself you may download the latest version (if you have installed git) from here:
129 Either: `git clone git://www.geeqie.org/geeqie.git`
131 Or: `git clone http://www.geeqie.org/git/geeqie.git`
133 Also [Geeqie is available as a flatpak](https://flathub.org/apps/details/org.geeqie.Geeqie) from the [Flathub site](https://flathub.org/home).
135 ## Manual Installation
137 List compile options: `./autogen.sh --help`
140 `./autogen.sh --disable-gtk3`,
142 Compilation: `./autogen.sh [options]; make -j<no. of cpu cores> `
144 Install: `[sudo] make install`
146 Removal: `[sudo] make uninstall`
149 The zip and gzip files at geeqie.org and GitHub contain only the sources - they cannot, by themselves, be used to install Geeqie.
151 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.
153 However if you leave the folder intact, whenever new features or patches are available, execute:
155 `git pull; sudo make uninstall; sudo make maintainer-clean; ./autogen.sh; make -j<no. of cpu cores>; sudo make install`
157 Only the changed sources are downloaded, which makes this a quick operation.
159 Your configuration file, history file and desktop files are not affected by this process.
163 ## Notes and changes for the latest release
165 See the NEWS file in the installation folder, or [Geeqie News at GitHub](https://github.com/BestImageViewer/geeqie/blob/master/NEWS)
167 And either the ChangeLog file or [Geeqie ChangeLog](http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git;a=shortlog)
172 ### Required libraries:
176 disable with configure option: --disable-gtk3
179 disabled by default when GTK+3 libraries are found.
180 enable with configure option: --disable-gtk3
181 optional items map display and GPU acceleration are not available
184 Both GTK2 and GTK3 versions have been in use for several
185 years, and both may be considered stable.
187 ### Optional libraries:
192 for color management support
194 disable with configure option: --disable-lcms
198 for enhanced exif support
200 disable with configure option: --disable-exiv2
204 for remote control support
206 disable with configure option: --disable-lirc
208 libchamplain-gtk 0.12
211 wiki.gnome.org/Projects/libchamplain
214 disable with configure option: --disable-map
217 www.clutter-project.org
218 for GPU acceleration (a check-box on Preferences/Image must also be ticked)
220 disable with configure option: --disable-gpu-accel
221 explicitly disabling will also disable the map feature
225 support for lua scripting
227 disable with configure option: --disable-lua
230 for displaying .svg images
233 for displaying .wmf images
235 (see also "Additional pixbuf loaders" in the References section of the Help file)
238 when running Geeqie, to use the geo-decode function
241 when compiling Geeqie, to create this file in html format
243 libffmpegthumbnailer 2.1.0
244 https://github.com/dirkvdb/ffmpegthumbnailer
245 for thumbnailing camera video clips
246 disable with configure option: --disable-ffmpegthumbnailer
248 libpoppler-glib-dev 0.62
249 for displaying pdf files
250 disable with configure option: --disable-pdf
252 libimage-exiftool-perl
253 For the jpeg extraction plugin
256 For the command-line tool jpgicc, used by the jpeg extraction plugin
263 Additional command-line tools for various operations
266 For displaying HEIF images
269 For displaying webp images
272 For displaying DjVu images
275 For displaying JP2 images
278 For creating the Help files
282 If you plan on making any major changes to the code that will be offered for
283 inclusion to the main source, please contact us first - so that we can avoid
284 duplication of effort.
289 See the Geeqie Bug Tracker at <https://github.com/BestImageViewer/geeqie/issues>