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