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 Show compile options: ./autogen.sh --help
 125 General install: make install
 126 Removal: make uninstall
 127
 128 ## Description / Features
 129
 130 Geeqie is a graphics file viewer. Basic features:
 131
 132 * Single click image viewing / navigation.
 133 * Zoom functions.
 134 * Thumbnails, with optional caching and .xvpics support.
 135 * Multiple file selection for move, copy, delete, rename, drag and drop.
 136 * Drag and drop.
 137 * Slideshow.
 138 * Full screen.
 139 * Ability to open images in external editors (configurable).
 140 * Collections.
 141 * Comparison of images to find duplicates by name, size, date, dimensions, or image content similarity.
 142     * Rotation invariant detection
 143 * EXIF support.
 144 * support for stereoscopic images
 145     * input: side-by-side (JPS) and MPO format
 146     * output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)
 147
 148 ## Credits                                             [section:credits]
 149
 150   Translations:
 151
 152      Grzegorz Kowal <g_kowal@poczta.onet.pl>
 153      Zbigniew Chyla <cyba@gnome.pl>
 154      Emil Nowak <emil5@go2.pl>
 155      Wit Wilinski <wit.wilinski@gmail.com>
 156      Tomasz Golinski <tomaszg@math.uwb.edu.pl>
 157          for Polish translation
 158
 159      Christopher R. Gabriel <cgabriel@pluto.linux.it>
 160      Di Maggio Salvatore <Salvatore.Dimaggio@bologna.marelli.it>
 161      Costantino <inverness1ATvirgilio.it>
 162          for Italian translation
 163
 164      Sandokan <cortex@nextra.sk>
 165      Ivan Priesol <priesol@iris-sk.sk>
 166      Mgr. Peter Tuharsky <tuharsky@misbb.sk>
 167          for Slovak translation
 168
 169      Rodrigo Sancho Senosiain <ruy_ikari@bigfoot.com>
 170      Ariel Fermani <the_end@bbs.frc.utn.edu.ar>
 171          for Spanish translation
 172
 173      Laurent Monin <i18n@norz.org>
 174      Eric Lassauge <lassauge@users.sf.net>
 175      Jean-Pierre Pedron <jppedron@club-internet.fr>
 176      Pascal Bleser <pascal.bleser@atosorigin.com>
 177      Nicolas Boos <nicolas.boos@wanadoo.fr>
 178      Nicolas Bonifas <nicolas_bonifas@users.sf.net>
 179          for French translation
 180
 181      Fâtih Demir <kabalak@gmx.net>
 182          for Turkish translation
 183
 184      Kam Tik <kamtik@hongkong.com>
 185      Abel Cheung <deaddog@deaddog.ws>
 186      S.J. Luo <crystal@mickey.ee.nctu.edu.tw>
 187      Levin <zjlevin@hotmail.com>
 188          for Traditional Chinese (Big5) translation
 189
 190      Junichi Uekawa <dancer@debian.org>
 191      Oleg Andrjushenko <oandr@itec.cn.ua>
 192      Michael Bravo <mbravo@tag-ltd.spb.ru>
 193      Sergey Pinaev <dfo@antex.ru>
 194          for Russian translation
 195
 196      Guilherme M. Schroeder <slump@ieg.com.br>
 197      Vitor Fernandes <vitor_fernandes@SoftHome.net>
 198      Herval Ribeiro de Azevêdo <heraze@gmail.com>
 199          for Brazilian Portuguese translation
 200
 201      Shingo Akagaki <akagaki@ece.numazu-ct.ac.jp>
 202      Yuuki Ninomiya <gm@debian.or.jp>
 203      Sato Satoru <ss@gnome.gr.jp>
 204      Takeshi AIHANA <aihana@gnome.gr.jp>
 205          for Japanese translation
 206
 207      Matthias Warkus <mawarkus@t-online.de>
 208      Thomas Klausner <wiz@danbala.ifoer.tuwien.ac.at>
 209      Danny Milosavljevic <danny_milo@yahoo.com>
 210      Ronny Steiner <Post@SIRSteiner.de>
 211      Klaus Ethgen <Klaus@Ethgen.de>
 212          for German translation
 213
 214      Matej Erman <matej.erman@guest.arnes.si>
 215          for Slovene translation
 216
 217      MÃtyÃs Tibor <templar@tempi.scene.hu>
 218      Koblinger Egmont <egmont@uhulinux.hu>
 219      Sári Gábor <saga@externet.hu>
 220          for Hungarian translation
 221
 222      Wu Yulun <migr@operamail.com>
 223      Charles Wang <charlesw1234cn@yahoo.com.cn>
 224          for simplified Chinese translation
 225
 226      H.J.Visser <H.J.Visser@harrie.mine.nu>
 227      Tino Meinen <a.t.meinen@chello.nl>
 228          for Dutch translation
 229
 230      Lauri Nurmi <lanurmi@iki.fi>
 231          for Finnish translation
 232
 233      Ilmar Kerm <ikerm@hot.ee>
 234          for Estonian translation
 235
 236      Volodymyr M. Lisivka <lvm@mystery.lviv.net>
 237          for Ukrainian translation
 238
 239      Birger Langkjer <birger.langkjer@image.dk>
 240          for Danish translation
 241
 242      Torgeir Ness Sundli <torgeir@mp3bil.no>
 243          for Norwegian translation
 244
 245      Jan Raska <jan.raska@tiscali.cz>
 246      Michal Bukovjan <bukm@centrum.cz>
 247          for Czech translation
 248
 249      Phanumas Thanyaboon <maskung@hotmail.com>
 250          for Thai translation
 251
 252      Harald Ersch <hersch@romatsa.ro>
 253          for Romanian translation
 254
 255      pclouds <pclouds@vnlinux.org>
 256          for Vietnamese translation
 257
 258      Tedi Heriyanto <tedi_h@gmx.net>
 259          for Indonesian translation
 260
 261      Vladimir Petrov <vladux@mail.bg>
 262          for Bulgarian translation
 263
 264      Hans Öfverbeck <hans.ofverbeck@home.se>
 265          for Swedish translation
 266
 267      Youssef Assad <youssef@devcabal.org>
 268          for Arabic translation
 269
 270      catux.org <mecatxis@ya.com>
 271          for Catalan translation
 272
 273      Hyun-Jin Moon <moonhyunjin@gmail.com
 274          for Korean translation
 275
 276      Pavel Piatruk <berserker@neolocation.com>
 277          for Belarusian translation
 278
 279      Piarres Beobide <pi@beobide.net>
 280          for Basque translation
 281
 282      Antonio C. Codazzi <f_sophia@libero.it>
 283          for Esperanto translation
 284
 285      Nikos Papadopoulos
 286          for Greek translation
 287
 288  Fixes, additions, and patches:
 289
 290      Eric Swalens
 291      Quy Tonthat
 292          for initial Exif support.
 293
 294      Daniel M. German <dmgerman at uvic.ca>
 295          for Canon raw image support.
 296
 297      Lars Ellenberg
 298          for Fujifilm raw image support.
 299
 300      Diederen Damien <D.Diederen@student.ulg.ac.be>
 301          for .xvpics thumbnail reading support.
 302
 303      Nick Rusnov <nick@grawk.net>
 304      Ryan Murray <rmurray@debian.org>
 305          for man page.
 306
 307      Martin Pool <mbp@samba.org>
 308          for sort by number, misc. improvements.
 309
 310      Jörg Mensmann <joerg.mensmann@gmx.de>
 311          for Xinerama support patch.
 312
 313      Vadim Shliakhov
 314          for miscellaneous fixes.
 315
 316      Uwe Ohse
 317          for Exif enhancements, histogram and other patches
 318
 319      Timo Horstschäfer
 320          for customizable fullscreen overlay
 321
 322      Michael Mokeev
 323          for print related enhancements
 324
 325      Carles Pina i Estany
 326          for copy path to clipboard patch
 327
 328      Kjell Morgenstern
 329          for random slide show speedup patch
 330
 331      And...
 332          Thanks to the users for finding Geeqie useful.