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