README

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