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