README.md
1 ###################################################################
2 ## Geeqie 1.6 ##
3 ## ##
4 ## Copyright (C) 2008 - 2020 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
13PLEASE NOTE!
14------------
15
16The repository at GitHub is not the main repository, and is likely to be out-of-date.
17If you wish to clone the source code, please use the repository at [geeqie.org](http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git).
18Details are given in the [Downloading](#downloading) section below.
19
20-------------------
21
22This is Geeqie, a successor of GQview.
23
24[![Build Status](https://api.travis-ci.org/BestImageViewer/geeqie.svg?branch=master)](https://travis-ci.org/BestImageViewer/geeqie)
25
26Geeqie has been forked from GQview project, because it was not possible to
27contact the GQview author and only maintainer.
28
29The Geeqie project will continue the development forward and maintain the existing code.
30
31Geeqie is currently considered stable.
32
33Please send any questions, problems or suggestions to the [mailing list](mailto:geeqie@freelists.org) or
34open an issue on [Geeqie at GitHub](https://github.com/BestImageViewer/geeqie/issues).
35
36Subscribe to the mailing list [here](https://www.freelists.org/list/geeqie).
37
38The project website is <http://www.geeqie.org/> and you will find the latest sources in the
39[Geeqie repository](http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git).
40
41# README contents:
42
43* Description / Features
44* Downloading
45* Installation
46* Notes and changes for this release
47* Requirements
48
49
50## Description / Features
51
52Geeqie is a graphics file viewer. Basic features:
53
54
55* Single click image viewing / navigation.
56
57* Zoom functions.
58
59* Thumbnails, with optional caching and .xvpics support.
60
61* Multiple file selection for move, copy, delete, rename, drag and drop.
62
63* Thumbnail preview of the destination for move, copy and rename functions.
64
65* On-the-fly renaming for move and copy functions, with formatted and auto-rename features.
66
67* File grouping (an image having jpeg, RAW and xmp files will appear as a single entity).
68
69* Selectable exif auto-rotation of images.
70
71
72* Single click file copy or move to pre-defined folders - with undo feature.
73* Drag and drop.
74
75* Collections.
76
77* support for stereoscopic images
78 * input: side-by-side (JPS) and MPO format
79 * output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)
80
81* Viewing raster and vector images, in the following formats:
823FR, 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.
83
84* Preview and thumbnails of video clips can be displayed. Clips can be run via a defined external program.
85
86* 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.
87
88* Pan(orama) view displays image thumbnails in calendar, grid, folder and other layouts.
89* All available metadata and Exif/IPTC/XMP data can be displayed, as well as colour histograms and assigned tags, keywords and comments.
90
91* Selectable image overlay display box - can contain any text or meta-data.
92
93* Panels can be docked or floating.
94
95* 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.
96
97* 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.
98
99* 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.
100
101* Geeqie supports applying the colour profile embedded in an image along with the system monitor profile (or a user-specified monitor profile).
102
103* Geeqie sessions can be remotely controlled from external software, so it can be used as an image-viewer component of a bigger application.
104
105* 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.
106* Images may be given a rating value (also known as a "star rating").
107
108* 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.
109
110# <a name="downloading"></a>
111## Downloading
112
113Geeqie is available as a package with some distributions, however Geeqie is stable and you may compile the latest version from sources.
114
115There are two scripts which will download and compile the sources for you.
116
117The 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.
118To get the script, from the command line type:<br/><br/>
119`wget https://raw.githubusercontent.com/pixlsus/Scripts/master/build-geeqie`
120
121The 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.
122To get the script, from the command line type:<br/><br/>
123`wget https://raw.githubusercontent.com/BestImageViewer/geeqie/master/web/geeqie-install-debian.sh`
124
125
126If you wish to compile the sources yourself you may download the latest version (if you have installed git) from here:
127
128Either: `git clone git://www.geeqie.org/geeqie.git`
129
130Or: `git clone http://www.geeqie.org/git/geeqie.git`
131
132Also [Geeqie is available as a flatpak](https://flathub.org/apps/details/org.geeqie.Geeqie) from the [Flathub site](https://flathub.org/home).
133
134## Manual Installation
135
136List compile options: `./autogen.sh --help`
137
138Common options:
139`./autogen.sh --disable-gtk3`,
140
141Compilation: `./autogen.sh [options]; make -j<no. of cpu cores> `
142
143Install: `[sudo] make install`
144
145Removal: `[sudo] make uninstall`
146
147#### Note:
148The zip and gzip files at geeqie.org and GitHub contain only the sources - they cannot, by themselves, be used to install Geeqie.
149
150It 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.
151
152However if you leave the folder intact, whenever new features or patches are available, execute:
153
154`git pull; sudo make uninstall; sudo make maintainer-clean; ./autogen.sh; make -j<no. of cpu cores>; sudo make install`
155
156Only the changed sources are downloaded, which makes this a quick operation.
157
158Your configuration file, history file and desktop files are not affected by this process.
159
160
161
162## Notes and changes for the latest release
163
164See the NEWS file in the installation folder, or [Geeqie News at GitHub](https://github.com/BestImageViewer/geeqie/blob/master/NEWS)
165
166And either the ChangeLog file or [Geeqie ChangeLog](http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git;a=shortlog)
167
168
169## Requirements
170
171### Required libraries:
172 GTK+ 3.00
173 www.gtk.org
174 enabled by default
175 disable with configure option: --disable-gtk3
176 or
177 GTK+ 2.20
178 disabled by default when GTK+3 libraries are found.
179 enable with configure option: --disable-gtk3
180 optional items map display and GPU acceleration are not available
181 with GTK2
182
183 Both GTK2 and GTK3 versions have been in use for several
184 years, and both may be considered stable.
185
186### Optional libraries:
187 lcms2 2.0
188 or
189 lcms 1.14
190 www.littlecms.com
191 for color management support
192 enabled by default
193 disable with configure option: --disable-lcms
194
195 exiv2 0.11
196 www.exiv2.org
197 for enhanced exif support
198 enabled by default
199 disable with configure option: --disable-exiv2
200
201 lirc
202 www.lirc.org
203 for remote control support
204 enabled by default
205 disable with configure option: --disable-lirc
206
207 libchamplain-gtk 0.12
208 libchamplain 0.12
209 libclutter 1.0
210 wiki.gnome.org/Projects/libchamplain
211 for map display
212 enabled by default
213 disable with configure option: --disable-map
214
215 libclutter 1.0
216 www.clutter-project.org
217 for GPU acceleration (a check-box on Preferences/Image must also be ticked)
218 enabled by default
219 disable with configure option: --disable-gpu-accel
220 explicitly disabling will also disable the map feature
221
222 lua 5.1
223 www.lua.org
224 support for lua scripting
225 enabled by default
226 disable with configure option: --disable-lua
227
228 librsvg2-common
229 for displaying .svg images
230
231 libwmf0.2-7-gtk
232 for displaying .wmf images
233
234 (see also "Additional pixbuf loaders" in the References section of the Help file)
235
236 awk
237 when running Geeqie, to use the geo-decode function
238
239 markdown
240 when compiling Geeqie, to create this file in html format
241
242 libffmpegthumbnailer 2.1.0
243 https://github.com/dirkvdb/ffmpegthumbnailer
244 for thumbnailing camera video clips
245 disable with configure option: --disable-ffmpegthumbnailer
246
247 libpoppler-glib-dev 0.62
248 for displaying pdf files
249 disable with configure option: --disable-pdf
250
251 libimage-exiftool-perl
252 For the jpeg extraction plugin
253
254 liblcms2-utils
255 For the command-line tool jpgicc, used by the jpeg extraction plugin
256
257 ImageMagick
258 exiftran
259 gphoto2
260 ufraw
261 exiv2
262 Additional command-line tools for various operations
263
264 libheif
265 For displaying HEIF images
266
267 libwebp
268 For displaying webp images
269
270 libdjvulibre
271 For displaying DjVu images
272
273 libopenjp2
274 For displaying JP2 images
275
276 yelp-tools
277 For creating the Help files
278
279### Code hackers:
280
281If you plan on making any major changes to the code that will be offered for
282inclusion to the main source, please contact us first - so that we can avoid
283duplication of effort.
284 The Geeqie Team
285
286### Known bugs:
287
288See the Geeqie Bug Tracker at <https://github.com/BestImageViewer/geeqie/issues>
289