README.md

   1
   2 ##PLEASE NOTE!
   3 The repository at GitHub is not the main repository, and is likely to be out-of-date.
   4 If you wish to clone the source code, please use the repository at [geeqie.org](http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git).
   5 Details are given in the [Downloading](#downloading) section below.
   6 ###########################################################################
   7
   8       ###################################################################
   9       ##                          Geeqie x.x                           ##
  10       ##                                                               ##
  11       ##              Copyright (C) 2008 - 2018 The Geeqie Team        ##
  12       ##              Copyright (C) 1999 - 2006 John Ellis.            ##
  13       ##                                                               ##
  14       ##                      Use at your own risk!                    ##
  15       ##                                                               ##
  16       ##  This software released under the GNU General Public License. ##
  17       ##       Please read the COPYING file for more information.      ##
  18       ###################################################################
  19
  20 This is Geeqie, a successor of GQview.
  21
  22 [![Build Status](https://api.travis-ci.org/BestImageViewer/geeqie.svg?branch=master)](https://travis-ci.org/BestImageViewer/geeqie)
  23
  24 Geeqie has been forked from GQview project, because it was not possible to
  25 contact the GQview author and only maintainer.
  26
  27 The Geeqie project will continue the development forward and maintain the existing code.
  28
  29 Geeqie is currently considered stable.
  30
  31 Please send any questions, problems or suggestions to the [mailing list](mailto:geeqie@freelists.org) or
  32 open an issue on [Geeqie at GitHub](https://github.com/BestImageViewer/geeqie/issues).
  33
  34 Subscribe to the mailing list [here](https://www.freelists.org/list/geeqie).
  35
  36 The project website is <http://www.geeqie.org/> and you will find the latest sources in the
  37 [Geeqie repository](http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git).
  38
  39 # README contents:
  40
  41 * Description / Features
  42 * Downloading
  43 * Installation
  44 * Notes and changes for this release
  45 * Requirements
  46
  47
  48 ## Description / Features
  49
  50 Geeqie is a graphics file viewer. Basic features:
  51
  52
  53 * Single click image viewing / navigation.
  54
  55 * Zoom functions.
  56
  57 * Thumbnails, with optional caching and .xvpics support.
  58
  59 * Multiple file selection for move, copy, delete, rename, drag and drop.
  60
  61 * Thumbnail preview of the destination for move, copy and rename functions.
  62
  63 * On-the-fly renaming for move and copy functions, with formatted and auto-rename features.
  64
  65 * File grouping (an image having jpeg, RAW and xmp files will appear as a single entity).
  66
  67 * Selectable exif auto-rotation of images.
  68
  69
  70 * Single click file copy or move to pre-defined folders - with undo feature.
  71 * Drag and drop.
  72
  73 * Collections.
  74
  75 * support for stereoscopic images
  76     * input: side-by-side (JPS) and MPO format
  77     * output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)
  78
  79 *   Viewing raster and vector images, in the following formats:
  80 3FR, 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.
  81
  82 * Preview and thumbnails of video clips can be displayed. Clips can be run via a defined external program.
  83
  84 * 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.
  85
  86 * Pan(orama) view displays image thumbnails in calendar, grid, folder and other layouts.
  87 * All available metadata and Exif/IPTC/XMP data can be displayed, as well as colour histograms and assigned tags, keywords and comments.
  88
  89 * Selectable image overlay display box - can contain any text or meta-data.
  90
  91 * Panels can be docked or floating.
  92
  93 * 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.
  94
  95 * 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.
  96
  97 * 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.
  98
  99 * Geeqie supports applying the colour profile embedded in an image along with the system monitor profile (or a user-specified monitor profile).
 100
 101 * Geeqie sessions can be remotely controlled from external software, so it can be used as an image-viewer component of a bigger application.
 102
 103 * 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.
 104 * Images may be given a rating value (also known as a "star rating").
 105
 106 * 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.
 107
 108 # <a name="downloading"></a>
 109 ## Downloading
 110
 111 Geeqie is available as a package with some distributions, however Geeqie is stable and you may compile the latest version from sources.
 112
 113 There are two scripts which will download and compile the sources for you.
 114
 115 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.
 116 To get the script, from the command line type:<br/><br/>
 117 `wget https://raw.githubusercontent.com/pixlsus/Scripts/master/build-geeqie`
 118
 119 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.
 120 To get the script, from the command line type:<br/><br/>
 121 `wget https://raw.githubusercontent.com/BestImageViewer/geeqie/master/web/geeqie-install-debian.sh`
 122
 123
 124 If you wish to compile the sources yourself you may download the latest version (if you have installed git) from here:
 125
 126 Either: `git clone git://www.geeqie.org/geeqie.git`
 127
 128 Or: `git clone http://www.geeqie.org/git/geeqie.git`
 129
 130 ## Manual Installation
 131
 132 List compile options: `./autogen.sh --help`
 133
 134 Common options:
 135 `./autogen.sh --disable-gtk3`,
 136
 137 Compilation: `./autogen.sh [options]; make -j<no. of cpu cores> `
 138
 139 Install: `[sudo] make install`
 140
 141 Removal: `[sudo] make uninstall`
 142
 143 #### Note:
 144 The zip and gzip files at geeqie.org and GitHub contain only the sources - they cannot, by themselves, be used to install Geeqie.
 145
 146 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.
 147
 148 However if you leave the folder intact, whenever new features or patches are available, execute:
 149
 150 `git pull; sudo make uninstall; sudo make maintainer-clean; ./autogen.sh; make -j<no. of cpu cores>; sudo make install`
 151
 152 Only the changed sources are downloaded, which makes this a quick operation.
 153
 154 Your configuration file, history file and desktop files are not affected by this process.
 155
 156
 157
 158 ## Notes and changes for the latest release
 159
 160 See the NEWS file in the installation folder, or [Geeqie News at GitHub](https://github.com/BestImageViewer/geeqie/blob/master/NEWS)
 161
 162 And either the ChangeLog file or [Geeqie ChangeLog](http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git;a=shortlog)
 163
 164
 165 ## Requirements
 166
 167 ### Required libraries:
 168     GTK+ 3.00
 169         www.gtk.org
 170         enabled by default
 171         disable with configure option: --disable-gtk3
 172     or
 173     GTK+ 2.20
 174         disabled by default when GTK+3 libraries are found.
 175         enable with configure option: --disable-gtk3
 176         optional items map display and GPU acceleration are not available
 177         with GTK2
 178
 179         Note: GTK+3 is still somehow experimental. It is needed for some
 180         features but we have several complains about the GTK+3 usability.
 181
 182         So if you need a stable version, you are advised to compile it
 183         with GTK+2. If you want to play with the cool new features, use
 184         GTK+3.
 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
 281 If you plan on making any major changes to the code that will be offered for
 282 inclusion to the main source, please contact us first - so that we can avoid
 283 duplication of effort.
 284                                                          The Geeqie Team
 285
 286 ### Known bugs:
 287
 288 See the Geeqie Bug Tracker at <https://github.com/BestImageViewer/geeqie/issues>