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