Sync to GQview 1.5.9 release.
[geeqie.git] / README
1 ###################################################################
2 ##                          GQview 1.5.9     (February 15, 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   PREVIEW RELEASE!        PREVIEW RELEASE!        PREVIEW RELEASE!
18
19   The stable version at the time of this release is GQview 1.4.5
20
21   PREVIEW RELEASE!        PREVIEW RELEASE!        PREVIEW RELEASE!
22
23
24 ======== README contents:
25
26     * Requirements
27     * Notes and changes for this release
28     * Installation
29     * Description / Features
30     * Documentation (keyboard shortcuts)
31     * Editor command macros
32     * Additional comments
33     * Translation status
34     * Credits
35
36 ======== Requirements
37
38   GTK+ 2.4.x: ftp://ftp.gtk.org/pub/gtk
39
40 ======== Notes and changes for this release            [section:release_notes]
41
42   Changes since 1.5.8:
43
44     - Set default image for similarity in a search to the current image.
45     - Update Italian translation.
46     * Fix main window keyboard shortcuts for editor commands.
47     * Fix thumbnail memory leak in file list view.
48     * Fix searching by keywords to ignore case.
49     * Fix writing of image data to cache in search utility.
50
51   New features in 2.0 (since 1.4.5):
52
53     + Search utility.
54     + Ability to assign keywords and comments to an image.
55     + Printing, including proof sheets.
56     + Support for the Thumbnail Managing Standard, on by default.
57     + Fullscreen support for multihead configurations.
58     + Fullscreen can now delay showing next image until it is loaded.
59     + Image information now viewable in fullscreen (I key).
60     + Extensive user manual.
61     + Command line control of existing GQview process.
62     + Collections are now updated when moving or renaming a file.
63     - Shift + Click on an image will start mouse scrolling.
64     - Control + Arrows will jump to respective edges of image.
65     - Slideshow interval precision is now .1 second.
66     - Find duplicates by checksum now uses MD5 algorithm.
67     - Exif sidebar can now be customized.
68     - Sort manager now has symlink option.
69     - Sort manager can now add images to collections.
70     - Window maximization state now retained between sessions.
71     - Clean up all dialogs.
72     - Added hidden option scroll_reset_method (see docs chapter 10.7).
73     - Maintenance utility for caches and data used by GQview.
74     - Utility to create thumbnails ahead of time in one step.
75     - Now requires GTK+ >= 2.4
76
77   Notes:
78
79     For translation status list, see further below.
80
81     Version in perenthesis indicates first appearance of feature or change.
82
83     (1.5.6) The "shared thumbnail cache" is a proposal to unify the method
84     of storing thumbnails, so that they are compatible between different
85     applications. Using this option will allow GQview to share it's
86     thumbnails with, and use thumbnails from, other applications. Current
87     releases of GNOME (through nautilus and gthumb) and the gimp use this
88     new thumbnailing system. The latest draft of the thumbnail standard
89     is located on freedesktop.org in the standards section, and links to:
90
91       http://triq.net/~jens/thumbnail-spec/index.html
92
93     The shared thumbnail standard and GQview's classic mechanism can
94     not be used at the same time, enabling the "use shared thumbnail cache"
95     option will disable the use of classic thumbnails and use the new
96     shared thumbnails.
97
98     (1.5.6) Collections contained in $HOME/.gqview/collections are now
99     updated when moving or renaming files, even if the collection is not
100     open at the time.
101
102     (1.5.6) The new option to the keep the full screen window above other
103     windows is only available when using at least GTK+ 2.4.0
104
105     (1.5.5) Dialog buttons are now ordered as recommended by the GNOME HIG.
106     The GNOME Human Interface Guidelines live at:
107        http://developer.gnome.org/projects/gup/hig/
108     To restore the old button order you must be using GTK 2.6 and set
109     the "gtk-alternative-button-order" key to TRUE in the gtkrc file:
110        $HOME/.gtkrc-2.0
111     by changing or adding this line:
112        gtk-alternative-button-order = 1
113
114     (1.5.5) The dithering option is now a hidden option, to change it
115     please refer to section 10.7 of the manual (help -> contents).
116
117     (1.5.0) Keywords and comments can now be entered for a file. Two places
118     allow keyword and comment entry. The first is via the new image details
119     sidebar accessed with (Ctrl-K), and the second is a details tab in the
120     properties dialog. If multiple files are selected, two buttons are
121     available: One allows adding the keywords to the selected files, the
122     other replaces existing keywords with the new keywords.
123
124     Keyword and comment metadata is stored in $(HOME)/.gqview/metadata, and
125     mirrors the existing filesystem tree. Metadata filenames have a suffix
126     of .meta appended. If 'cache into .thumbnails' is enabled, metadata is
127     stored locally to the original file in a hidden subfolder ".metadata".
128     If write permissions do not allow local saving of metadata, GQview falls
129     back to the default $(HOME)/.gqview/metadata location.
130
131     (1.5.0) Search dialog (F3 key) types:
132        Path       searches files in the entered folder.
133        Comments   searches all file metadata stored in ~/.gqview/metadata.
134        Results    searches the current list of results, allowing refinement.
135
136     (1.3.6) Drag and drop has been significantly improved, with a few
137     changes. Button 1 will now initiate a drag, button 2 will still work
138     for this, the difference is button 2 will not change the selection.
139
140     (1.3.6) A middle button click will now toggle selection of clicked item.
141
142     (1.3.5) UTF-8 and filenames: GQview works fine if your filenames
143     correctly match the prefered locale encoding (LANG environment
144     variable), and prints errors on the console when they do not.
145
146     (1.3.3) Safe delete does not include undo, you will need to go to the
147     trash folder and retrieve the file(s) manually. The files can be viewed
148     by clicking the view button near the safe delete option in the preferences
149     window. Files moved to the trash folder are prefixed with a 6 digit
150     number. Lower numbers are older, and deleted (permanently) first when the
151     trash size limit is reached.
152
153     (1.3.2) New in 1.3.2 are sidebars for exif data display and a sort
154     manager. Exif (ctrl + E) should be self explanatory. The Sort manager is a
155     directory list that allows copying or moving the displayed image to that
156     destination with one click of the button - very helpful when visually
157     sorting many images into subdirectories. To edit, reorder, or remove items
158     in the sort list, use the right click menu. The keyboard can also be used
159     by moving the focus to the desired button, then pressing menu/ctrl+f10 key
160     to display the popup menu, or shift+up/shift+down keys to change the
161     button location in the list. Items can also be added to the list by
162     dragging a directory onto the list.
163
164   Code hackers:
165
166     If you plan on making any major changes to the code that will be offered
167     for inclusion to the main source, please contact me first - so that we
168     can avoid duplication of effort. A good example is porting any part of
169     GQview that uses deprecated widgets to GTK2 widgets, there are already
170     several such patches floating around. This is especially true if the
171     change is listed in the TODO!
172                                              -John ( johne@verizon.net )
173
174   Known bugs:
175
176     see the TODO file.
177
178 ======== Installation
179
180   Compilation: ./configure ; make
181   General install: make install
182   Removal: make uninstall
183
184     - To build an RPM binary:
185
186          on RedHat 6.x, 7.x use 'rpm -tb gqview-x.x.x.tar.gz'.
187          on RedHat 8 and 9 use 'rpmbuild -tb gqview-x.x.x.tar.gz'.
188          on other rpm distros, it depends on which version of rpm is used, if
189          the option fails with the rpm command, try rpmbuild.
190
191       Where the resulting package is placed is distribution specific, for
192       example in RedHat it is placed in /usr/src/redhat/RPMS/{architecture}/
193
194 ======== Description / Features
195
196   GQview is a graphics file viewer. Basic features:
197
198     - Single click image viewing / navigation.
199     - Zoom functions.
200     - Thumbnails, with optional caching and .xvpics support.
201     - Multiple file selection for move, copy, delete, rename, drag and drop.
202     - Drag and drop.
203     - Slideshow.
204     - Full screen.
205     - Ability to open images in external editors (configurable).
206     - Collections.
207     - Comparison of images to find duplicates by name, size, date,
208       dimensions, or image content similarity.
209     - EXIF support.
210
211 ======== Documentation (brief)                         [section:documentation]
212
213   Keyboard commands:
214     [PageDown], [Keypad PageDown]      next image
215     [PageUp], [Keypad PageUp]          previous image
216     [Home], [Keypad Home]              first image in list
217     [End], [Keypad End]                last image in list
218     [Tab]                              tab completion in path entry window
219     [Escape]                           cancel completion in path entry window
220
221   Keyboard commands valid when image has focus (image has black rectangle)
222     arrow keys, [Keypad arrows]        pan image
223     [Shift] - arrow keys               pan image faster
224     [Space]                            next image
225     [Backspace] , B                    previous image
226
227   File menu related:
228     [Ctrl] - N                         new window
229     C                                  new empty collection
230     O                                  open collection
231     D                                  open a Find Duplicates window
232     [Shift]- P                         open Print dialog
233     [Ctrl] - F                         new folder
234     [Ctrl] - C                         copy file
235     [Ctrl] - M                         move file
236     [Ctrl] - R                         rename file
237     [Ctrl] - D, [Delete]               delete file
238     [Ctrl] - W                         close window
239     [Ctrl] - Q                         exit GQview
240
241   Edit menu related:
242     [Ctrl] - 1 .. 0                    run external editor
243     [Ctrl] - A                         select all files
244     [Ctrl] - [Shift] - A               unselect all files
245     [Ctrl] - P                         display image properties window
246     [Ctrl] - O                         configure Options
247     ]                                  rotate image clockwise
248     [                                  rotate image counterclockwise
249     [Shift] - R                        rotate image 180 degrees
250     [Shift] - M                        mirror image (horizontal)
251     [Shift] - F                        flip image (verticle)
252
253   View menu related:
254     +, =, [Keypad +]                   zoom in
255     -, [Keypad -]                      zoom out
256     Z, [Keypad /]                      zoom to original size
257     X, [Keypad *]                      zoom to fit within window
258     W                                  zoom to fit width of window
259     H                                  zoom to fit height of window
260     1, 2, 3, 4                         zoom to Nx (3 = 3x)
261     9, 8, 7                            zoom to -2, -3, -4, respectively
262     T                                  toggle thumbnails in list view
263     [Ctrl] - L                         display files as list view
264     [Ctrl] - I                         display files as icon view
265     [Ctrl] - T                         toggle tree view of directories
266     R                                  refresh list
267     L                                  (Un)float file selection area
268     [ctrl] - H                         (Un)hide file selection area
269     [Ctrl] - K                         toggle Keywords sidebar
270     [Ctrl] - E                         toggle EXIF sidebar
271     [Ctrl] - S                         toggle sort manager sidebar
272     F, V                               toggle full screen
273     S                                  toggle slide show
274     P                                  (Un)pause slideshow
275
276   Collection windows:
277
278     arrows, [Keypad arrows]            move selection
279     [Shift] + arrows                   select multiple images
280     [Ctrl] + arrows                    move without changing selection
281     [Space]                            select only image with focus
282     [Ctrl] + [Space]                   toggle selection of image with focus
283     [Home], [Keypad Home]              move focus to top of images
284     [End], [Keypad End]                move focus to end of images
285       (shift and ctrl work with Home, End, PageUp/Down as with arrows)
286     [Ctrl] - A                         select all images
287     [Ctrl] - [Shift] - A               unselect all images
288
289     [Delete], [Keypad Delete]          remove selected images from collection
290                                        (does not delete file)
291     [Ctrl] - L                         add images from main window file list
292
293     [Ctrl] - T                         toggle display of icon filename text
294
295     N                                  sort collection by name
296     D                                  sort collection by date
297     B                                  sort collection by size (bytes)
298     P                                  sort collection by location (path)
299     I (*)                              sort collection by name numerically
300                                    (file1 file10 file2 -> file1 file2 file10)
301
302     [Enter], [Keypad Enter]            view image with focus in main window
303     V                                  view image with focus in new window
304     [Ctrl] - 1 .. 0                    open selected image(s) in editor
305
306     S                                  save collection
307     [Ctrl] - S                         save collection as...
308     A                                  append to collection...
309
310     [Ctrl] - C                         copy selected files...
311     [Ctrl] - M                         move selected files...
312     [Ctrl] - R                         rename selected files...
313     [Ctrl] - D                         delete selected files
314
315     [Ctrl] - P                         display image properties window
316
317     [Ctrl] - W                         close window
318
319   Find Duplicates window:
320
321     [Ctrl] - A                         select all images
322     [Ctrl] - [Shift] - A               unselect all images
323     1                                  select group 1 duplicates
324     2                                  select group 2 duplicates
325
326     [Ctrl] - L                         add images from main window file list
327     C                                  add selected images to new collection
328
329     [Delete], [Keypad Delete]          remove selected images from list
330     [Ctrl] - [Delete]                  clear window
331
332     [Enter], [Keypad Enter]            view image with focus in main window
333     V                                  view image with focus in new window
334     [Ctrl] - 1 .. 0                    open selected image(s) in editor
335
336     [Ctrl] - C                         copy selected files...
337     [Ctrl] - M                         move selected files...
338     [Ctrl] - R                         rename selected files...
339     [Ctrl] - D                         delete selected files
340
341     [Ctrl] - P                         display image properties window
342
343     [Ctrl] - W                         close window
344
345   (*) This is a compile time option enabled when strverscmp is found.
346
347   Mouse image control:
348
349     Button 1                           view next image
350     Button 2                           view previous image
351     Button 3                           context menu
352
353     Button 1 drag                      scroll/pan image
354     Button 2 drag                      initiate drag and drop
355
356     Wheel up/down                      change to previous/next image
357     Wheel up/down + [Shift]            scroll image up/down
358     Wheel up/down + [Control]          zoom image in/out
359
360 ======== Editor command macros                               [section:editors]
361
362  Any one of the following filename markers may be used:
363
364     %f  Replaced with list of selected files, may occur once.
365     %p  Command is run once for each selected file, may occur multiple times.
366    none When neither %f or %p exist, list of files is appended to command.
367
368  Use of the following to display output window for the command:
369
370     %v  Display result of command in output window, must occur as first two
371         characters in the command.
372     %V  Like v above, but when used with %p, only displays output window for
373         multiple files. The output of a single file is suppressed.
374
375 ======== Additional comments:
376
377   Advanced options:
378     These options are not adjustable in the preferences window, to change
379     them edit $(HOME)/.gqview/gqviewrc while GQview is not running. An option
380     becomes 'advanced' when it is removed from the user's visibility, and
381     only remains so that those few users that really want it will not complain
382     about it's removal :)
383
384   lazy_image_sync: false
385     Set true to enable the old behavior of lazy image updates when changing
386     directories. (viewed image will remain until a new file is selected)
387
388   display_dialogs_under_mouse: false
389     Set true to force dialogs to display under the current mouse position,
390     note that this goes against the preference set for the window manager.
391
392 ======== Translation status:
393
394  (as of 1.5.8)
395
396    Please send po files/patches in gzipped form to ensure data integrity.
397
398 Language     Comp (%)  Trans   Fuzzy Untrans  Warn
399 --------------------------------------------------
400 ar                67     448     149      70
401 bg                64     427     166      74
402 cs                58     387     186      94
403 da                20     137     286     244
404 de                56     375     185     107
405 es                91     609      50       8
406 et                30     203     283     181
407 fi                58     387     189      91
408 fr                91     609      50       8
409 hu                55     373     186     108
410 id                31     207     284     176
411 it                99     664       2       1
412 ja                78     523     117      27
413 nl                58     387     186      94
414 no                25     168     296     203
415 pl                55     369     188     110
416 pt_BR             25     168     296     203
417 ro                58     387     188      92
418 ru                99     664       2       1
419 sk                58     387     189      91
420 sl                23     154     302     211
421 sv                99     664       2       1
422 th                24     161     295     211
423 tr                10      70     286     311
424 uk                26     179     292     196
425 vi                56     380     189      98
426 zh_CN.GB2312      25     168     296     203
427 zh_TW             55     368     186     113
428 --------------------------------------------------
429
430
431 ======== Credits                                             [section:credits]
432
433
434   Translations:
435
436      Grzegorz Kowal <g_kowal@poczta.onet.pl>
437      Zbigniew Chyla <cyba@gnome.pl>
438      Emil Nowak <emil5@go2.pl>
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@hotmail.com>
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 Exif support.
551
552      Diederen Damien <D.Diederen@student.ulg.ac.be>
553          for .xvpics thumbnail reading support.
554
555      Nick Rusnov <nick@grawk.net>
556      Ryan Murray <rmurray@debian.org>
557          for man page.
558
559      Martin Pool <mbp@samba.org>
560          for sort by number, misc. improvements.
561
562      Jörg Mensmann <joerg.mensmann@gmx.de>
563          for Xinerama support patch.
564
565      Vadim Shliakhov
566          for miscellaneous fixes.
567
568
569      And...
570          Thanks to the users for finding GQview useful.
571
572
573 ========
574