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