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