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