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