README.md

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