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