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