README.md

   1       ###################################################################
   2       ##                          Geeqie x.x                           ##
   3       ##                                                               ##
   4       ##              Copyright (C) 2008 - 2016 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 GQview author and the only maintainer. Geeqie projects goal is to move
  19 the development forward and also integrate the existing patches.
  20
  21 Geeqie is currently considered stable. Please report any crash or odd behavior
  22 to the [mailing list](https://lists.sourceforge.net/lists/listinfo/geeqie-devel)
  23 and/or to [Github](https://github.com/BestImageViewer/geeqie/issues)
  24
  25 For more info see: http://www.geeqie.org/
  26
  27 Please send any question or suggestions to geeqie-devel@lists.sourceforge.net or
  28 open an issue on Github (https://github.com/BestImageViewer/geeqie/issues)
  29
  30 # README contents:
  31
  32 * Requirements
  33 * Notes and changes for this release
  34 * Installation
  35 * Description / Features
  36 * Documentation (keyboard shortcuts)
  37 * Editor command macros
  38 * Additional comments
  39 * Translation status
  40 * Credits
  41
  42 ## Requirements
  43
  44 ### Required libraries:
  45     GTK+ 3.00
  46         www.gtk.org
  47         enabled by default
  48         disable with configure option: --disable-gtk3
  49     or
  50     GTK+ 2.20
  51         disabled by default when GTK+3 libraries are found.
  52         enable with configure option: --disable-gtk3
  53         optional items map display and GPU acceleration are not available
  54         with GTK2
  55
  56         Note: GTK+3 is still somehow experimental. It is needed for some
  57         features but we have several complains about the GTK+3 usability.
  58
  59         So if you need a stable version, you are advised to compile it
  60         with GTK+2. If you want to play with the cool new features, use
  61         GTK+3.
  62
  63 ### Optional libraries:
  64     lcms2 2.0
  65     or
  66     lcms 1.14
  67         www.littlecms.com
  68         for color management support
  69         enabled by default
  70         disable with configure option: --disable-lcms
  71
  72     exiv2 0.11
  73         www.exiv2.org
  74         for enhanced exif support
  75         enabled by default
  76         disable with configure option: --disable-exiv2
  77
  78     lirc
  79         www.lirc.org
  80         for remote control support
  81         enabled by default
  82         disable with configure option: --disable-lirc
  83
  84     libchamplain-gtk 0.12
  85     libchamplain 0.12
  86     libclutter 1.0
  87         wiki.gnome.org/Projects/libchamplain
  88         for map display
  89         disabled by default
  90         enable with configure option: --enable-map
  91         enabling will also enable GPU acceleration
  92
  93     libclutter 1.0
  94         www.clutter-project.org
  95         for GPU acceleration (a check-box on Preferences/Image must also be ticked)
  96         disabled by default
  97         enable with configure option: --enable-gpu-accel
  98         explicitly disabling will also disable the map feature
  99
 100     lua 5.1
 101         www.lua.org
 102         support for lua scripting
 103         enabled by default
 104         disable with configure option: --disable-lua
 105
 106 ## Notes and changes for this release            [section:release_notes]
 107
 108 See NEWS file.
 109
 110 ### Code hackers:
 111
 112 If you plan on making any major changes to the code that will be offered for
 113 inclusion to the main source, please contact us first - so that we can avoid
 114 duplication of effort.
 115                                                          The Geeqie Team
 116
 117 ### Known bugs:
 118
 119 See the Geeqie Bug Tracker at https://github.com/BestImageViewer/geeqie/issues
 120
 121 ## Installation
 122
 123 Compilation: `./autogen.sh ; make`
 124
 125 Show compile options: `./autogen.sh --help`
 126
 127 General install: `make install`
 128
 129 Removal: `make uninstall`
 130
 131 ## Description / Features
 132
 133 Geeqie is a graphics file viewer. Basic features:
 134
 135 * Single click image viewing / navigation.
 136 * Zoom functions.
 137 * Thumbnails, with optional caching and .xvpics support.
 138 * Multiple file selection for move, copy, delete, rename, drag and drop.
 139 * Drag and drop.
 140 * Slideshow.
 141 * Full screen.
 142 * Ability to open images in external editors (configurable).
 143 * Collections.
 144 * Comparison of images to find duplicates by name, size, date, dimensions, or image content similarity.
 145     * Rotation invariant detection
 146 * EXIF support.
 147 * support for stereoscopic images
 148     * input: side-by-side (JPS) and MPO format
 149     * output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)
 150
 151 ## Credits                                             [section:credits]
 152
 153 ### Translations:
 154
 155     Grzegorz Kowal <g_kowal@poczta.onet.pl>
 156     Zbigniew Chyla <cyba@gnome.pl>
 157     Emil Nowak <emil5@go2.pl>
 158     Wit Wilinski <wit.wilinski@gmail.com>
 159     Tomasz Golinski <tomaszg@math.uwb.edu.pl>
 160         for Polish translation
 161
 162     Christopher R. Gabriel <cgabriel@pluto.linux.it>
 163     Di Maggio Salvatore <Salvatore.Dimaggio@bologna.marelli.it>
 164     Costantino <inverness1ATvirgilio.it>
 165         for Italian translation
 166
 167     Sandokan <cortex@nextra.sk>
 168     Ivan Priesol <priesol@iris-sk.sk>
 169     Mgr. Peter Tuharsky <tuharsky@misbb.sk>
 170         for Slovak translation
 171
 172     Rodrigo Sancho Senosiain <ruy_ikari@bigfoot.com>
 173     Ariel Fermani <the_end@bbs.frc.utn.edu.ar>
 174         for Spanish translation
 175
 176     Laurent Monin <i18n@norz.org>
 177     Eric Lassauge <lassauge@users.sf.net>
 178     Jean-Pierre Pedron <jppedron@club-internet.fr>
 179     Pascal Bleser <pascal.bleser@atosorigin.com>
 180     Nicolas Boos <nicolas.boos@wanadoo.fr>
 181     Nicolas Bonifas <nicolas_bonifas@users.sf.net>
 182         for French translation
 183
 184     Fâtih Demir <kabalak@gmx.net>
 185         for Turkish translation
 186
 187     Kam Tik <kamtik@hongkong.com>
 188     Abel Cheung <deaddog@deaddog.ws>
 189     S.J. Luo <crystal@mickey.ee.nctu.edu.tw>
 190     Levin <zjlevin@hotmail.com>
 191         for Traditional Chinese (Big5) translation
 192
 193     Junichi Uekawa <dancer@debian.org>
 194     Oleg Andrjushenko <oandr@itec.cn.ua>
 195     Michael Bravo <mbravo@tag-ltd.spb.ru>
 196     Sergey Pinaev <dfo@antex.ru>
 197         for Russian translation
 198
 199     Guilherme M. Schroeder <slump@ieg.com.br>
 200     Vitor Fernandes <vitor_fernandes@SoftHome.net>
 201     Herval Ribeiro de Azevêdo <heraze@gmail.com>
 202         for Brazilian Portuguese translation
 203
 204     Shingo Akagaki <akagaki@ece.numazu-ct.ac.jp>
 205     Yuuki Ninomiya <gm@debian.or.jp>
 206     Sato Satoru <ss@gnome.gr.jp>
 207     Takeshi AIHANA <aihana@gnome.gr.jp>
 208         for Japanese translation
 209
 210     Matthias Warkus <mawarkus@t-online.de>
 211     Thomas Klausner <wiz@danbala.ifoer.tuwien.ac.at>
 212     Danny Milosavljevic <danny_milo@yahoo.com>
 213     Ronny Steiner <Post@SIRSteiner.de>
 214     Klaus Ethgen <Klaus@Ethgen.de>
 215         for German translation
 216
 217     Matej Erman <matej.erman@guest.arnes.si>
 218         for Slovene translation
 219
 220     MÃtyÃs Tibor <templar@tempi.scene.hu>
 221     Koblinger Egmont <egmont@uhulinux.hu>
 222     Sári Gábor <saga@externet.hu>
 223         for Hungarian translation
 224
 225     Wu Yulun <migr@operamail.com>
 226     Charles Wang <charlesw1234cn@yahoo.com.cn>
 227         for simplified Chinese translation
 228
 229     H.J.Visser <H.J.Visser@harrie.mine.nu>
 230     Tino Meinen <a.t.meinen@chello.nl>
 231         for Dutch translation
 232
 233     Lauri Nurmi <lanurmi@iki.fi>
 234         for Finnish translation
 235
 236     Ilmar Kerm <ikerm@hot.ee>
 237         for Estonian translation
 238
 239     Volodymyr M. Lisivka <lvm@mystery.lviv.net>
 240         for Ukrainian translation
 241
 242     Birger Langkjer <birger.langkjer@image.dk>
 243         for Danish translation
 244
 245     Torgeir Ness Sundli <torgeir@mp3bil.no>
 246         for Norwegian translation
 247
 248     Jan Raska <jan.raska@tiscali.cz>
 249     Michal Bukovjan <bukm@centrum.cz>
 250         for Czech translation
 251
 252     Phanumas Thanyaboon <maskung@hotmail.com>
 253         for Thai translation
 254
 255     Harald Ersch <hersch@romatsa.ro>
 256         for Romanian translation
 257
 258     pclouds <pclouds@vnlinux.org>
 259         for Vietnamese translation
 260
 261     Tedi Heriyanto <tedi_h@gmx.net>
 262         for Indonesian translation
 263
 264     Vladimir Petrov <vladux@mail.bg>
 265         for Bulgarian translation
 266
 267     Hans Öfverbeck <hans.ofverbeck@home.se>
 268         for Swedish translation
 269
 270     Youssef Assad <youssef@devcabal.org>
 271         for Arabic translation
 272
 273     catux.org <mecatxis@ya.com>
 274         for Catalan translation
 275
 276     Hyun-Jin Moon <moonhyunjin@gmail.com
 277         for Korean translation
 278
 279     Pavel Piatruk <berserker@neolocation.com>
 280         for Belarusian translation
 281
 282     Piarres Beobide <pi@beobide.net>
 283         for Basque translation
 284
 285     Antonio C. Codazzi <f_sophia@libero.it>
 286         for Esperanto translation
 287
 288     Nikos Papadopoulos
 289         for Greek translation
 290
 291 ### Fixes, additions, and patches:
 292
 293     Eric Swalens
 294     Quy Tonthat
 295         for initial Exif support.
 296
 297     Daniel M. German <dmgerman at uvic.ca>
 298         for Canon raw image support.
 299
 300     Lars Ellenberg
 301         for Fujifilm raw image support.
 302
 303     Diederen Damien <D.Diederen@student.ulg.ac.be>
 304         for .xvpics thumbnail reading support.
 305
 306     Nick Rusnov <nick@grawk.net>
 307     Ryan Murray <rmurray@debian.org>
 308         for man page.
 309
 310     Martin Pool <mbp@samba.org>
 311         for sort by number, misc. improvements.
 312
 313     Jörg Mensmann <joerg.mensmann@gmx.de>
 314         for Xinerama support patch.
 315
 316     Vadim Shliakhov
 317         for miscellaneous fixes.
 318
 319     Uwe Ohse
 320         for Exif enhancements, histogram and other patches
 321
 322     Timo Horstschäfer
 323         for customizable fullscreen overlay
 324
 325     Michael Mokeev
 326         for print related enhancements
 327
 328     Carles Pina i Estany
 329         for copy path to clipboard patch
 330
 331     Kjell Morgenstern
 332         for random slide show speedup patch
 333
 334     And...
 335         Thanks to the users for finding Geeqie useful.