README.md

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