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