README.md

   1       ###################################################################
   2       ##                          Geeqie x.x                           ##
   3       ##                                                               ##
   4       ##              Copyright (C) 2008 - 2017 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. 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.
 104
 105 The source tar of the latest formal release may be downloaded: <http://geeqie.org/geeqie-1.3.tar.xz>
 106
 107 However Geeqie is stable, and you may download the latest version (if you have installed git) from here:
 108
 109 Either: `git clone git://www.geeqie.org/geeqie.git`
 110
 111 Or: `git clone http://www.geeqie.org/git/geeqie.git`
 112
 113
 114 ## Installation
 115
 116 List compile options: `./autogen.sh --help`
 117
 118 Common options:
 119 `./autogen.sh --disable-gtk3`,
 120
 121 Compilation: `./autogen.sh [options]; make -j<no. of cpu cores> `
 122
 123 Install: `[sudo] make install`
 124
 125 Removal: `[sudo] make uninstall`
 126
 127 #### Note:
 128 The zip and gzip files at geeqie.org and GitHub contain only the sources - they cannot, by themselves, be used to install Geeqie.
 129
 130 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.
 131
 132 However if you leave the folder intact, whenever new features or patches are available, execute:
 133
 134 `git pull; sudo make uninstall; sudo make maintainer-clean; ./autogen.sh; make -j<no. of cpu cores>; sudo make install`
 135
 136 Only the changed sources are downloaded, which makes this a quick operation.
 137
 138 Your configuration file, history file and desktop files are not affected by this process.
 139
 140
 141
 142 ## Notes and changes for the latest release
 143
 144 See the NEWS file in the installation folder, or [Geeqie News at GitHub](https://github.com/BestImageViewer/geeqie/blob/master/NEWS)
 145
 146 And either the ChangeLog file or [Geeqie ChangeLog](http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git;a=shortlog)
 147
 148
 149 ## Requirements
 150
 151 ### Required libraries:
 152     GTK+ 3.00
 153         www.gtk.org
 154         enabled by default
 155         disable with configure option: --disable-gtk3
 156     or
 157     GTK+ 2.20
 158         disabled by default when GTK+3 libraries are found.
 159         enable with configure option: --disable-gtk3
 160         optional items map display and GPU acceleration are not available
 161         with GTK2
 162
 163         Note: GTK+3 is still somehow experimental. It is needed for some
 164         features but we have several complains about the GTK+3 usability.
 165
 166         So if you need a stable version, you are advised to compile it
 167         with GTK+2. If you want to play with the cool new features, use
 168         GTK+3.
 169
 170 ### Optional libraries:
 171     lcms2 2.0
 172     or
 173     lcms 1.14
 174         www.littlecms.com
 175         for color management support
 176         enabled by default
 177         disable with configure option: --disable-lcms
 178
 179     exiv2 0.11
 180         www.exiv2.org
 181         for enhanced exif support
 182         enabled by default
 183         disable with configure option: --disable-exiv2
 184
 185     lirc
 186         www.lirc.org
 187         for remote control support
 188         enabled by default
 189         disable with configure option: --disable-lirc
 190
 191     libchamplain-gtk 0.12
 192     libchamplain 0.12
 193     libclutter 1.0
 194         wiki.gnome.org/Projects/libchamplain
 195         for map display
 196         enabled by default
 197         disable with configure option: --disable-map
 198
 199     libclutter 1.0
 200         www.clutter-project.org
 201         for GPU acceleration (a check-box on Preferences/Image must also be ticked)
 202         enabled by default
 203         disable with configure option: --disable-gpu-accel
 204         explicitly disabling will also disable the map feature
 205
 206     lua 5.1
 207         www.lua.org
 208         support for lua scripting
 209         enabled by default
 210         disable with configure option: --disable-lua
 211
 212     librsvg2-common
 213         for displaying .svg images
 214
 215     libwmf0.2-7-gtk
 216         for displaying .wmf images
 217
 218     (see also "Additional pixbuf loaders" in the References section of the Help file)
 219
 220     awk
 221         when running Geeqie, to use the geo-decode function
 222
 223     markdown
 224         when compiling Geeqie, to create this file in html format
 225
 226     libffmpegthumbnailer 2.1.0
 227         https://github.com/dirkvdb/ffmpegthumbnailer
 228         for thumbnailing camera video clips
 229         disable with configure option: --disable-ffmpegthumbnailer
 230
 231     libpoppler-glib-dev 0.62
 232         for displaying pdf files
 233         disable with configure option: --disable-pdf
 234
 235 ### Code hackers:
 236
 237 If you plan on making any major changes to the code that will be offered for
 238 inclusion to the main source, please contact us first - so that we can avoid
 239 duplication of effort.
 240                                                          The Geeqie Team
 241
 242 ### Known bugs:
 243
 244 See the Geeqie Bug Tracker at <https://github.com/BestImageViewer/geeqie/issues>