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