Update to contributors list.
[geeqie.git] / README
1
2 This is Geeqie, a successor of GQview.
3
4 Geeqie has been forked from GQview project, because it was not 
5 possible to contact gqview author and the only maintainer. 
6 Geeqie projects goal is to move the development forward and 
7 also integrate the existing patches.
8
9 Geeqie is currently in alpha state. Everybody is encouraged 
10 to try the new features, however for stable software look at 
11 the original project.
12
13 For more info see:
14 http://geeqie.sourceforge.net
15
16 Vladimir Nadvornik
17 Petr Ostadal
18
19 Please send any question or suggestions to
20 geeqie-devel@lists.sourceforge.net
21
22
23 Below is the original README:
24
25
26 ###################################################################
27 ##                          GQview 2.1.5      (December 3, 2006) ##
28 ##                                                               ##
29 ##              Copyright (C) 1999 - 2006 John Ellis.            ##
30 ##                                                               ##
31 ##                      Use at your own risk!                    ##
32 ##                                                               ##
33 ##  This software released under the GNU General Public License. ##
34 ##       Please read the COPYING file for more information.      ##
35 ###################################################################
36
37 Author: John Ellis <johne@verizon.net>
38 e-mail: gqview@users.sourceforge.net
39 homepage: http://gqview.sourceforge.net
40
41
42  BETA! BETA! BETA! BETA! BETA! BETA! BETA! BETA! BETA! BETA! BETA!
43
44  The 2.1.x series are all development releases, and as such may
45  contain incredible bugs. Only use if interested in the new features.
46
47  The stable release as of this writing is 2.0.0.
48
49  BETA! BETA! BETA! BETA! BETA! BETA! BETA! BETA! BETA! BETA! BETA!
50
51
52 ======== README contents:
53
54     * Requirements
55     * Notes and changes for this release
56     * Installation
57     * Description / Features
58     * Documentation (keyboard shortcuts)
59     * Editor command macros
60     * Additional comments
61     * Translation status
62     * Credits
63
64 ======== Requirements
65
66   Required libraries:
67     GTK+ 2.4.x: ftp://ftp.gtk.org/pub/gtk
68
69   Optional libraries:
70     lcms, for color management support: http://www.littlecms.com
71         (disable with configure option: '--without-lcms')
72
73 ======== Notes and changes for this release            [section:release_notes]
74
75   Changes:
76
77     + Add support for color profiles (requires lcms, see Notes).
78     + Add ability to delete a folder and it's contents (with restrictions).
79     - Add support for jpegs embedded in pentax and olympus raw files.
80     - Add icons for image state, enabled with I keyboard shortcut.
81     - For pan view calendar only show months that contain an image.
82     - Make scrolling with overlays (full screen info display) a bit smoother.
83     - Make sort menus display choices as radio group instead of checkbox.
84     - Use white background for transparent images when printing.
85     * Escape filename characters "`$\ before passing them to the system shell
86       when running an editor command.
87     * Fix occasional crash in icon view when removing files.
88     * Always use aligned memory access in EXIF parser, fixes crash
89       with BUS error on sparc.
90     * Fix progress bar warning when removing files while loading thumbnails.
91     * Fix image count in full screen information overlay when in slideshow.
92     * Fix memory leak when unable to start a slideshow.
93
94   Notes:
95
96     For translation status list, see further below.
97
98     Version in perenthesis indicates first appearance of feature or change.
99
100     (2.1.5) Add support for color profiles when lcms is installed. To
101     disable color profiles and use of lcms, run configure
102     with '--without-lcms'.
103
104     (2.1.1) Add support for viewing jpeg images and EXIF embedded within
105     raw files for Canon (.crw, .cr2) Fujifilm (.raf), and Nikon (.nef).
106     Note that not all cameras that support a raw format will necessarily
107     save a usable jpeg in the raw file (for example some Nikon cameras only
108     store a tiny thumbnail within the raw .nef file).
109
110     (1.5.6) The "shared thumbnail cache" is a proposal to unify the method
111     of storing thumbnails, so that they are compatible between different
112     applications. Using this option will allow GQview to share it's
113     thumbnails with, and use thumbnails from, other applications. Current
114     releases of GNOME (through nautilus and gthumb) and the gimp use this
115     new thumbnailing system. The latest draft of the thumbnail standard
116     is located on freedesktop.org in the standards section, and links to:
117
118       http://triq.net/~jens/thumbnail-spec/index.html
119
120     The shared thumbnail standard and GQview's classic mechanism can
121     not be used at the same time, enabling the "use shared thumbnail cache"
122     option will disable the use of classic thumbnails and use the new
123     shared thumbnails.
124
125     (1.5.6) Collections contained in $HOME/.gqview/collections are now
126     updated when moving or renaming files, even if the collection is not
127     open at the time.
128
129     (1.5.6) The new option to the keep the full screen window above other
130     windows is only available when using at least GTK+ 2.4.0
131
132     (1.5.5) Dialog buttons are now ordered as recommended by the GNOME HIG.
133     The GNOME Human Interface Guidelines live at:
134        http://developer.gnome.org/projects/gup/hig/
135     To restore the old button order you must be using GTK 2.6 and set
136     the "gtk-alternative-button-order" key to TRUE in the gtkrc file:
137        $HOME/.gtkrc-2.0
138     by changing or adding this line:
139        gtk-alternative-button-order = 1
140
141     (1.5.5) The dithering option is now a hidden option, to change it
142     please refer to section 10.7 of the manual (help -> contents).
143
144     (1.5.0) Keywords and comments can now be entered for a file. Two places
145     allow keyword and comment entry. The first is via the new image details
146     sidebar accessed with (Ctrl-K), and the second is a details tab in the
147     properties dialog. If multiple files are selected, two buttons are
148     available: One allows adding the keywords to the selected files, the
149     other replaces existing keywords with the new keywords.
150
151     Keyword and comment metadata is stored in $(HOME)/.gqview/metadata, and
152     mirrors the existing filesystem tree. Metadata filenames have a suffix
153     of .meta appended. If 'cache into .thumbnails' is enabled, metadata is
154     stored locally to the original file in a hidden subfolder ".metadata".
155     If write permissions do not allow local saving of metadata, GQview falls
156     back to the default $(HOME)/.gqview/metadata location.
157
158     (1.5.0) Search dialog (F3 key) types:
159        Path       searches files in the entered folder.
160        Comments   searches all file metadata stored in ~/.gqview/metadata.
161        Results    searches the current list of results, allowing refinement.
162
163     (1.3.6) Drag and drop has been significantly improved, with a few
164     changes. Button 1 will now initiate a drag, button 2 will still work
165     for this, the difference is button 2 will not change the selection.
166
167     (1.3.6) A middle button click will now toggle selection of clicked item.
168
169     (1.3.5) UTF-8 and filenames: GQview works fine if your filenames
170     correctly match the prefered locale encoding (LANG environment
171     variable), and prints errors on the console when they do not.
172
173     (1.3.3) Safe delete does not include undo, you will need to go to the
174     trash folder and retrieve the file(s) manually. The files can be viewed
175     by clicking the view button near the safe delete option in the preferences
176     window. Files moved to the trash folder are prefixed with a 6 digit
177     number. Lower numbers are older, and deleted (permanently) first when the
178     trash size limit is reached.
179
180     (1.3.2) New in 1.3.2 are sidebars for exif data display and a sort
181     manager. Exif (ctrl + E) should be self explanatory. The Sort manager is a
182     directory list that allows copying or moving the displayed image to that
183     destination with one click of the button - very helpful when visually
184     sorting many images into subdirectories. To edit, reorder, or remove items
185     in the sort list, use the right click menu. The keyboard can also be used
186     by moving the focus to the desired button, then pressing menu/ctrl+f10 key
187     to display the popup menu, or shift+up/shift+down keys to change the
188     button location in the list. Items can also be added to the list by
189     dragging a directory onto the list.
190
191   Code hackers:
192
193     If you plan on making any major changes to the code that will be offered
194     for inclusion to the main source, please contact me first - so that we
195     can avoid duplication of effort. A good example is porting any part of
196     GQview that uses deprecated widgets to GTK2 widgets, there are already
197     several such patches floating around. This is especially true if the
198     change is listed in the TODO!
199                                              -John ( johne@verizon.net )
200
201   Known bugs:
202
203     see the TODO file.
204
205 ======== Installation
206
207   Compilation: ./configure ; make
208   General install: make install
209   Removal: make uninstall
210
211     - To build an RPM binary:
212
213          on RedHat 6.x, 7.x use 'rpm -tb gqview-x.x.x.tar.gz'.
214          on RedHat 8 and 9 use 'rpmbuild -tb gqview-x.x.x.tar.gz'.
215          on other rpm distros, it depends on which version of rpm is used, if
216          the option fails with the rpm command, try rpmbuild.
217
218       Where the resulting package is placed is distribution specific, for
219       example in RedHat it is placed in /usr/src/redhat/RPMS/{architecture}/
220
221 ======== Description / Features
222
223   GQview is a graphics file viewer. Basic features:
224
225     - Single click image viewing / navigation.
226     - Zoom functions.
227     - Thumbnails, with optional caching and .xvpics support.
228     - Multiple file selection for move, copy, delete, rename, drag and drop.
229     - Drag and drop.
230     - Slideshow.
231     - Full screen.
232     - Ability to open images in external editors (configurable).
233     - Collections.
234     - Comparison of images to find duplicates by name, size, date,
235       dimensions, or image content similarity.
236     - EXIF support.
237
238 ======== Documentation (brief)                         [section:documentation]
239
240   Keyboard commands:
241     [PageDown], [Keypad PageDown]      next image
242     [PageUp], [Keypad PageUp]          previous image
243     [Home], [Keypad Home]              first image in list
244     [End], [Keypad End]                last image in list
245     [Tab]                              tab completion in path entry window
246     [Escape]                           cancel completion in path entry window
247
248   Keyboard commands valid when image has focus (image has black rectangle)
249     arrow keys, [Keypad arrows]        pan image
250     [Shift] - arrow keys               pan image faster
251     [Space]                            next image
252     [Backspace] , B                    previous image
253
254   File menu related:
255     [Ctrl] - N                         new window
256     C                                  new empty collection
257     O                                  open collection
258     D                                  open a Find Duplicates window
259     [Shift]- P                         open Print dialog
260     [Ctrl] - F                         new folder
261     [Ctrl] - C                         copy file
262     [Ctrl] - M                         move file
263     [Ctrl] - R                         rename file
264     [Ctrl] - D, [Delete]               delete file
265     [Ctrl] - W                         close window
266     [Ctrl] - Q                         exit GQview
267
268   Edit menu related:
269     [Ctrl] - 1 .. 0                    run external editor
270     [Ctrl] - A                         select all files
271     [Ctrl] - [Shift] - A               unselect all files
272     [Ctrl] - P                         display image properties window
273     [Ctrl] - O                         configure Options
274     ]                                  rotate image clockwise
275     [                                  rotate image counterclockwise
276     [Shift] - R                        rotate image 180 degrees
277     [Shift] - M                        mirror image (horizontal)
278     [Shift] - F                        flip image (verticle)
279     [Shift] - G                        grayscale image
280
281   View menu related:
282     +, =, [Keypad +]                   zoom in
283     -, [Keypad -]                      zoom out
284     Z, [Keypad /]                      zoom to original size
285     X, [Keypad *]                      zoom to fit within window
286     W                                  zoom to fit width of window
287     H                                  zoom to fit height of window
288     1, 2, 3, 4                         zoom to Nx (3 = 3x)
289     9, 8, 7                            zoom to -2, -3, -4, respectively
290     T                                  toggle thumbnails in list view
291     [Ctrl] - L                         display files as list view
292     [Ctrl] - I                         display files as icon view
293     [Ctrl] - T                         toggle tree view of directories
294     R                                  refresh list
295     L                                  (Un)float file selection area
296     [ctrl] - H                         (Un)hide file selection area
297     [Ctrl] - K                         toggle Keywords sidebar
298     [Ctrl] - E                         toggle EXIF sidebar
299     [Ctrl] - S                         toggle sort manager sidebar
300     F, V                               toggle full screen
301     S                                  toggle slide show
302     P                                  (Un)pause slideshow
303     [Ctrl] - V                         display current image in new window
304
305   Collection windows:
306
307     arrows, [Keypad arrows]            move selection
308     [Shift] + arrows                   select multiple images
309     [Ctrl] + arrows                    move without changing selection
310     [Space]                            select only image with focus
311     [Ctrl] + [Space]                   toggle selection of image with focus
312     [Home], [Keypad Home]              move focus to top of images
313     [End], [Keypad End]                move focus to end of images
314       (shift and ctrl work with Home, End, PageUp/Down as with arrows)
315     [Ctrl] - A                         select all images
316     [Ctrl] - [Shift] - A               unselect all images
317
318     [Delete], [Keypad Delete]          remove selected images from collection
319                                        (does not delete file)
320     [Ctrl] - L                         add images from main window file list
321
322     [Ctrl] - T                         toggle display of icon filename text
323
324     N                                  sort collection by name
325     D                                  sort collection by date
326     B                                  sort collection by size (bytes)
327     P                                  sort collection by location (path)
328     I (*)                              sort collection by name numerically
329                                    (file1 file10 file2 -> file1 file2 file10)
330
331     [Enter], [Keypad Enter]            view image with focus in main window
332     V                                  view image with focus in new window
333     [Ctrl] - 1 .. 0                    open selected image(s) in editor
334
335     S                                  save collection
336     [Ctrl] - S                         save collection as...
337     A                                  append to collection...
338
339     [Shift] - P                        print selected images...
340
341     [Ctrl] - C                         copy selected files...
342     [Ctrl] - M                         move selected files...
343     [Ctrl] - R                         rename selected files...
344     [Ctrl] - D                         delete selected files
345
346     [Ctrl] - P                         display image properties window
347
348     [Ctrl] - W                         close window
349
350   Find Duplicates window:
351
352     [Ctrl] - A                         select all images
353     [Ctrl] - [Shift] - A               unselect all images
354     1                                  select group 1 duplicates
355     2                                  select group 2 duplicates
356
357     [Ctrl] - L                         add images from main window file list
358     C                                  add selected images to new collection
359
360     [Delete], [Keypad Delete]          remove selected images from list
361     [Ctrl] - [Delete]                  clear window
362
363     [Enter], [Keypad Enter]            view image with focus in main window
364     V                                  view image with focus in new window
365     [Ctrl] - 1 .. 0                    open selected image(s) in editor
366
367     [Ctrl] - C                         copy selected files...
368     [Ctrl] - M                         move selected files...
369     [Ctrl] - R                         rename selected files...
370     [Ctrl] - D                         delete selected files
371
372     [Ctrl] - P                         display image properties window
373
374     [Ctrl] - W                         close window
375
376   Pan View:
377
378     [Ctrl] - F, /                      show search bar
379     [Ctrl] - G                         repeat previous search
380
381   (*) This is a compile time option enabled when strverscmp is found.
382
383   Mouse image control:
384
385     Button 1                           view next image
386     Button 2                           view previous image
387     Button 3                           context menu
388
389     Button 1 drag                      scroll/pan image
390     Button 2 drag                      initiate drag and drop
391
392     Wheel up/down                      change to previous/next image
393     Wheel up/down + [Shift]            scroll image up/down
394     Wheel up/down + [Control]          zoom image in/out
395
396 ======== Editor command macros                               [section:editors]
397
398  Any one of the following filename markers may be used:
399
400     %f  Replaced with list of selected files, may occur once.
401     %p  Command is run once for each selected file, may occur multiple times.
402    none When neither %f or %p exist, list of files is appended to command.
403
404  Use of the following to display output window for the command:
405
406     %v  Display result of command in output window, must occur as first two
407         characters in the command, or immediately after the "%w" macro.
408     %V  Like v above, but when used with %p, only displays output window for
409         multiple files. The output of a single file is suppressed.
410
411  Additional macros:
412
413     %w  Prevent full screen from deactivating when command is executed,
414         must occur as the first two characters.
415
416 ======== Additional comments:
417
418   Advanced options:
419     These options are not adjustable in the preferences window, to change
420     them edit $(HOME)/.gqview/gqviewrc while GQview is not running. An option
421     becomes 'advanced' when it is removed from the user's visibility, and
422     only remains so that those few users that really want it will not complain
423     about it's removal :)
424
425   lazy_image_sync: false
426     Set true to enable the old behavior of lazy image updates when changing
427     directories. (viewed image will remain until a new file is selected)
428
429   display_dialogs_under_mouse: false
430     Set true to force dialogs to display under the current mouse position,
431     note that this goes against the preference set for the window manager.
432
433 ======== Translation status:
434
435  (as of 2.1.5)
436
437    Please send po files/patches in gzipped form to ensure data integrity.
438
439    Note: completion % in the chart below may not be quite correct when fuzzy
440          translations exist but do not appear in the source.
441          comp % = trans / (trans + fuzzy + untrans)
442
443 Language     Comp (%)  Trans   Fuzzy Untrans  Warn
444 --------------------------------------------------
445 ar                60     449     192     103
446 be                95     712      18      14
447 bg                89     667      44      33
448 ca                89     667      44      33
449 cs                89     667      44      33
450 da                18     138     324     282
451 de                89     667      44      33
452 eo                95     708      22      14
453 es                89     667      44      33
454 et                27     204     322     218
455 eu                95     712      18      14
456 fi                89     669      42      33
457 fr                94     706      21      17
458 hu                50     374     226     144
459 id                27     208     323     213
460 it                94     704      23      17
461 ja                89     667      44      33
462 ko                15     114      16     614
463 nl                89     669      42      33
464 no                22     169     335     240
465 pl                84     631      22      91
466 pt_BR             94     704      23      17
467 ro                52     388     228     128
468 ru                89     667      44      33
469 sk                92     690      24      30
470 sl                20     155     341     248
471 sv                89     665      45      34
472 th                21     161     332     251
473 tr                 9      71     323     350
474 uk                24     180     331     233
475 vi                94     705      22      17
476 zh_CN.GB2312      22     169     335     240
477 zh_TW             93     695      23      26
478 --------------------------------------------------
479
480
481 ======== Credits                                             [section:credits]
482
483
484   Translations:
485
486      Grzegorz Kowal <g_kowal@poczta.onet.pl>
487      Zbigniew Chyla <cyba@gnome.pl>
488      Emil Nowak <emil5@go2.pl>
489      Wit Wilinski <wit.wilinski@gmail.com>
490          for Polish translation
491
492      Christopher R. Gabriel <cgabriel@pluto.linux.it>
493      Di Maggio Salvatore <Salvatore.Dimaggio@bologna.marelli.it>
494      Costantino <inverness1ATvirgilio.it>
495          for Italian translation
496
497      Sandokan <cortex@nextra.sk>
498      Ivan Priesol <priesol@iris-sk.sk>
499      Mgr. Peter Tuharsky <tuharsky@misbb.sk>
500          for Slovak translation
501
502      Rodrigo Sancho Senosiain <ruy_ikari@bigfoot.com>
503      Ariel Fermani <the_end@bbs.frc.utn.edu.ar>
504          for Spanish translation
505
506      Laurent Monin <i18n@norz.org>
507      Eric Lassauge <lassauge@users.sf.net>
508      Jean-Pierre Pedron <jppedron@club-internet.fr>
509      Pascal Bleser <pascal.bleser@atosorigin.com>
510      Nicolas Boos <nicolas.boos@wanadoo.fr>
511      Nicolas Bonifas <nicolas_bonifas@users.sf.net>
512          for French translation
513
514      Fâtih Demir <kabalak@gmx.net>
515          for Turkish translation
516
517      Kam Tik <kamtik@hongkong.com>
518      Abel Cheung <deaddog@deaddog.ws>
519      S.J. Luo <crystal@mickey.ee.nctu.edu.tw>
520          for Traditional Chinese (Big5) translation
521
522      Junichi Uekawa <dancer@debian.org>
523      Oleg Andrjushenko <oandr@itec.cn.ua>
524      Michael Bravo <mbravo@tag-ltd.spb.ru>
525      Sergey Pinaev <dfo@antex.ru>
526          for Russian translation
527
528      Guilherme M. Schroeder <slump@ieg.com.br>
529      Vitor Fernandes <vitor_fernandes@SoftHome.net>
530      Herval Ribeiro de Azevêdo <heraze@gmail.com>
531          for Brazilian Portuguese translation
532
533      Shingo Akagaki <akagaki@ece.numazu-ct.ac.jp>
534      Yuuki Ninomiya <gm@debian.or.jp>
535      Sato Satoru <ss@gnome.gr.jp>
536      Takeshi AIHANA <aihana@gnome.gr.jp>
537          for Japanese translation
538
539      Matthias Warkus <mawarkus@t-online.de>
540      Thomas Klausner <wiz@danbala.ifoer.tuwien.ac.at>
541      Danny Milosavljevic <danny_milo@yahoo.com>
542      Ronny Steiner <Post@SIRSteiner.de>
543          for German translation
544
545      Matej Erman <matej.erman@guest.arnes.si>
546          for Slovene translation
547
548      MÃtyÃs Tibor <templar@tempi.scene.hu>
549      Koblinger Egmont <egmont@uhulinux.hu>
550      Sári Gábor <saga@externet.hu>
551          for Hungarian translation
552
553      Wu Yulun <migr@operamail.com>
554      Charles Wang <charlesw1234cn@yahoo.com.cn>
555          for simplified Chinese translation
556
557      H.J.Visser <H.J.Visser@harrie.mine.nu>
558      Tino Meinen <a.t.meinen@chello.nl>
559          for Dutch translation
560
561      Lauri Nurmi <lanurmi@iki.fi>
562          for Finnish translation
563
564      Ilmar Kerm <ikerm@hot.ee>
565          for Estonian translation
566
567      Volodymyr M. Lisivka <lvm@mystery.lviv.net>
568          for Ukrainian translation
569
570      Birger Langkjer <birger.langkjer@image.dk>
571          for Danish translation
572
573      Torgeir Ness Sundli <torgeir@mp3bil.no>
574          for Norwegian translation
575
576      Jan Raska <jan.raska@tiscali.cz>
577      Michal Bukovjan <bukm@centrum.cz>
578          for Czech translation
579
580      Phanumas Thanyaboon <maskung@hotmail.com>
581          for Thai translation
582
583      Harald Ersch <hersch@romatsa.ro>
584          for Romanian translation
585
586      pclouds <pclouds@vnlinux.org>
587          for Vietnamese translation
588
589      Tedi Heriyanto <tedi_h@gmx.net>
590          for Indonesian translation
591
592      Vladimir Petrov <vladux@mail.bg>
593          for Bulgarian translation
594
595      Hans Öfverbeck <hans.ofverbeck@home.se>
596          for Swedish translation
597
598      Youssef Assad <youssef@devcabal.org>
599          for Arabic translation
600
601      catux.org <mecatxis@ya.com>
602          for Catalan translation
603
604      Hyun-Jin Moon <moonhyunjin@gmail.com
605          for Korean translation
606
607      Pavel Piatruk <berserker@neolocation.com>
608          for Belarusian translation
609
610      Piarres Beobide <pi@beobide.net>
611          for Basque translation
612
613      Antonio C. Codazzi <f_sophia@libero.it>
614          for Esperanto translation
615
616  Fixes, additions, and patches:
617
618      Eric Swalens
619      Quy Tonthat
620          for initial Exif support.
621
622      Daniel M. German <dmgerman at uvic.ca>
623          for Canon raw image support.
624
625      Lars Ellenberg
626          for Fujifilm raw image support.
627
628      Diederen Damien <D.Diederen@student.ulg.ac.be>
629          for .xvpics thumbnail reading support.
630
631      Nick Rusnov <nick@grawk.net>
632      Ryan Murray <rmurray@debian.org>
633          for man page.
634
635      Martin Pool <mbp@samba.org>
636          for sort by number, misc. improvements.
637
638      Jörg Mensmann <joerg.mensmann@gmx.de>
639          for Xinerama support patch.
640
641      Vadim Shliakhov
642          for miscellaneous fixes.
643
644      Uwe Ohse
645          for Exif enhancements, histogram and other patches
646
647      Timo Horstschäfer
648          for customizable fullscreen overlay
649          
650      Michael Mokeev
651          for print related enhancements
652      
653      Carles Pina i Estany
654          for copy path to clipboard patch
655   
656      And...
657          Thanks to the users for finding Geeqie useful.
658
659
660 ========
661