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, 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 as a package with some distributions, however Geeqie is stable and you may compile the latest version from sources.
 107
 108 There are two scripts which will download and compile the sources for you.
 109
 110 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.
 111 To get the script, from the command line type:<br/><br/>
 112 `wget https://raw.githubusercontent.com/pixlsus/Scripts/master/build-geeqie`
 113
 114 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.
 115 To get the script, from the command line type:<br/><br/>
 116 `wget https://raw.githubusercontent.com/BestImageViewer/geeqie/master/web/geeqie-install-debian.sh`
 117
 118
 119 If you wish to compile the sources yourself you may download the latest version (if you have installed git) from here:
 120
 121 Either: `git clone git://www.geeqie.org/geeqie.git`
 122
 123 Or: `git clone http://www.geeqie.org/git/geeqie.git`
 124
 125 Also [Geeqie is available as a flatpak](https://flathub.org/apps/details/org.geeqie.Geeqie) from the [Flathub site](https://flathub.org/home).
 126
 127 ## Manual Installation
 128
 129 List compile options: `./autogen.sh --help`
 130
 131 Common options:
 132 `./autogen.sh --disable-gtk3`,
 133
 134 Compilation: `./autogen.sh [options]; make -j<no. of cpu cores> `
 135
 136 Install: `[sudo] make install`
 137
 138 Removal: `[sudo] make uninstall`
 139
 140 #### Note:
 141 The zip and gzip files at geeqie.org and GitHub contain only the sources - they cannot, by themselves, be used to install Geeqie.
 142
 143 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.
 144
 145 However if you leave the folder intact, whenever new features or patches are available, execute:
 146
 147 `git pull; sudo make uninstall; sudo make maintainer-clean; ./autogen.sh; make -j<no. of cpu cores>; sudo make install`
 148
 149 Only the changed sources are downloaded, which makes this a quick operation.
 150
 151 Your configuration file, history file and desktop files are not affected by this process.
 152
 153
 154
 155 ## Notes and changes for the latest release
 156
 157 See the NEWS file in the installation folder, or [Geeqie News at GitHub](https://github.com/BestImageViewer/geeqie/blob/master/NEWS)
 158
 159 And either the ChangeLog file or [Geeqie ChangeLog](http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git;a=shortlog)
 160
 161
 162 ## Requirements
 163
 164 ### Required libraries:
 165     GTK+ 3.00
 166         www.gtk.org
 167         enabled by default
 168         disable with configure option: --disable-gtk3
 169     or
 170     GTK+ 2.20
 171         disabled by default when GTK+3 libraries are found.
 172         enable with configure option: --disable-gtk3
 173         optional items map display and GPU acceleration are not available
 174         with GTK2
 175
 176         Both GTK2 and GTK3 versions have been in use for several
 177         years, and both may be considered stable.
 178
 179 ### Optional libraries:
 180     lcms2 2.0
 181     or
 182     lcms 1.14
 183         www.littlecms.com
 184         for color management support
 185         enabled by default
 186         disable with configure option: --disable-lcms
 187
 188     exiv2 0.11
 189         www.exiv2.org
 190         for enhanced exif support
 191         enabled by default
 192         disable with configure option: --disable-exiv2
 193
 194     lirc
 195         www.lirc.org
 196         for remote control support
 197         enabled by default
 198         disable with configure option: --disable-lirc
 199
 200     libchamplain-gtk 0.12
 201     libchamplain 0.12
 202     libclutter 1.0
 203         wiki.gnome.org/Projects/libchamplain
 204         for map display
 205         enabled by default
 206         disable with configure option: --disable-map
 207
 208     libclutter 1.0
 209         www.clutter-project.org
 210         for GPU acceleration (a check-box on Preferences/Image must also be ticked)
 211         enabled by default
 212         disable with configure option: --disable-gpu-accel
 213         explicitly disabling will also disable the map feature
 214
 215     lua 5.1
 216         www.lua.org
 217         support for lua scripting
 218         enabled by default
 219         disable with configure option: --disable-lua
 220
 221     librsvg2-common
 222         for displaying .svg images
 223
 224     libwmf0.2-7-gtk
 225         for displaying .wmf images
 226
 227     (see also "Additional pixbuf loaders" in the References section of the Help file)
 228
 229     awk
 230         when running Geeqie, to use the geo-decode function
 231
 232     markdown
 233         when compiling Geeqie, to create this file in html format
 234
 235     libffmpegthumbnailer 2.1.0
 236         https://github.com/dirkvdb/ffmpegthumbnailer
 237         for thumbnailing camera video clips
 238         disable with configure option: --disable-ffmpegthumbnailer
 239
 240     libpoppler-glib-dev 0.62
 241         for displaying pdf files
 242         disable with configure option: --disable-pdf
 243
 244     libimage-exiftool-perl
 245         For the jpeg extraction plugin
 246
 247     liblcms2-utils
 248         For the command-line tool jpgicc, used by the jpeg extraction plugin
 249
 250      ImageMagick
 251      exiftran
 252      gphoto2
 253      ufraw
 254      exiv2
 255         Additional command-line tools for various operations
 256
 257     libheif
 258         For displaying HEIF images
 259
 260     libwebp
 261         For displaying webp images
 262
 263     libdjvulibre
 264         For displaying DjVu images
 265
 266     libopenjp2
 267         For displaying JP2 images
 268
 269     yelp-tools
 270         For creating the Help files
 271
 272 ### Code hackers:
 273
 274 If you plan on making any major changes to the code that will be offered for
 275 inclusion to the main source, please contact us first - so that we can avoid
 276 duplication of effort.
 277                                                          The Geeqie Team
 278
 279 ### Known bugs:
 280
 281 See the Geeqie Bug Tracker at <https://github.com/BestImageViewer/geeqie/issues>