Merge branch 'rot-invariant'
[geeqie.git] / 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
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 mailing list:
22 https://lists.sourceforge.net/lists/listinfo/geeqie-devel
23
24 For more info see:
25 http://www.geeqie.org/
26
27 Vladimir Nadvornik
28 Petr Ostadal
29 Klaus Ethgen
30
31 Please send any question or suggestions to
32 geeqie-devel@lists.sourceforge.net
33
34
35
36
37 ======== README contents:
38
39     * Requirements
40     * Notes and changes for this release
41     * Installation
42     * Description / Features
43     * Documentation (keyboard shortcuts)
44     * Editor command macros
45     * Additional comments
46     * Translation status
47     * Credits
48
49 ======== Requirements
50
51   Required libraries:
52     GTK+ 2.20: ftp://ftp.gtk.org/pub/gtk
53
54   Optional libraries:
55     lcms or lcms2, for color management support: http://www.littlecms.com
56         (disable with configure option: '--without-lcms')
57     exiv2, for enhanced exif support: http://www.exiv2.org/
58         (disable with configure option: '--without-exiv2')
59         - due to fast development, newer versions work significantly better
60         FIXME: minimal version ?
61     lirc, for remote control support: http://www.lirc.org/
62         (disable with configure option: '--disable-lirc')
63     libchamplain - experimental map support, dissabled by default
64         http://projects.gnome.org/libchamplain/
65         WARNING: this library has a lot of dependencise
66     lua - Support for lua scripting
67
68 ======== Notes and changes for this release            [section:release_notes]
69
70 See NEWS file.
71
72
73   Code hackers:
74
75     If you plan on making any major changes to the code that will be offered
76     for inclusion to the main source, please contact us first - so that we
77     can avoid duplication of effort.
78                                                          The Geeqie Team
79
80   Known bugs:
81
82     see the Geeqie Bug Tracker at TODO file.
83
84 ======== Installation
85
86   Compilation: ./configure ; make
87   General install: make install
88   Removal: make uninstall
89
90 ======== Description / Features
91
92   Geeqie is a graphics file viewer. Basic features:
93
94     - Single click image viewing / navigation.
95     - Zoom functions.
96     - Thumbnails, with optional caching and .xvpics support.
97     - Multiple file selection for move, copy, delete, rename, drag and drop.
98     - Drag and drop.
99     - Slideshow.
100     - Full screen.
101     - Ability to open images in external editors (configurable).
102     - Collections.
103     - Comparison of images to find duplicates by name, size, date,
104       dimensions, or image content similarity.
105     - EXIF support.
106
107   Geeqie 1.1:
108     - support for stereoscopic images
109       - input: side-by-side (JPS) and MPO format
110       - output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)
111
112 ======== Documentation (brief)                         [section:documentation]
113
114 This sections lists default hotkeys. Most of the hotkeys can be redefined
115 in the Preferences dialog.
116
117   Keyboard commands:
118     [PageDown], [Keypad PageDown]      next image
119     [PageUp], [Keypad PageUp]          previous image
120     [Home], [Keypad Home]              first image in list
121     [End], [Keypad End]                last image in list
122     [Tab]                              tab completion in path entry window
123     [Escape]                           cancel completion in path entry window
124
125   Keyboard commands valid when image has focus (image has black rectangle)
126     arrow keys, [Keypad arrows]        pan image
127     [Shift] - arrow keys               pan image faster
128     [Space]                            next image
129     [Backspace] , B                    previous image
130
131   File menu related:
132     [Ctrl] - N                         new window
133     C                                  new empty collection
134     O                                  open collection
135     D                                  open a Find Duplicates window
136     [Shift]- P                         open Print dialog
137     [Ctrl] - F                         new folder
138     [Ctrl] - C                         copy file
139     [Ctrl] - M                         move file
140     [Ctrl] - R                         rename file
141     [Ctrl] - D, [Delete]               delete file
142     [Ctrl] - W                         close window
143     [Ctrl] - Q                         exit Geeqie
144
145   Edit menu related:
146     1 .. 6                             toggle mark
147     [Ctrl] - 1..6                      select mark
148     [Ctrl] - A                         select all files
149     [Ctrl] - [Shift] - A               unselect all files
150     [Ctrl] - P                         display image properties window
151     [Ctrl] - O                         configure Options
152     ]                                  rotate image clockwise
153     [                                  rotate image counterclockwise
154     [Shift] - R                        rotate image 180 degrees
155     [Shift] - M                        mirror image (horizontal)
156     [Shift] - F                        flip image (vertical)
157     [Shift] - G                        grayscale image
158
159   View menu related:
160     +, =, [Keypad +]                   zoom in
161     -, [Keypad -]                      zoom out
162     Z, [Keypad /]                      zoom to original size
163     X, [Keypad *]                      zoom to fit within window
164     W                                  zoom to fit width of window
165     H                                  zoom to fit height of window
166     T                                  toggle thumbnails in list view
167     [Ctrl] - L                         display files as list view
168     [Ctrl] - I                         display files as icon view
169     [Ctrl] - T                         toggle tree view of directories
170     R                                  refresh list
171     L                                  (Un)float file selection area
172     [ctrl] - H                         (Un)hide file selection area
173     [Ctrl] - K                         toggle sidebar with EXIF or keywords
174     [Ctrl] - E                         show EXIF window
175     [Ctrl] - S                         toggle sort manager sidebar
176     F, V                               toggle full screen
177     S                                  toggle slide show
178     P                                  (Un)pause slideshow
179     [Ctrl] - V                         display current image in new window
180
181   Collection windows:
182
183     arrows, [Keypad arrows]            move selection
184     [Shift] + arrows                   select multiple images
185     [Ctrl] + arrows                    move without changing selection
186     [Space]                            select only image with focus
187     [Ctrl] + [Space]                   toggle selection of image with focus
188     [Home], [Keypad Home]              move focus to top of images
189     [End], [Keypad End]                move focus to end of images
190       (shift and ctrl work with Home, End, PageUp/Down as with arrows)
191     [Ctrl] - A                         select all images
192     [Ctrl] - [Shift] - A               unselect all images
193
194     [Delete], [Keypad Delete]          remove selected images from collection
195                                        (does not delete file)
196     [Ctrl] - L                         add images from main window file list
197
198     [Ctrl] - T                         toggle display of icon filename text
199
200     N                                  sort collection by name
201     D                                  sort collection by date
202     B                                  sort collection by size (bytes)
203     P                                  sort collection by location (path)
204     I (*)                              sort collection by name numerically
205                                    (file1 file10 file2 -> file1 file2 file10)
206
207     [Enter], [Keypad Enter]            view image with focus in main window
208     V                                  view image with focus in new window
209
210     S                                  save collection
211     [Ctrl] - S                         save collection as...
212     A                                  append to collection...
213
214     [Shift] - P                        print selected images...
215
216     [Ctrl] - C                         copy selected files...
217     [Ctrl] - M                         move selected files...
218     [Ctrl] - R                         rename selected files...
219     [Ctrl] - D                         delete selected files
220
221     [Ctrl] - P                         display image properties window
222
223     [Ctrl] - W                         close window
224
225   Find Duplicates window:
226
227     [Ctrl] - A                         select all images
228     [Ctrl] - [Shift] - A               unselect all images
229     1                                  select group 1 duplicates
230     2                                  select group 2 duplicates
231
232     [Ctrl] - L                         add images from main window file list
233     C                                  add selected images to new collection
234
235     [Delete], [Keypad Delete]          remove selected images from list
236     [Ctrl] - [Delete]                  clear window
237
238     [Enter], [Keypad Enter]            view image with focus in main window
239     V                                  view image with focus in new window
240     [Ctrl] - 1 .. 0                    open selected image(s) in editor
241
242     [Ctrl] - C                         copy selected files...
243     [Ctrl] - M                         move selected files...
244     [Ctrl] - R                         rename selected files...
245     [Ctrl] - D                         delete selected files
246
247     [Ctrl] - P                         display image properties window
248
249     [Ctrl] - W                         close window
250
251   Pan View:
252
253     [Ctrl] - F, /                      show search bar
254     [Ctrl] - G                         repeat previous search
255
256   (*) This is a compile time option enabled when strverscmp is found.
257
258   Mouse image control:
259
260     Button 1                           view next image
261     Button 2                           view previous image
262     Button 3                           context menu
263
264     Button 1 drag                      scroll/pan image
265     Button 2 drag                      initiate drag and drop
266
267     Wheel up/down                      change to previous/next image
268     Wheel up/down + [Shift]            scroll image up/down
269     Wheel up/down + [Control]          zoom image in/out
270
271
272 ======== Editor command macros                               [section:editors]
273
274 Editors are configured via standard desktop files.
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