Updating README
[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 bugtracker:
22 https://sourceforge.net/tracker/?group_id=222125&atid=1054680
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 http://geeqie.wiki.sourceforge.net/new_features
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, see
275 https://sourceforge.net/apps/trac/geeqie/wiki/GuideEditorsConfig
276
277
278 ======== Overlay Info                                        [section:overlay]
279
280 Overlay info format string syntax is: %tag[:max_length][:extra]%
281
282   %name%       Filename of the picture.
283   %collection% Name of the collection
284   %number%     Current number of image in the list
285   %total%      Total number of images
286   %date%       File date
287   %size%       File size
288   %width%      Image width
289   %height%     Image height
290   %res%        Image resolution
291   %keywords%   Image keywords from metadata
292   %comment%    Image comment from metadata
293
294   To access exif data use the exif name:
295   %Exif.Photo.DateTimeOriginal% Date of the original shot
296
297   Pre-formatted exif data is also available:
298   formatted.Camera              Camera and sofware name
299   formatted.DateTime            Image Date
300   formatted.ShutterSpeed        Shutter speed in seconds (ie. 1/60s)
301   formatted.Aperture            Aperture (ie. f5.6)
302   formatted.ExposureBias        Exposure bias (ie. +0.3)
303   formatted.ISOSpeedRating      ISO sensitivity (ie. 100)
304   formatted.FocalLength         Focal length
305   formatted.FocalLength35mmFilm Focal length 35mm
306   formatted.SubjectDistance     Subject distance
307   formatted.Flash               Flash
308   formatted.Resolution          Resolution
309   formatted.ColorProfile        Color profile
310   formatted.GPSPosition         GPS position
311   formatted.GPSAltitude         GPS altitude
312
313   You can limit the length of displayed data using :number notation:
314   %formatted.Camera:20% will truncate the displayed data to 20 characters
315   and will add 3 dots at the end to denote the truncation.
316
317   If two or more variables are connected with the |-sign, it prints available
318   variables with a separator:
319   %formatted.ShutterSpeed%|%formatted.ISOSpeedRating%|%formatted.FocalLength%
320   could show:
321     "1/20s - 400 - 80 mm"
322   or
323     "1/200 - 80 mm" if there's no ISO information in the Exif data.
324
325   If a line is empty, it is removed.
326   This allows one to add lines that totally disappear when no data is available.
327
328   Extra string uses special character '*' to mark the position of the data.
329   If no '*' is present, then extra string is just appended to data.
330   Any "\n" is replaced by a newline on display.
331   Pango mark up is accepted in left and right parts.
332   If data is empty, nothing will be displayed.
333
334   Examples:
335   "%name:<i>*</i>\n%" -> name is displayed in italics ended with a newline
336   "%size:\n%"         -> size is displayed with a newline at end
337   "%formatted.ISOSpeedRating:ISO *%"      -> ie. "ISO 100"
338   "%collection: Collection <b>*</b>\n%" -> display collection name in bold prefixed by
339                              "Collection " and a newline is appended
340
341
342 ======== Credits                                             [section:credits]
343
344
345   Translations:
346
347      Grzegorz Kowal <g_kowal@poczta.onet.pl>
348      Zbigniew Chyla <cyba@gnome.pl>
349      Emil Nowak <emil5@go2.pl>
350      Wit Wilinski <wit.wilinski@gmail.com>
351          for Polish translation
352
353      Christopher R. Gabriel <cgabriel@pluto.linux.it>
354      Di Maggio Salvatore <Salvatore.Dimaggio@bologna.marelli.it>
355      Costantino <inverness1ATvirgilio.it>
356          for Italian translation
357
358      Sandokan <cortex@nextra.sk>
359      Ivan Priesol <priesol@iris-sk.sk>
360      Mgr. Peter Tuharsky <tuharsky@misbb.sk>
361          for Slovak translation
362
363      Rodrigo Sancho Senosiain <ruy_ikari@bigfoot.com>
364      Ariel Fermani <the_end@bbs.frc.utn.edu.ar>
365          for Spanish translation
366
367      Laurent Monin <i18n@norz.org>
368      Eric Lassauge <lassauge@users.sf.net>
369      Jean-Pierre Pedron <jppedron@club-internet.fr>
370      Pascal Bleser <pascal.bleser@atosorigin.com>
371      Nicolas Boos <nicolas.boos@wanadoo.fr>
372      Nicolas Bonifas <nicolas_bonifas@users.sf.net>
373          for French translation
374
375      Fâtih Demir <kabalak@gmx.net>
376          for Turkish translation
377
378      Kam Tik <kamtik@hongkong.com>
379      Abel Cheung <deaddog@deaddog.ws>
380      S.J. Luo <crystal@mickey.ee.nctu.edu.tw>
381          for Traditional Chinese (Big5) translation
382
383      Junichi Uekawa <dancer@debian.org>
384      Oleg Andrjushenko <oandr@itec.cn.ua>
385      Michael Bravo <mbravo@tag-ltd.spb.ru>
386      Sergey Pinaev <dfo@antex.ru>
387          for Russian translation
388
389      Guilherme M. Schroeder <slump@ieg.com.br>
390      Vitor Fernandes <vitor_fernandes@SoftHome.net>
391      Herval Ribeiro de Azevêdo <heraze@gmail.com>
392          for Brazilian Portuguese translation
393
394      Shingo Akagaki <akagaki@ece.numazu-ct.ac.jp>
395      Yuuki Ninomiya <gm@debian.or.jp>
396      Sato Satoru <ss@gnome.gr.jp>
397      Takeshi AIHANA <aihana@gnome.gr.jp>
398          for Japanese translation
399
400      Matthias Warkus <mawarkus@t-online.de>
401      Thomas Klausner <wiz@danbala.ifoer.tuwien.ac.at>
402      Danny Milosavljevic <danny_milo@yahoo.com>
403      Ronny Steiner <Post@SIRSteiner.de>
404      Klaus Ethgen <Klaus@Ethgen.de>
405          for German translation
406
407      Matej Erman <matej.erman@guest.arnes.si>
408          for Slovene translation
409
410      MÃtyÃs Tibor <templar@tempi.scene.hu>
411      Koblinger Egmont <egmont@uhulinux.hu>
412      Sári Gábor <saga@externet.hu>
413          for Hungarian translation
414
415      Wu Yulun <migr@operamail.com>
416      Charles Wang <charlesw1234cn@yahoo.com.cn>
417          for simplified Chinese translation
418
419      H.J.Visser <H.J.Visser@harrie.mine.nu>
420      Tino Meinen <a.t.meinen@chello.nl>
421          for Dutch translation
422
423      Lauri Nurmi <lanurmi@iki.fi>
424          for Finnish translation
425
426      Ilmar Kerm <ikerm@hot.ee>
427          for Estonian translation
428
429      Volodymyr M. Lisivka <lvm@mystery.lviv.net>
430          for Ukrainian translation
431
432      Birger Langkjer <birger.langkjer@image.dk>
433          for Danish translation
434
435      Torgeir Ness Sundli <torgeir@mp3bil.no>
436          for Norwegian translation
437
438      Jan Raska <jan.raska@tiscali.cz>
439      Michal Bukovjan <bukm@centrum.cz>
440          for Czech translation
441
442      Phanumas Thanyaboon <maskung@hotmail.com>
443          for Thai translation
444
445      Harald Ersch <hersch@romatsa.ro>
446          for Romanian translation
447
448      pclouds <pclouds@vnlinux.org>
449          for Vietnamese translation
450
451      Tedi Heriyanto <tedi_h@gmx.net>
452          for Indonesian translation
453
454      Vladimir Petrov <vladux@mail.bg>
455          for Bulgarian translation
456
457      Hans Öfverbeck <hans.ofverbeck@home.se>
458          for Swedish translation
459
460      Youssef Assad <youssef@devcabal.org>
461          for Arabic translation
462
463      catux.org <mecatxis@ya.com>
464          for Catalan translation
465
466      Hyun-Jin Moon <moonhyunjin@gmail.com
467          for Korean translation
468
469      Pavel Piatruk <berserker@neolocation.com>
470          for Belarusian translation
471
472      Piarres Beobide <pi@beobide.net>
473          for Basque translation
474
475      Antonio C. Codazzi <f_sophia@libero.it>
476          for Esperanto translation
477
478  Fixes, additions, and patches:
479
480      Eric Swalens
481      Quy Tonthat
482          for initial Exif support.
483
484      Daniel M. German <dmgerman at uvic.ca>
485          for Canon raw image support.
486
487      Lars Ellenberg
488          for Fujifilm raw image support.
489
490      Diederen Damien <D.Diederen@student.ulg.ac.be>
491          for .xvpics thumbnail reading support.
492
493      Nick Rusnov <nick@grawk.net>
494      Ryan Murray <rmurray@debian.org>
495          for man page.
496
497      Martin Pool <mbp@samba.org>
498          for sort by number, misc. improvements.
499
500      Jörg Mensmann <joerg.mensmann@gmx.de>
501          for Xinerama support patch.
502
503      Vadim Shliakhov
504          for miscellaneous fixes.
505
506      Uwe Ohse
507          for Exif enhancements, histogram and other patches
508
509      Timo Horstschäfer
510          for customizable fullscreen overlay
511
512      Michael Mokeev
513          for print related enhancements
514
515      Carles Pina i Estany
516          for copy path to clipboard patch
517
518      Kjell Morgenstern
519          for random slide show speedup patch
520
521      Klaus Ethgen <Klaus@Ethgen.de>
522          for GPS integration, Search enhancement and other patches
523
524      And...
525          Thanks to the users for finding Geeqie useful.
526
527