README

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