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