README

   1       ###################################################################
   2       ##                          Geeqie 1.3                           ##
   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 TODO file.
 118
 119 ## Installation
 120
 121   Compilation: ./autogen.sh ; make
 122   General install: make install
 123   Removal: make uninstall
 124
 125 ## Description / Features
 126
 127   Geeqie is a graphics file viewer. Basic features:
 128
 129     - Single click image viewing / navigation.
 130     - Zoom functions.
 131     - Thumbnails, with optional caching and .xvpics support.
 132     - Multiple file selection for move, copy, delete, rename, drag and drop.
 133     - Drag and drop.
 134     - Slideshow.
 135     - Full screen.
 136     - Ability to open images in external editors (configurable).
 137     - Collections.
 138     - Comparison of images to find duplicates by name, size, date,
 139       dimensions, or image content similarity.
 140       - Rotation invariant detection
 141     - EXIF support.
 142     - support for stereoscopic images
 143       - input: side-by-side (JPS) and MPO format
 144       - output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)
 145
 146 ## Documentation (brief)                         [section:documentation]
 147
 148 This sections lists default hotkeys. Most of the hotkeys can be redefined in the
 149 Preferences dialog.
 150
 151   Keyboard commands:
 152     [PageDown], [Keypad PageDown]      next image
 153     [PageUp], [Keypad PageUp]          previous image
 154     [Home], [Keypad Home]              first image in list
 155     [End], [Keypad End]                last image in list
 156     [Tab]                              tab completion in path entry window
 157     [Escape]                           cancel completion in path entry window
 158
 159   Keyboard commands valid when image has focus (image has black rectangle)
 160     arrow keys, [Keypad arrows]        pan image
 161     [Shift] - arrow keys               pan image faster
 162     [Space]                            next image
 163     [Backspace] , B                    previous image
 164
 165   File menu related:
 166     [Ctrl] - N                         new window
 167     C                                  new empty collection
 168     O                                  open collection
 169     D                                  open a Find Duplicates window
 170     [Shift]- P                         open Print dialog
 171     [Ctrl] - F                         new folder
 172     [Ctrl] - C                         copy file
 173     [Ctrl] - M                         move file
 174     [Ctrl] - R                         rename file
 175     [Ctrl] - D, [Delete]               delete file
 176     [Ctrl] - W                         close window
 177     [Ctrl] - Q                         exit Geeqie
 178
 179   Edit menu related:
 180     1 .. 6                             toggle mark
 181     [Ctrl] - 1..6                      select mark
 182     [Ctrl] - A                         select all files
 183     [Ctrl] - [Shift] - A               unselect all files
 184     [Ctrl] - P                         display image properties window
 185     [Ctrl] - O                         configure Options
 186     ]                                  rotate image clockwise
 187     [                                  rotate image counterclockwise
 188     [Shift] - R                        rotate image 180 degrees
 189     [Shift] - M                        mirror image (horizontal)
 190     [Shift] - F                        flip image (vertical)
 191     [Shift] - G                        grayscale image
 192
 193   View menu related:
 194     +, =, [Keypad +]                   zoom in
 195     -, [Keypad -]                      zoom out
 196     Z, [Keypad /]                      zoom to original size
 197     X, [Keypad *]                      zoom to fit within window
 198     W                                  zoom to fit width of window
 199     H                                  zoom to fit height of window
 200     T                                  toggle thumbnails in list view
 201     [Ctrl] - L                         display files as list view
 202     [Ctrl] - I                         display files as icon view
 203     [Ctrl] - T                         toggle tree view of directories
 204     R                                  refresh list
 205     L                                  (Un)float file selection area
 206     [ctrl] - H                         (Un)hide file selection area
 207     [Ctrl] - K                         toggle sidebar with EXIF or keywords
 208     [Ctrl] - E                         show EXIF window
 209     [Ctrl] - S                         toggle sort manager sidebar
 210     F, V                               toggle full screen
 211     S                                  toggle slide show
 212     P                                  (Un)pause slideshow
 213     [Ctrl] - V                         display current image in new window
 214
 215   Collection windows:
 216
 217     arrows, [Keypad arrows]            move selection
 218     [Shift] + arrows                   select multiple images
 219     [Ctrl] + arrows                    move without changing selection
 220     [Space]                            select only image with focus
 221     [Ctrl] + [Space]                   toggle selection of image with focus
 222     [Home], [Keypad Home]              move focus to top of images
 223     [End], [Keypad End]                move focus to end of images
 224       (shift and ctrl work with Home, End, PageUp/Down as with arrows)
 225     [Ctrl] - A                         select all images
 226     [Ctrl] - [Shift] - A               unselect all images
 227
 228     [Delete], [Keypad Delete]          remove selected images from collection
 229                                        (does not delete file)
 230     [Ctrl] - L                         add images from main window file list
 231
 232     [Ctrl] - T                         toggle display of icon filename text
 233
 234     N                                  sort collection by name
 235     D                                  sort collection by date
 236     B                                  sort collection by size (bytes)
 237     P                                  sort collection by location (path)
 238     I (*)                              sort collection by name numerically
 239                                    (file1 file10 file2 -> file1 file2 file10)
 240
 241     [Enter], [Keypad Enter]            view image with focus in main window
 242     V                                  view image with focus in new window
 243
 244     S                                  save collection
 245     [Ctrl] - S                         save collection as...
 246     A                                  append to collection...
 247
 248     [Shift] - P                        print selected images...
 249
 250     [Ctrl] - C                         copy selected files...
 251     [Ctrl] - M                         move selected files...
 252     [Ctrl] - R                         rename selected files...
 253     [Ctrl] - D                         delete selected files
 254
 255     [Ctrl] - P                         display image properties window
 256
 257     [Ctrl] - W                         close window
 258
 259   Find Duplicates window:
 260
 261     [Ctrl] - A                         select all images
 262     [Ctrl] - [Shift] - A               unselect all images
 263     1                                  select group 1 duplicates
 264     2                                  select group 2 duplicates
 265
 266     [Ctrl] - L                         add images from main window file list
 267     C                                  add selected images to new collection
 268
 269     [Delete], [Keypad Delete]          remove selected images from list
 270     [Ctrl] - [Delete]                  clear window
 271
 272     [Enter], [Keypad Enter]            view image with focus in main window
 273     V                                  view image with focus in new window
 274     [Ctrl] - 1 .. 0                    open selected image(s) in editor
 275
 276     [Ctrl] - C                         copy selected files...
 277     [Ctrl] - M                         move selected files...
 278     [Ctrl] - R                         rename selected files...
 279     [Ctrl] - D                         delete selected files
 280
 281     [Ctrl] - P                         display image properties window
 282
 283     [Ctrl] - W                         close window
 284
 285   Pan View:
 286
 287     [Ctrl] - F, /                      show search bar
 288     [Ctrl] - G                         repeat previous search
 289
 290   (*) This is a compile time option enabled when strverscmp is found.
 291
 292   Mouse image control:
 293
 294     Button 1                           view next image
 295     Button 2                           view previous image
 296     Button 3                           context menu
 297
 298     Button 1 drag                      scroll/pan image
 299     Button 2 drag                      initiate drag and drop
 300
 301     Wheel up/down                      change to previous/next image
 302     Wheel up/down + [Shift]            scroll image up/down
 303     Wheel up/down + [Control]          zoom image in/out
 304
 305 ## Editor command macros                               [section:editors]
 306
 307 Editors are configured via standard desktop files.
 308
 309 ## Overlay Info                                        [section:overlay]
 310
 311 Overlay info format string syntax is: %tag[:max_length][:extra]%
 312
 313   %name%          Filename of the picture.
 314   %collection%    Name of the collection
 315   %number%        Current number of image in the list
 316   %total%         Total number of images
 317   %date%          File date
 318   %size%          File size
 319   %width%         Image width
 320   %height%        Image height
 321   %res%           Image resolution
 322   %keywords%      Image keywords from metadata
 323   %comment%       Image comment from metadata
 324   %lua/file.lua/% Lua functionality
 325
 326   To access exif data use the exif name:
 327   %Exif.Photo.DateTimeOriginal% Date of the original shot
 328
 329   Pre-formatted exif data is also available:
 330   formatted.Camera              Camera and sofware name
 331   formatted.DateTime            Image Date
 332   formatted.ShutterSpeed        Shutter speed in seconds (ie. 1/60s)
 333   formatted.Aperture            Aperture (ie. f5.6)
 334   formatted.ExposureBias        Exposure bias (ie. +0.3)
 335   formatted.ISOSpeedRating      ISO sensitivity (ie. 100)
 336   formatted.FocalLength         Focal length
 337   formatted.FocalLength35mmFilm Focal length 35mm
 338   formatted.SubjectDistance     Subject distance
 339   formatted.Flash               Flash
 340   formatted.Resolution          Resolution
 341   formatted.ColorProfile        Color profile
 342   formatted.GPSPosition         GPS position
 343   formatted.GPSAltitude         GPS altitude
 344
 345   You can limit the length of displayed data using :number notation:
 346   %formatted.Camera:20% will truncate the displayed data to 20 characters and
 347   will add 3 dots at the end to denote the truncation.
 348
 349   If two or more variables are connected with the |-sign, it prints available
 350   variables with a separator:
 351   %formatted.ShutterSpeed%|%formatted.ISOSpeedRating%|%formatted.FocalLength%
 352   could show:
 353     "1/20s - 400 - 80 mm"
 354   or
 355     "1/200 - 80 mm" if there's no ISO information in the Exif data.
 356
 357   If a line is empty, it is removed. This allows one to add lines that totally
 358   disappear when no data is available.
 359
 360   Extra string uses special character '*' to mark the position of the data. If
 361   no '*' is present, then extra string is just appended to data. Any "\n" is
 362   replaced by a newline on display. Pango mark up is accepted in left and right
 363   parts. If data is empty, nothing will be displayed.
 364
 365   Examples:
 366   "%name:<i>*</i>\n%" -> name is displayed in italics ended with a newline
 367   "%size:\n%"         -> size is displayed with a newline at end
 368   "%formatted.ISOSpeedRating:ISO *%"      -> ie. "ISO 100"
 369   "%collection: Collection <b>*</b>\n%" -> display collection name in bold prefixed by
 370                              "Collection " and a newline is appended
 371
 372 ## Credits                                             [section:credits]
 373
 374   Translations:
 375
 376      Grzegorz Kowal <g_kowal@poczta.onet.pl>
 377      Zbigniew Chyla <cyba@gnome.pl>
 378      Emil Nowak <emil5@go2.pl>
 379      Wit Wilinski <wit.wilinski@gmail.com>
 380      Tomasz Golinski <tomaszg@math.uwb.edu.pl>
 381          for Polish translation
 382
 383      Christopher R. Gabriel <cgabriel@pluto.linux.it>
 384      Di Maggio Salvatore <Salvatore.Dimaggio@bologna.marelli.it>
 385      Costantino <inverness1ATvirgilio.it>
 386          for Italian translation
 387
 388      Sandokan <cortex@nextra.sk>
 389      Ivan Priesol <priesol@iris-sk.sk>
 390      Mgr. Peter Tuharsky <tuharsky@misbb.sk>
 391          for Slovak translation
 392
 393      Rodrigo Sancho Senosiain <ruy_ikari@bigfoot.com>
 394      Ariel Fermani <the_end@bbs.frc.utn.edu.ar>
 395          for Spanish translation
 396
 397      Laurent Monin <i18n@norz.org>
 398      Eric Lassauge <lassauge@users.sf.net>
 399      Jean-Pierre Pedron <jppedron@club-internet.fr>
 400      Pascal Bleser <pascal.bleser@atosorigin.com>
 401      Nicolas Boos <nicolas.boos@wanadoo.fr>
 402      Nicolas Bonifas <nicolas_bonifas@users.sf.net>
 403          for French translation
 404
 405      Fâtih Demir <kabalak@gmx.net>
 406          for Turkish translation
 407
 408      Kam Tik <kamtik@hongkong.com>
 409      Abel Cheung <deaddog@deaddog.ws>
 410      S.J. Luo <crystal@mickey.ee.nctu.edu.tw>
 411      Levin <zjlevin@hotmail.com>
 412          for Traditional Chinese (Big5) translation
 413
 414      Junichi Uekawa <dancer@debian.org>
 415      Oleg Andrjushenko <oandr@itec.cn.ua>
 416      Michael Bravo <mbravo@tag-ltd.spb.ru>
 417      Sergey Pinaev <dfo@antex.ru>
 418          for Russian translation
 419
 420      Guilherme M. Schroeder <slump@ieg.com.br>
 421      Vitor Fernandes <vitor_fernandes@SoftHome.net>
 422      Herval Ribeiro de Azevêdo <heraze@gmail.com>
 423          for Brazilian Portuguese translation
 424
 425      Shingo Akagaki <akagaki@ece.numazu-ct.ac.jp>
 426      Yuuki Ninomiya <gm@debian.or.jp>
 427      Sato Satoru <ss@gnome.gr.jp>
 428      Takeshi AIHANA <aihana@gnome.gr.jp>
 429          for Japanese translation
 430
 431      Matthias Warkus <mawarkus@t-online.de>
 432      Thomas Klausner <wiz@danbala.ifoer.tuwien.ac.at>
 433      Danny Milosavljevic <danny_milo@yahoo.com>
 434      Ronny Steiner <Post@SIRSteiner.de>
 435      Klaus Ethgen <Klaus@Ethgen.de>
 436          for German translation
 437
 438      Matej Erman <matej.erman@guest.arnes.si>
 439          for Slovene translation
 440
 441      MÃtyÃs Tibor <templar@tempi.scene.hu>
 442      Koblinger Egmont <egmont@uhulinux.hu>
 443      Sári Gábor <saga@externet.hu>
 444          for Hungarian translation
 445
 446      Wu Yulun <migr@operamail.com>
 447      Charles Wang <charlesw1234cn@yahoo.com.cn>
 448          for simplified Chinese translation
 449
 450      H.J.Visser <H.J.Visser@harrie.mine.nu>
 451      Tino Meinen <a.t.meinen@chello.nl>
 452          for Dutch translation
 453
 454      Lauri Nurmi <lanurmi@iki.fi>
 455          for Finnish translation
 456
 457      Ilmar Kerm <ikerm@hot.ee>
 458          for Estonian translation
 459
 460      Volodymyr M. Lisivka <lvm@mystery.lviv.net>
 461          for Ukrainian translation
 462
 463      Birger Langkjer <birger.langkjer@image.dk>
 464          for Danish translation
 465
 466      Torgeir Ness Sundli <torgeir@mp3bil.no>
 467          for Norwegian translation
 468
 469      Jan Raska <jan.raska@tiscali.cz>
 470      Michal Bukovjan <bukm@centrum.cz>
 471          for Czech translation
 472
 473      Phanumas Thanyaboon <maskung@hotmail.com>
 474          for Thai translation
 475
 476      Harald Ersch <hersch@romatsa.ro>
 477          for Romanian translation
 478
 479      pclouds <pclouds@vnlinux.org>
 480          for Vietnamese translation
 481
 482      Tedi Heriyanto <tedi_h@gmx.net>
 483          for Indonesian translation
 484
 485      Vladimir Petrov <vladux@mail.bg>
 486          for Bulgarian translation
 487
 488      Hans Öfverbeck <hans.ofverbeck@home.se>
 489          for Swedish translation
 490
 491      Youssef Assad <youssef@devcabal.org>
 492          for Arabic translation
 493
 494      catux.org <mecatxis@ya.com>
 495          for Catalan translation
 496
 497      Hyun-Jin Moon <moonhyunjin@gmail.com
 498          for Korean translation
 499
 500      Pavel Piatruk <berserker@neolocation.com>
 501          for Belarusian translation
 502
 503      Piarres Beobide <pi@beobide.net>
 504          for Basque translation
 505
 506      Antonio C. Codazzi <f_sophia@libero.it>
 507          for Esperanto translation
 508
 509      Nikos Papadopoulos
 510          for Greek translation
 511
 512  Fixes, additions, and patches:
 513
 514      Eric Swalens
 515      Quy Tonthat
 516          for initial Exif support.
 517
 518      Daniel M. German <dmgerman at uvic.ca>
 519          for Canon raw image support.
 520
 521      Lars Ellenberg
 522          for Fujifilm raw image support.
 523
 524      Diederen Damien <D.Diederen@student.ulg.ac.be>
 525          for .xvpics thumbnail reading support.
 526
 527      Nick Rusnov <nick@grawk.net>
 528      Ryan Murray <rmurray@debian.org>
 529          for man page.
 530
 531      Martin Pool <mbp@samba.org>
 532          for sort by number, misc. improvements.
 533
 534      Jörg Mensmann <joerg.mensmann@gmx.de>
 535          for Xinerama support patch.
 536
 537      Vadim Shliakhov
 538          for miscellaneous fixes.
 539
 540      Uwe Ohse
 541          for Exif enhancements, histogram and other patches
 542
 543      Timo Horstschäfer
 544          for customizable fullscreen overlay
 545
 546      Michael Mokeev
 547          for print related enhancements
 548
 549      Carles Pina i Estany
 550          for copy path to clipboard patch
 551
 552      Kjell Morgenstern
 553          for random slide show speedup patch
 554
 555      And...
 556          Thanks to the users for finding Geeqie useful.